# OSO Kafka Backup Documentation High-performance backup and restore for Apache Kafka > [!TIP] > A complete archive of all documentation in Markdown format is available at https://kafkabackup.com/markdown.zip ## Docs Sidebar - [Intro](https://kafkabackup.com/intro.md) - [Frequently Asked Questions](https://kafkabackup.com/well-architected/faq.md): Common questions about OSO Kafka Backup architecture, operations, and best practices ### Getting Started - [Index](https://kafkabackup.com/getting-started/index.md) - [5-Minute Quickstart](https://kafkabackup.com/getting-started/quickstart.md): Get your first Kafka backup running in under 5 minutes using Docker - [CLI Basics](https://kafkabackup.com/getting-started/cli-basics.md): Learn the OSO Kafka Backup command-line interface - commands, flags, and common operations - [Your First Backup](https://kafkabackup.com/getting-started/first-backup.md): Complete step-by-step guide to backing up and restoring your first Kafka topic ### Use Cases - [Disaster Recovery](https://kafkabackup.com/use-cases/disaster-recovery.md): Use OSO Kafka Backup for zero-downtime disaster recovery - [Compliance & Audit](https://kafkabackup.com/use-cases/compliance-audit.md): Use OSO Kafka Backup for regulatory compliance and audit requirements - [Compliance Evidence Generation](https://kafkabackup.com/use-cases/compliance-evidence.md): Close the gap between paper compliance and operational reality for Kafka backups - [Migration](https://kafkabackup.com/use-cases/migration.md): Use OSO Kafka Backup for Kafka cluster migrations - [Feature Comparison](https://kafkabackup.com/use-cases/vs-alternatives.md): Compare OSO Kafka Backup with MirrorMaker, Confluent Replicator, and other solutions ### Deployment - [Index](https://kafkabackup.com/deployment/index.md) - [Bare Metal Installation](https://kafkabackup.com/deployment/bare-metal.md): Install OSO Kafka Backup on bare metal servers and VMs - [Docker Deployment](https://kafkabackup.com/deployment/docker.md): Deploy OSO Kafka Backup using Docker and Docker Compose - [Kubernetes Deployment](https://kafkabackup.com/deployment/kubernetes.md): Deploy OSO Kafka Backup on Kubernetes manually or with the Operator #### Cloud Setup - [AWS S3 Setup](https://kafkabackup.com/deployment/cloud-setup/aws-s3.md): Configure AWS S3 as storage backend for OSO Kafka Backup - [Azure Blob Storage Setup](https://kafkabackup.com/deployment/cloud-setup/azure-blob.md): Configure Azure Blob Storage as backend for OSO Kafka Backup - [Google Cloud Storage Setup](https://kafkabackup.com/deployment/cloud-setup/gcs.md): Configure Google Cloud Storage as backend for OSO Kafka Backup ### Guides - [Backup to S3](https://kafkabackup.com/guides/backup-to-s3.md): Step-by-step guide to backing up Kafka topics to Amazon S3 - [Incremental Backups](https://kafkabackup.com/guides/incremental-backups.md): Configure resumable incremental backups that only capture new data on each run - [Retention and Erasure](https://kafkabackup.com/guides/retention-and-erasure.md): Bounded retention for backup sets and re-applying GDPR erasure requests on restore - [Point-in-Time Recovery (PITR)](https://kafkabackup.com/guides/restore-pitr.md): Restore Kafka data to a specific point in time using PITR - [Offset Management](https://kafkabackup.com/guides/offset-management.md): Manage consumer group offsets during backup and restore operations - [Performance Tuning](https://kafkabackup.com/guides/performance-tuning.md): Optimize OSO Kafka Backup throughput and resource usage - [Security Setup](https://kafkabackup.com/guides/security-setup.md): Configure TLS, SASL, and encryption for OSO Kafka Backup - [Monitoring Setup](https://kafkabackup.com/guides/monitoring-setup.md): Scrape OSO Kafka Backup with Prometheus and visualize it in Grafana - [Backup Validation & Compliance Evidence](https://kafkabackup.com/guides/validation-compliance.md): Step-by-step guide to validating Kafka backups and generating signed compliance evidence reports - [Evidence Report Signing](https://kafkabackup.com/guides/evidence-signing.md): Generate, sign, and verify cryptographic evidence reports with ECDSA-P256-SHA256 - [MSK KRaft Migration Runbook](https://kafkabackup.com/guides/msk-kraft-migration-runbook.md): Step-by-step production runbook for migrating AWS MSK from ZooKeeper to KRaft with kafka-backup E... - [MSK KRaft Migration Monitoring](https://kafkabackup.com/guides/msk-kraft-monitoring.md): Operator monitoring guide for kafka-backup Enterprise MSK ZooKeeper to KRaft migrations — what to... ### Reference - [CLI Reference](https://kafkabackup.com/reference/cli-reference.md): Complete reference for all OSO Kafka Backup CLI commands, flags, and options - [Configuration Reference](https://kafkabackup.com/reference/config-yaml.md): Complete reference for OSO Kafka Backup YAML configuration files - [Storage Format](https://kafkabackup.com/reference/storage-format.md): OSO Kafka Backup storage layout and file format reference - [Error Codes](https://kafkabackup.com/reference/error-codes.md): OSO Kafka Backup error codes, messages, and troubleshooting - [Metrics Reference](https://kafkabackup.com/reference/metrics.md): Prometheus metrics emitted by OSO Kafka Backup v0.19.2 - [Validation Config Reference](https://kafkabackup.com/reference/validation-config.md): Complete reference for all validation.yaml configuration options - [Evidence Report Schema](https://kafkabackup.com/reference/evidence-report-schema.md): JSON schema reference for backup validation evidence reports ### Kubernetes Operator - [Index](https://kafkabackup.com/operator/index.md) - [Installation](https://kafkabackup.com/operator/installation.md): Install the OSO Kafka Backup Operator - [Configuration](https://kafkabackup.com/operator/configuration.md): Configure the OSO Kafka Backup Operator - [Metrics](https://kafkabackup.com/operator/metrics.md): Prometheus metrics for the OSO Kafka Backup Operator - [Operator Troubleshooting](https://kafkabackup.com/operator/troubleshooting.md): Troubleshoot the OSO Kafka Backup Operator #### CRD Reference - [KafkaBackup CRD](https://kafkabackup.com/operator/crds/kafkabackup.md): KafkaBackup Custom Resource Definition reference - [KafkaRestore CRD](https://kafkabackup.com/operator/crds/kafkarestore.md): KafkaRestore Custom Resource Definition reference - [KafkaOffsetReset CRD](https://kafkabackup.com/operator/crds/kafkaoffsetreset.md): KafkaOffsetReset Custom Resource Definition reference - [KafkaOffsetRollback CRD](https://kafkabackup.com/operator/crds/kafkaoffsetrollback.md): KafkaOffsetRollback Custom Resource Definition reference - [KafkaBackupValidation CRD](https://kafkabackup.com/operator/crds/kafkabackupvalidation.md): KafkaBackupValidation Custom Resource Definition reference #### Operator Guides - [Scheduled Backups](https://kafkabackup.com/operator/guides/scheduled-backups.md): Configure automated backup schedules with the Kubernetes Operator - [Backup Retention](https://kafkabackup.com/operator/guides/backup-retention.md): Configure opt-in backup retention with the Kubernetes Operator - [GitOps Integration](https://kafkabackup.com/operator/guides/gitops.md): Manage Kafka backups using GitOps workflows - [Secrets Configuration](https://kafkabackup.com/operator/guides/secrets.md): Configure Kubernetes Secrets for Kafka backup credentials ### Strimzi Operator - [Index](https://kafkabackup.com/strimzi-operator/index.md) - [Restore Jobs and Retry Behavior](https://kafkabackup.com/strimzi-operator/job-behavior.md): How the Strimzi Backup Operator runs Jobs — retries, backoffLimit, status conditions, and cleanup - [Prometheus Metrics](https://kafkabackup.com/strimzi-operator/metrics.md): Scrape Strimzi Backup Operator controller and backup/restore Job metrics ### Enterprise - [Index](https://kafkabackup.com/enterprise/index.md) - [Enterprise Installation](https://kafkabackup.com/enterprise/installation.md): Install OSO Kafka Backup Enterprise via Homebrew, Docker, or binary download - [Helm Chart](https://kafkabackup.com/enterprise/helm-chart.md): Deploy OSO Kafka Backup Enterprise on Kubernetes using the official Helm chart - [Schema Registry Backup & Restore](https://kafkabackup.com/enterprise/schema-registry.md): Back up and restore Confluent Schema Registry with OSO Kafka Backup Enterprise - [Confluent RBAC Backup & Restore](https://kafkabackup.com/enterprise/confluent-rbac.md): Back up and restore Confluent Platform RBAC role bindings from the Metadata Service (MDS) - [Licensing](https://kafkabackup.com/enterprise/licensing.md): OSO Kafka Backup Enterprise licensing and activation - [Role-Based Access Control (RBAC)](https://kafkabackup.com/enterprise/rbac.md): Role-based access control for OSO Kafka Backup Enterprise - [Confluent CSFLE metadata backup](https://kafkabackup.com/enterprise/encryption.md): Back up Confluent CSFLE keys, DEK Registry entries, encrypted subjects, and schema encryption rul... - [GDPR Erasure (restore-time key suppression)](https://kafkabackup.com/enterprise/erasure.md): Restore-time key suppression — re-apply erasure requests when restoring a backup (Enterprise 0.4.0+) - [Audit Logging](https://kafkabackup.com/enterprise/audit-logging.md): Comprehensive audit trails for OSO Kafka Backup Enterprise #### MSK KRaft Migration - [MSK ZooKeeper to KRaft Migration](https://kafkabackup.com/enterprise/msk-kraft-migration.md): Migrate AWS MSK clusters from ZooKeeper to KRaft with a controlled cutover, offset continuity, an... - [MSK KRaft Migration Configuration Reference](https://kafkabackup.com/enterprise/msk-kraft-config-reference.md): Complete YAML configuration reference for kafka-backup Enterprise MSK ZooKeeper to KRaft migration. - [MSK KRaft Migration Precheck Codes](https://kafkabackup.com/enterprise/msk-kraft-precheck-codes.md): Complete reference for all kafka-backup MSK KRaft migration precheck findings — blockers, warning... - [MSK KRaft Migration CLI Reference](https://kafkabackup.com/enterprise/msk-kraft-cli-reference.md): Complete CLI reference for all kafka-backup migrate msk-kraft subcommands — plan, precheck, execu... ### Architecture - [Architecture Overview](https://kafkabackup.com/architecture/overview.md): Understanding the OSO Kafka Backup architecture and design principles - [Offset Translation](https://kafkabackup.com/architecture/offset-translation.md): Understanding how OSO Kafka Backup handles offset mapping between clusters - [Point-in-Time Recovery Implementation](https://kafkabackup.com/architecture/pitr-implementation.md): How point-in-time recovery works in OSO Kafka Backup - [Compression](https://kafkabackup.com/architecture/compression.md): How OSO Kafka Backup compresses data for efficient storage - [Zero-Copy Optimization](https://kafkabackup.com/architecture/zero-copy-optimization.md): Performance optimizations in OSO Kafka Backup - [MSK KRaft Migration Architecture](https://kafkabackup.com/architecture/msk-kraft-migration.md): Deep dive into the kafka-backup Enterprise MSK ZooKeeper to KRaft migration architecture — state ... ### Benchmarks - [Index](https://kafkabackup.com/benchmarks/index.md) ### Well Architected Framework - [Index](https://kafkabackup.com/well-architected/index.md) - [Operational Excellence](https://kafkabackup.com/well-architected/operational-excellence.md): Design principles and best practices for running and monitoring Kafka backup workloads effectivel... - [Security](https://kafkabackup.com/well-architected/security.md): Protecting backup data, configurations, and operations through identity management, encryption, a... - [Reliability](https://kafkabackup.com/well-architected/reliability.md): Ensuring consistent backup and restore operations, graceful failure recovery, and meeting defined... - [Performance Efficiency](https://kafkabackup.com/well-architected/performance-efficiency.md): Efficient use of compute, storage, and network resources to meet backup and restore throughput re... - [Cost Optimisation](https://kafkabackup.com/well-architected/cost-optimisation.md): Managing and reducing the total cost of Kafka backup operations through efficient resource utilis... - [Sustainability](https://kafkabackup.com/well-architected/sustainability.md): Minimising the environmental impact of Kafka backup operations through efficient resource utilisa... - [Cross-Cutting Concerns](https://kafkabackup.com/well-architected/cross-cutting-concerns.md): Architecture considerations that span multiple pillars of the Well-Architected Framework - [Reference Architectures](https://kafkabackup.com/well-architected/reference-architectures.md): Proven deployment patterns for Kafka backup across single-region, cross-region, multi-cloud, air-... - [Self-Assessment Checklist](https://kafkabackup.com/well-architected/self-assessment.md): Score your Kafka backup architecture maturity across all six pillars of the Well-Architected Fram... - [Glossary](https://kafkabackup.com/well-architected/glossary.md): Definitions of key terms used throughout the Well-Architected Framework - [Further Reading](https://kafkabackup.com/well-architected/further-reading.md): Curated resources for deepening your Kafka backup and disaster recovery knowledge ### Troubleshooting - [Common Errors](https://kafkabackup.com/troubleshooting/common-errors.md): Troubleshooting common OSO Kafka Backup errors - [Performance Issues](https://kafkabackup.com/troubleshooting/performance-issues.md): Troubleshooting slow backup and restore operations - [Offset Discontinuity](https://kafkabackup.com/troubleshooting/offset-discontinuity.md): Troubleshooting offset-related issues after restore - [Debug Mode](https://kafkabackup.com/troubleshooting/debug-mode.md): Enable verbose logging and debugging for OSO Kafka Backup - [Support](https://kafkabackup.com/troubleshooting/support.md): Get help with OSO Kafka Backup - [MSK KRaft Migration Troubleshooting](https://kafkabackup.com/troubleshooting/msk-kraft-migration.md): Troubleshooting guide for kafka-backup Enterprise MSK ZooKeeper to KRaft migration errors and com... ### Examples - [Kafka Streams Example](https://kafkabackup.com/examples/kafka-streams.md): Backup and restore Kafka Streams applications - [Spring Boot Example](https://kafkabackup.com/examples/spring-boot.md): Backup and restore Kafka for Spring Boot applications - [AWS Lambda Example](https://kafkabackup.com/examples/aws-lambda.md): Backup and restore Kafka for AWS Lambda consumers - [Multi-Cluster Disaster Recovery](https://kafkabackup.com/examples/multi-cluster-dr.md): Disaster recovery across multiple Kafka clusters - [Example: SOX Compliance Evidence](https://kafkabackup.com/examples/compliance-evidence-sox.md): End-to-end example of generating signed compliance evidence for SOX ITGC audits - [Example: GDPR Compliance Evidence](https://kafkabackup.com/examples/compliance-evidence-gdpr.md): Proving Kafka restore capability for GDPR Article 32 with signed evidence reports - [Example: MSK KRaft Migration (IAM to IAM)](https://kafkabackup.com/examples/msk-kraft-migration-iam.md): Complete worked example migrating an AWS MSK cluster from ZooKeeper to KRaft using IAM authentica... - [Example: MSK KRaft Migration (SCRAM to IAM)](https://kafkabackup.com/examples/msk-kraft-migration-cross-auth.md): Worked example migrating an AWS MSK cluster from ZooKeeper with SCRAM-SHA-512 authentication to K...