Skip to main content

Enterprise Installation

OSO Kafka Backup Enterprise is distributed as a separate binary that is a drop-in replacement for the open-source version. It contains all OSS functionality plus enterprise features gated by a license file. Without a license, it operates identically to the OSS version.

14-day free trial

The enterprise binary includes a 14-day free trial of all enterprise features on first run — no signup required. After the trial, purchase a license to continue using enterprise features, or keep using it as your OSS binary.

Choose Your Edition

Open SourceEnterprise
Homebrewbrew install osodevops/tap/kafka-backupbrew install osodevops/tap/kafka-backup-enterprise
Dockerghcr.io/osodevops/kafka-backuposodevops/kafka-backup-enterprise
Binary namekafka-backupkafka-backup
License requiredNoYes (trial included)
SourceGitHub (public)GitHub (private)

Both editions produce the same kafka-backup binary. You only need one installed at a time.


Homebrew (macOS / Linux)

The enterprise formula is published to the same Homebrew tap as the OSS version:

# Install enterprise edition
brew install osodevops/tap/kafka-backup-enterprise

# Verify
kafka-backup --version
kafka-backup license info
Switching from OSS

If you already have the OSS version installed via Homebrew, uninstall it first to avoid conflicts:

brew uninstall kafka-backup
brew install osodevops/tap/kafka-backup-enterprise

Both formulas install a binary named kafka-backup, so only one can be active at a time.

Docker

The enterprise Docker image is published to Docker Hub:

# Pull the latest enterprise image
docker pull osodevops/kafka-backup-enterprise:latest

# Verify
docker run --rm osodevops/kafka-backup-enterprise:latest --version
docker run --rm osodevops/kafka-backup-enterprise:latest license info

Available Tags

TagDescription
latestMost recent stable release
v0.2.1Specific version (semver)
v0.2Latest patch within a minor version

With a License File

Mount your license file into the container:

docker run --rm \
-v /path/to/license.key:/etc/kafka-backup/license.key:ro \
-v $(pwd)/backup.yaml:/config/backup.yaml:ro \
osodevops/kafka-backup-enterprise:latest \
backup --config /config/backup.yaml

Or pass the license as an environment variable:

docker run --rm \
-e ENTERPRISE_LICENSE_KEY=$(base64 < license.key) \
-v $(pwd)/backup.yaml:/config/backup.yaml:ro \
osodevops/kafka-backup-enterprise:latest \
backup --config /config/backup.yaml

Docker Compose

docker-compose.yml
services:
kafka-backup:
image: osodevops/kafka-backup-enterprise:latest
volumes:
- ./config:/config:ro
- ./backups:/data/backups
- ./license.key:/etc/kafka-backup/license.key:ro
command: ["backup", "--config", "/config/backup.yaml"]

Binary Download

Download pre-built binaries from GitHub Releases.

Linux (x86_64)

# Download latest release
curl -L -o kafka-backup.tar.gz \
https://github.com/osodevops/kafka-backup-enterprise/releases/latest/download/kafka-backup-x86_64-linux.tar.gz

# Verify checksum
curl -L -o kafka-backup.tar.gz.sha256 \
https://github.com/osodevops/kafka-backup-enterprise/releases/latest/download/kafka-backup-x86_64-linux.tar.gz.sha256
sha256sum -c kafka-backup.tar.gz.sha256

# Extract and install
tar xzf kafka-backup.tar.gz
sudo mv kafka-backup /usr/local/bin/

# Verify
kafka-backup --version
kafka-backup license info

Linux (ARM64)

curl -L -o kafka-backup.tar.gz \
https://github.com/osodevops/kafka-backup-enterprise/releases/latest/download/kafka-backup-aarch64-linux.tar.gz

tar xzf kafka-backup.tar.gz
sudo mv kafka-backup /usr/local/bin/

macOS (Intel)

curl -L -o kafka-backup.tar.gz \
https://github.com/osodevops/kafka-backup-enterprise/releases/latest/download/kafka-backup-x86_64-macos.tar.gz

tar xzf kafka-backup.tar.gz
sudo mv kafka-backup /usr/local/bin/

macOS (Apple Silicon)

curl -L -o kafka-backup.tar.gz \
https://github.com/osodevops/kafka-backup-enterprise/releases/latest/download/kafka-backup-aarch64-macos.tar.gz

tar xzf kafka-backup.tar.gz
sudo mv kafka-backup /usr/local/bin/

Windows (x86_64)

Download kafka-backup-x86_64-windows.zip from the releases page and extract kafka-backup.exe to a directory in your PATH.

Kubernetes (Helm Chart)

The recommended way to deploy on Kubernetes is the official Helm chart, which creates a CronJob for scheduled backups with built-in license injection, credential management, and Prometheus metrics.

helm install kafka-backup \
oci://ghcr.io/osodevops/charts/kafka-backup-enterprise \
--namespace kafka-backup \
--values values.yaml

See the Helm Chart guide for complete installation instructions, configuration examples, cloud IAM setup, and troubleshooting.

Manual Kubernetes (without Helm)

If you prefer raw manifests, swap the image reference and mount the license as a Secret:

license-secret.yaml
apiVersion: v1
kind: Secret
metadata:
name: kafka-backup-license
namespace: kafka-backup
type: Opaque
stringData:
license.key: |
-----BEGIN KAFKA-BACKUP LICENSE-----
eyJsaWNlbnNlX2lkIjoiYWJjZGVm...
-----END KAFKA-BACKUP LICENSE-----
spec:
containers:
- name: kafka-backup
image: osodevops/kafka-backup-enterprise:latest
volumeMounts:
- name: license
mountPath: /etc/kafka-backup
readOnly: true
volumes:
- name: license
secret:
secretName: kafka-backup-license

For full Kubernetes deployment examples, see the Kubernetes Deployment guide.

Verifying Your Installation

After installing the enterprise binary, verify it is working:

# Check version
kafka-backup --version

# Check license status
kafka-backup license info

On first run without a license, the output will show the auto-trial:

  License:  14-day trial (auto-activated)
Expires: 2026-04-24 (14 days remaining)
Features: schema_registry, rbac, encryption, masking, audit, wasm
Status: Valid

Upgrading from OSS

The enterprise binary is a drop-in replacement. To upgrade:

  1. Replace the binary — install the enterprise edition using any method above
  2. Your existing config works as-is — all OSS configuration is fully compatible
  3. Add enterprise features — optionally add an enterprise: section to your config YAML
  4. Apply a license — when you're ready, obtain and apply a license

No data migration is needed. Your existing backups remain fully compatible.

Get a License

After your 14-day trial, purchase a license to continue using enterprise features:

See Licensing for details on license tiers, activation, and management.

Next Steps

  1. Apply a license (or use the 14-day trial)
  2. Configure Schema Registry backup
  3. Configure Confluent RBAC backup
  4. Review the full enterprise feature set