Kannika Armory

https://docs.kannika.io/
Admin
Kannika Armory is a simple, secure, and affordable backup solution for event hubs, providing data...
Tokens:215,321
Snippets:2,976
Trust Score:5.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Clone and Setup Armory Examples

Source: https://docs.kannika.io/0.17/tutorials/disaster-recovery/backup-with-s3-storage

Clone the repository and run the setup script for the S3 backup example.

```bash
git clone https://github.com/kannika-io/armory-examples.git
cd armory-examples
./setup s3-minio-backup
```

--------------------------------

### Install Armory Examples with Migration Script

Source: https://docs.kannika.io/0.17/tutorials/environment-cloning/migrate-consumer-groups

Use this curl command to download and execute the setup script for the migrate-consumer-groups scenario.

```bash
curl -fsSL https://raw.githubusercontent.com/kannika-io/armory-examples/main/install.sh | bash -s -- migrate-consumer-groups

```

--------------------------------

### Clone Armory Examples and Run Setup

Source: https://docs.kannika.io/0.17/tutorials/environment-cloning/migrate-consumer-groups

Clone the armory-examples repository and run the setup script for the migration scenario.

```bash
git clone https://github.com/kannika-io/armory-examples.git
cd armory-examples
./setup migrate-consumer-groups

```

--------------------------------

### Install Armory Examples for Migration

Source: https://docs.kannika.io/tutorials/environment-cloning/migrate-consumer-groups

Use this command to download and install the necessary scripts for the consumer group migration scenario.

```bash
curl -fsSL https://raw.githubusercontent.com/kannika-io/armory-examples/main/install.sh | bash -s -- migrate-consumer-groups
```

--------------------------------

### Full Restore Example with Storage, EventHub, Credentials, and Restore Resources

Source: https://docs.kannika.io/0.17/getting-started

A comprehensive example detailing the setup for restoring data, including Storage, EventHub, Secret, Credentials, and the Restore resource itself.

```yaml
# Storage - the source of the restore (where backups are stored)
apiVersion: kannika.io/v1alpha
kind: Storage
metadata:
  name: my-volume-storage
spec:
  volume:
    capacity: 10Gi
---
# EventHub - the target Kafka cluster to restore to
apiVersion: kannika.io/v1alpha
kind: EventHub
metadata:
  name: my-kafka-cluster
spec:
  kafka:
    properties:
      bootstrap.servers: broker:9092
---
# Secret - stores the Kafka credentials
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: kafka-credentials
data:
  username: bXktdXNlcm5hbWU=  # base64 encoded
  password: bXktcGFzc3dvcmQ=  # base64 encoded
---
# Credentials - defines authentication to the Kafka cluster
apiVersion: kannika.io/v1alpha
kind: Credentials
metadata:
  name: my-credentials
spec:
  sasl:
    mechanism: PLAIN
    usernameFrom:
      secretKeyRef:
        name: kafka-credentials
        key: username
    passwordFrom:
      secretKeyRef:
        name: kafka-credentials
        key: password
---
# Restore - restores topics from Storage to the EventHub
apiVersion: kannika.io/v1alpha
kind: Restore
metadata:
  name: my-restore
spec:
  source: my-volume-storage
  sink: my-kafka-cluster
  sinkCredentialsFrom:
    credentialsRef:
      name: my-credentials
  enabled: true
  config:
    topics:
      - source: my-topic
        target: my-topic

```

--------------------------------

### Full Backup Example with EventHub, Credentials, and Storage

Source: https://docs.kannika.io/0.17/getting-started

A comprehensive example demonstrating the creation of EventHub, Secret, Credentials, Storage, and Backup resources for a complete Kafka topic backup setup.

```yaml
# EventHub - defines the Kafka cluster connection
apiVersion: kannika.io/v1alpha
kind: EventHub
metadata:
  name: my-kafka-cluster
spec:
  kafka:
    properties:
      bootstrap.servers: broker:9092
---
# Secret - stores the Kafka credentials
apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: kafka-credentials
data:
  username: bXktdXNlcm5hbWU=  # base64 encoded
  password: bXktcGFzc3dvcmQ=  # base64 encoded
---
# Credentials - defines authentication to the Kafka cluster
apiVersion: kannika.io/v1alpha
kind: Credentials
metadata:
  name: my-credentials
spec:
  sasl:
    mechanism: PLAIN
    usernameFrom:
      secretKeyRef:
        name: kafka-credentials
        key: username
    passwordFrom:
      secretKeyRef:
        name: kafka-credentials
        key: password
---
# Storage - defines where backups are stored
apiVersion: kannika.io/v1alpha
kind: Storage
metadata:
  name: my-volume-storage
spec:
  volume:
    capacity: 10Gi
---
# Backup - backs up topics from the EventHub to the Storage
apiVersion: kannika.io/v1alpha
kind: Backup
metadata:
  name: my-backup
spec:
  source: my-kafka-cluster
  sourceCredentialsFrom:
    credentialsRef:
      name: my-credentials
  sink: my-volume-storage
  streams:
    - topic: my-topic

```

--------------------------------

### Clone Armory Examples Repository

Source: https://docs.kannika.io/tutorials/environment-cloning/migrate-consumer-groups

Clone the repository and run the setup script for the migration scenario if you prefer not to use the curl command.

```bash
git clone https://github.com/kannika-io/armory-examples.git
cd armory-examples
./setup migrate-consumer-groups
```

--------------------------------

### Install Kannika Armory with S3 Backup

Source: https://docs.kannika.io/0.17/tutorials/disaster-recovery/backup-with-s3-storage

Use this command to install Kannika Armory with the S3 backup example pre-configured.

```bash
curl -fsSL https://raw.githubusercontent.com/kannika-io/armory-examples/main/install.sh | bash -s -- s3-minio-backup
```

--------------------------------

### Install Kannika Armory for Scheduled Snapshots

Source: https://docs.kannika.io/0.17/tutorials/compliance/schedule-snapshots

Use this command to install Kannika Armory with the schedule-snapshots component. Alternatively, clone the repository and run the setup script.

```bash
curl -fsSL https://raw.githubusercontent.com/kannika-io/armory-examples/main/install.sh | bash -s -- schedule-snapshots
```

```bash
git clone https://github.com/kannika-io/armory-examples.git
cd armory-examples
./setup schedule-snapshots
```

--------------------------------

### Clone and Setup Kannika Armory for S3 Backup

Source: https://docs.kannika.io/tutorials/disaster-recovery/backup-with-s3-storage

Clone the armory-examples repository and run the setup script to configure S3 MinIO backup.

```bash
git clone https://github.com/kannika-io/armory-examples.git
cd armory-examples
./setup s3-minio-backup

```

--------------------------------

### Example Deployment Output

Source: https://docs.kannika.io/0.17/installation/installing-on-openshift

This is an example of the expected output when verifying Kannika Deployments. It shows the status of the api, console, and operator Deployments.

```text
NAME       READY   UP-TO-DATE   AVAILABLE   AGE
api        1/1     1            1           1m
console    1/1     1            1           1m
operator   1/1     1            1           1m
```

--------------------------------

### Install Kannika License

Source: https://docs.kannika.io/0.17/getting-started

Install your license to your Kubernetes cluster using kubectl. Replace <YOUR_LICENSE_FILE> with the path to your license file.

```bash
$ kubectl create secret generic kannika-license \
  --type=kannika.io/license \
  --namespace kannika-system \
  --from-file=license=<YOUR_LICENSE_FILE>

```

--------------------------------

### Install pyyaml for Configuration

Source: https://docs.kannika.io/0.17/user-guide/plugins/wasi

Installs the pyyaml package, which is used for reading plugin configuration files.

```bash
$ pip install pyyaml
```

--------------------------------

### Install Kannika Helm Chart

Source: https://docs.kannika.io/0.17/installation/installing-on-openshift

Installs the Kannika platform using the official Helm chart on OpenShift. Ensure you have Helm and oc CLI installed and configured.

```bash
helm install kannika oci://quay.io/kannika/charts/kannika \
  --create-namespace \
  --namespace kannika-system \
  --version 0.17.2 \
  -f values.yaml
```

--------------------------------

### Example Fetched Offsets

Source: https://docs.kannika.io/tutorials/environment-cloning/migrate-consumer-groups

Example output showing consumer group offsets. This indicates the 'order-processor' group has processed up to offset 3 on the 'orders-prod' topic.

```text
order-processor,orders-prod,0,103
```

--------------------------------

### Install cargo-component

Source: https://docs.kannika.io/0.17/user-guide/plugins/wasi

Install the `cargo-component` tool, which is necessary for building WebAssembly components from Rust projects.

```bash
$ cargo install cargo-component
```

--------------------------------

### Example New Storage YAML

Source: https://docs.kannika.io/0.17/tutorials/compliance/schedule-snapshots

This is an example of the YAML definition for a new Storage resource, showing its API version, kind, metadata, and spec.

```yaml
apiVersion: kannika.io/v1alpha
kind: Storage
metadata:
  name: prod-storage-20260202120000
  namespace: kannika-data
spec:
  volume:
    capacity: 1Gi
```

--------------------------------

### Install Kannika Armory Platform using Helm

Source: https://docs.kannika.io/0.17/installation

Installs the Kannika Armory platform using the Helm chart. This command installs all components into the 'kannika-system' namespace with the release name 'kannika'.

```bash
helm install kannika oci://quay.io/kannika/charts/kannika \
  --create-namespace \
  --namespace kannika-system \
  --version 0.17.2
```

--------------------------------

### Create OpenShift Project

Source: https://docs.kannika.io/0.17/installation/installing-on-openshift

Creates a new OpenShift project named 'kannika-system' for installing Kannika Armory. This should be done before other installation steps.

```bash
oc new-project kannika-system
```

--------------------------------

### Example Rotation Log Output

Source: https://docs.kannika.io/0.17/tutorials/compliance/schedule-snapshots

This is an example of the expected output when the storage rotation job runs successfully, showing the creation of a new storage resource.

```text
Starting storage rotation at 20260202120000
Disabling backup...
backup.kannika.io/prod-backup patched
Waiting for backup to stop...
statefulset.apps/prod-backup condition met
Current storage: prod-storage
New storage name: prod-storage-20260202120000
Creating new storage...
storage.kannika.io/prod-storage-20260202120000 created
Updating backup to use new storage...
backup.kannika.io/prod-backup patched
Re-enabling backup...
backup.kannika.io/prod-backup patched
Storage rotation complete
New storage: prod-storage-20260202120000
```

--------------------------------

### Install Kannika CRDs using Helm

Source: https://docs.kannika.io/0.17/installation/upgrading/0-14-x

Install the Kannika CRDs using the provided Helm chart and version.

```bash
$ helm install kannika-crd oci://quay.io/kannika/charts/kannika-crd \
  --version 0.14.1

```

--------------------------------

### Install Kannika Armory with S3 Backup Support

Source: https://docs.kannika.io/tutorials/disaster-recovery/backup-with-s3-storage

Use this command to install Kannika Armory with S3 MinIO backup support via curl.

```bash
curl -fsSL https://raw.githubusercontent.com/kannika-io/armory-examples/main/install.sh | bash -s -- s3-minio-backup

```

--------------------------------

### Quantity Constraints and Examples

Source: https://docs.kannika.io/refs/0.17.2/crd/kannika-crd-v1alpha.yml

Explains the constraints for the Quantity type, including maximum magnitude and decimal places. Provides examples of canonical form serialization.

```text
No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:

- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.

The sign will be omitted unless the number is negative.

Examples:

- 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
```

--------------------------------

### Install Kannika with Separate Resource Namespace

Source: https://docs.kannika.io/0.17/installation/configuration/namespaces

Use this command to install Kannika Armory, specifying distinct namespaces for the system and resources. The `--create-namespace` flag ensures the system namespace is created if it doesn't exist.

```bash
$ helm install kannika oci://quay.io/kannika/charts/kannika \
  --create-namespace \
  --namespace kannika-system \
  --version 0.17.2 \
  --set global.kubernetes.namespace=kannika-data

```

--------------------------------

### Quantity Serialization Examples

Source: https://docs.kannika.io/refs/0.17.2/crd/kannika-crd-v1alpha.yml

Illustrates how quantities are serialized, showing the conversion of decimal numbers to their canonical form with appropriate suffixes. Non-canonical values are parsed but re-emitted in canonical form.

```text
- 1.5 will be serialized as "1500m"
- 1.5Gi will be serialized as "1536Mi"
```

--------------------------------

### Initialize Go Project

Source: https://docs.kannika.io/0.17/user-guide/plugins/wasi

Create a new Go project directory and initialize it with go mod init.

```bash
$ mkdir go-passthru
$ cd go-passthru
$ go mod init go-passthru
```

--------------------------------

### Create Plugin Development Environment

Source: https://docs.kannika.io/0.17/user-guide/plugins/wasi

Sets up a new directory, virtual environment, and activates it for plugin development.

```bash
$ mkdir off-with-their-headers
$ cd off-with-their-headers
$ python -m venv venv
$ source venv/bin/activate
```

--------------------------------

### Kubernetes Services for Kannika Armory

Source: https://docs.kannika.io/0.17/installation/configuration/networking

Example output of `kubectl get svc` command showing the ClusterIP services for Kannika Armory components within the `kannika-system` namespace.

```bash
$ kubectl get svc -n kannika-system
NAME              TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)    AGE
api               ClusterIP   10.96.124.99   <none>        8080/TCP   1m
console           ClusterIP   10.96.46.216   <none>        8080/TCP   1m
...
```

--------------------------------

### Configure Backup (GraphQL)

Source: https://docs.kannika.io/0.17/getting-started/creating-your-first-backup

Use the `configureBackup` GraphQL mutation to set up a backup. Provide the backup name, source EventHub, source credentials name, and sink storage name.

```graphql
mutation {
  configureBackup(
    input: {
      name: "my-backup",
      sourceEventHubName: "my-kafka-cluster",
      sourceCredentialsName: "sasl-creds",
      sinkStorageName: "my-volume-storage",
    }
  ) {
    ...on BackupConfigured {
      backup {
        name
     }
     ...on BackupConfigurationFailed {
       problems {
         message
         type
       }
     }
  }
}

```

--------------------------------

### CronJob for Snapshot Rotation

Source: https://docs.kannika.io/0.17/tutorials/compliance/schedule-snapshots

This CronJob automates the process of rotating backup storage by disabling the backup, creating new storage, updating the backup to point to the new storage, and re-enabling the backup. It includes steps to install kubectl, disable the backup, wait for it to stop, get current storage configuration, create new storage, update the backup, and re-enable it.

```yaml
# https://github.com/kannika-io/armory-examples/blob/main/tutorials/schedule-snapshots/k8s/rotate-backup-storage.cronjob.yaml
apiVersion: batch/v1
kind: CronJob
metadata:
  name: rotate-backup-storage
  namespace: kannika-data
spec:
  schedule: "0 0 * * *"  # Run at midnight daily
  jobTemplate:
    spec:
      template:
        spec:
          serviceAccountName: backup-storage-rotate-sa
          restartPolicy: OnFailure
          containers:
          - name: rotate
            image: alpine:3
            command:
            - /bin/sh
            - -c
            - |
              set -e


              # Install kubectl
              wget -qO /usr/local/bin/kubectl \
                "https://dl.k8s.io/release/$(wget -qO- https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
              chmod +x /usr/local/bin/kubectl


              BACKUP_NAME="prod-backup"
              NAMESPACE="kannika-data"
              TIMESTAMP=$(date +%Y%m%d%H%M%S)


              echo "Starting storage rotation at ${TIMESTAMP}"


              # Step 1: Disable the backup to flush segments
              echo "Disabling backup..."
              kubectl patch backup ${BACKUP_NAME} -n ${NAMESPACE} \
                --type merge \
                -p '{"spec":{"enabled":false}}'


              # Wait for backup StatefulSet to scale down
              echo "Waiting for backup to stop..."
              kubectl wait statefulset -l io.kannika/backup=${BACKUP_NAME} -n ${NAMESPACE} \
                --for=jsonpath='{.status.replicas}'=0 \
                --timeout=60s


              # Step 2: Get current storage configuration
              CURRENT_STORAGE=$(kubectl get backup ${BACKUP_NAME} -n ${NAMESPACE} \
                -o jsonpath='{.spec.sink}')
              echo "Current storage: ${CURRENT_STORAGE}"


              # Extract base name (remove any existing timestamp suffix)
              BASE_NAME=$(echo ${CURRENT_STORAGE} | sed 's/-[0-9]\\{14\\}$//')
              NEW_STORAGE_NAME="${BASE_NAME}-${TIMESTAMP}"


              echo "New storage name: ${NEW_STORAGE_NAME}"


              # Step 3: Create new storage with timestamp
              # Extract the spec from current storage
              VOLUME_CAPACITY=$(kubectl get storage ${CURRENT_STORAGE} -n ${NAMESPACE} \
                -o jsonpath='{.spec.volume.capacity}')


              echo "Creating new storage..."
              cat <<EOF | kubectl apply -f -
              apiVersion: kannika.io/v1alpha
              kind: Storage
              metadata:
                name: ${NEW_STORAGE_NAME}
                namespace: ${NAMESPACE}
              spec:
                volume:
                  capacity: ${VOLUME_CAPACITY}
              EOF


              # Step 4: Update backup to use new storage
              echo "Updating backup to use new storage..."
              kubectl patch backup ${BACKUP_NAME} -n ${NAMESPACE} \
                --type merge \
                -p "{\"spec\":{\"sink\":\"${NEW_STORAGE_NAME}\"}}"


              # Step 5: Re-enable the backup
              echo "Re-enabling backup..."
              kubectl patch backup ${BACKUP_NAME} -n ${NAMESPACE} \
                --type merge \
                -p '{"spec":{"enabled":true}}'


              echo "Storage rotation complete"
              echo "New storage: ${NEW_STORAGE_NAME}"

```

--------------------------------

### Start Restore

Source: https://docs.kannika.io/refs/0.17.2/openapi/kannika-openapi-spec-0.17.2.json

Starts a restore operation.

```APIDOC
## POST /rest/restores/{name}/start

### Description
Starts a restore operation.

### Method
POST

### Endpoint
/rest/restores/{name}/start

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the restore to start.

### Responses
#### Success Response (200)
- **Restore started** - Indicates the restore operation has started.

#### Error Responses
- **400** - Bad Request
- **404** - Not Found
- **503** - Service Unavailable
```

--------------------------------

### Create Storage

Source: https://docs.kannika.io/refs/0.17.2/openapi/kannika-openapi-spec-0.17.2.json

Configure a storage.

```APIDOC
## POST /rest/storages

### Description
Create a storage.

### Method
POST

### Endpoint
/rest/storages

### Request Body
- **schema**: Reference to StorageInput schema
```

--------------------------------

### Get Restore

Source: https://docs.kannika.io/refs/0.17.2/openapi/kannika-openapi-spec-0.17.2.json

To get a restore by its name.

```APIDOC
## GET /rest/restores/{name}

### Description
To get a restore by its name.

### Method
GET

### Endpoint
/rest/restores/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the restore.

### Responses
#### Success Response (200)
- **RestoreResource** (object) - The restore resource details.

#### Error Responses
- **400** - Bad Request
- **404** - Not Found
- **503** - Service Unavailable
```

--------------------------------

### Get Restore Metrics

Source: https://docs.kannika.io/refs/0.17.2/openapi/kannika-openapi-spec-0.17.2.json

To get metrics of a restore by its name.

```APIDOC
## GET /rest/restores/{name}/metrics

### Description
Get restore metrics.

### Method
GET

### Endpoint
/rest/restores/{name}/metrics

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the restore.

### Response
#### Success Response (200)
- **schema**: Reference to RestoreMetrics schema
```

--------------------------------

### Download Libraries

Source: https://docs.kannika.io/0.17/user-guide/plugins/wasi

Download the WASI reactor and Binaryen library required for building WASI plugins.

```bash
$ curl -sLo wasi_snapshot_preview1.reactor.wasm https://github.com/bytecodealliance/wasmtime/releases/download/v23.0.2/wasi_snapshot_preview1.reactor.wasm
$ curl -sLo binaryen-version_118-x86_64-linux.tar.gz https://github.com/WebAssembly/binaryen/releases/download/version_118/binaryen-version_118-x86_64-linux.tar.gz
$ tar -xf binaryen-version_118-x86_64-linux.tar.gz
```

--------------------------------

### Install Kannika CRDs using Helm

Source: https://docs.kannika.io/0.17/installation/installing-on-openshift

Install the Custom Resource Definitions for Kannika Armory using a Helm chart. Ensure Helm version 3.9+ is installed.

```bash
helm install kannika-crd oci://quay.io/kannika/charts/kannika-crd \
  --version 0.17.2
```

--------------------------------

### Show Backup Index Summary

Source: https://docs.kannika.io/user-guide/tooling

Inspect the state of a running backup by showing a summary of all topics present in the storage. Use --all to show all topics.

```bash
$ kubectl -n kannika-data exec my-backup-58a8f72c-0 -- kannika-tools index show --all --summary
---
topic: std-1
no_files: 2
no_records: 17763
partitions:
  0:
    first_offset: 0
    last_offset: 7707
    message_count: 7708
    topic_size: 215824
  1:
    first_offset: 0
    last_offset: 7071
    message_count: 7072
    topic_size: 198016
  2:
    first_offset: 0
    last_offset: 2982
    message_count: 2983
    topic_size: 83524

```

--------------------------------

### Cleanup Tutorial Resources

Source: https://docs.kannika.io/0.17/tutorials/disaster-recovery/backup-with-s3-storage

Execute the teardown script to remove all resources created during this tutorial, ensuring a clean environment.

```bash
./teardown
```

--------------------------------

### Start Restore

Source: https://docs.kannika.io/refs/0.17.2/gql/schema.graphql

Initiates a restore operation. Requires the name of the restore to start.

```APIDOC
mutation StartRestore($input: StartRestoreInput!) {
  startRestore(input: $input) {
    ... on RestoreStarted {
      restore {
        id
      }
    }
    ... on StartRestoreFailed {
      problems {
        message
        type
      }
    }
  }
}
```

--------------------------------

### Rust: Create New Component Project and Add Dependencies

Source: https://docs.kannika.io/0.17/user-guide/plugins/wasi

Create a new Rust library project for a WebAssembly component and add `serde` and `serde_yaml` crates for configuration deserialization.

```bash
$ cargo component new acme-repartitioning --lib
$ cd acme-repartitioning
$ cargo add serde --features derive
$ cargo add serde_yaml
```

--------------------------------

### Start Schema Registry Restore

Source: https://docs.kannika.io/refs/0.17.2/gql/schema.graphql

Starts a Schema Registry restore operation.

```APIDOC
## StartSchemaRegistryRestore

### Description
Starts a Schema Registry restore operation.

### Type
`mutation StartSchemaRegistryRestore($input: StartSchemaRegistryRestoreInput!)`

### Input
#### StartSchemaRegistryRestoreInput
- **name** (String!) - Required - The name of the restore operation to start.

### Payload
`StartSchemaRegistryRestorePayload` (Union)
- `SchemaRegistryRestoreStarted`
- `SchemaRegistryRestoreAlreadyActive`
- `StartSchemaRegistryRestoreFailed`
```

--------------------------------

### Get Restore Schema Mapping

Source: https://docs.kannika.io/refs/0.17.2/openapi/kannika-openapi-spec-0.17.2.json

To get the schema mapping for a restore by its name.

```APIDOC
## GET /rest/restores/{name}/schema/mapping

### Description
Get restore schema mapping.

### Method
GET

### Endpoint
/rest/restores/{name}/schema/mapping

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the restore.

### Response
#### Success Response (200)
- **mapping** (object) - The schema mappings. Additional properties are integers (int64).

### Response Example
{
  "mapping": {
    "schema1": 123,
    "schema2": 456
  }
}
```

--------------------------------

### Restore Status with Multiple Conditions

Source: https://docs.kannika.io/0.17/user-guide/restore/lifecycle

This example shows a typical `status` section for a Restore that is currently in the 'Restoring' state, detailing various conditions like configuration validity, restore progress, and job/pod status.

```yaml
kind: Restore
# ...
status:
  message: Restoring
  completionTime: null
  startTime: "2024-01-15T10:30:00Z"
  conditions:
  - type: ConfigurationValid
    status: "True"
    reason: ValidConfiguration
    message: The restore configuration is valid
    lastTransitionTime: "2024-01-15T10:30:00Z"
    observedGeneration: 3
  - type: RestoreCompleted
    status: "False"
    reason: Restoring
    message: The restore is in progress
    lastTransitionTime: "2024-01-15T10:30:00Z"
    observedGeneration: 3
  - type: JobCompleted
    status: "False"
    reason: JobRunning
    message: The job is currently running
    lastTransitionTime: "2024-01-15T10:30:00Z"
    observedGeneration: 3
  - type: PodCompleted
    status: "False"
    reason: PodRunning
    message: The pod is currently running
    lastTransitionTime: "2024-01-15T10:30:00Z"
    observedGeneration: 3

```

--------------------------------

### Get SchemaRegistryRestores

Source: https://docs.kannika.io/0.17/user-guide/schema-registry-restore

Use `kubectl get schemaregistryrestores` to list all SchemaRegistryRestore resources.

```bash
$ kubectl get schemaregistryrestores
NAME                         STATUS
confluent-registry-restore   🌈 Ready

```

--------------------------------

### List Storage Resources with kubectl

Source: https://docs.kannika.io/0.17/user-guide/storage

Use `kubectl get storages` to list all configured storage resources and their status, age, and location.

```bash
$ kubectl get storages
NAME            STATUS   AGE   LOCATION
s3-storage      Ready    1s    s3://kannika-aws-s3/backups
gcs-storage     Ready    1s    gs://kannika-gcs/backups
azure-storage   Ready    1s    https://kannika-azure.blob.core.windows.net/backups
volume-storage  Ready    1s
```

--------------------------------

### Install Kannika CRDs using Helm

Source: https://docs.kannika.io/0.17/installation/upgrading/0-15-x

Install the Kannika CRDs for version 0.15.7 using Helm.

```bash
$ helm install kannika-crd oci://quay.io/kannika/charts/kannika-crd \
  --version 0.15.7
```

--------------------------------

### List Snapshot Versions for a Topic

Source: https://docs.kannika.io/user-guide/tooling

List available snapshot versions for a specific topic. Use --all to list snapshots for all topics and -o yaml for machine-readable output.

```bash
$ kubectl -n kannika-data exec my-backup-58a8f72c-0 -- kannika-tools snapshot list my-topic
Topic: my-topic (active: v2)


  VERSION  TOPIC ID                               CREATED
  v1       5a8f3b2c-1d4e-4f6a-9b7c-8e2d1f0a3b5c  2026-01-15 10:00:00 UTC
* v2       9c7e4d6f-2a3b-4c8d-1e5f-7g6h8i9j0k1l  2026-06-01 09:00:00 UTC

```

--------------------------------

### Install Kannika CRDs

Source: https://docs.kannika.io/0.17/getting-started

Install the Custom Resource Definitions (CRDs) on your Kubernetes cluster using kubectl.

```bash
$ kubectl apply -f https://docs.kannika.io/refs/0.17.2/crd/kannika-crd-v1alpha.yml

```

--------------------------------

### Configure SchemaRegistryBackup

Source: https://docs.kannika.io/0.17/user-guide/schema-registry-backup

Example of a SchemaRegistryBackup resource configuration. This defines the backup's name, registry connection, storage destination, backup interval, and optional environment variables.

```yaml
apiVersion: kannika.io/v1alpha
kind: SchemaRegistryBackup
metadata:
  name: confluent-registry-backup
spec:
  enabled: true
  registry: confluent-registry
  registryCredentialsFrom:
    credentialsRef:
      name: confluent-registry-creds
  storage: local-storage
  # An optional explicit interval between backups in seconds
  backupIntervalSecs: 15
  extraEnvVars:
    - name: RUST_LOG
      value: debug

```

--------------------------------

### Install componentize-py for WebAssembly Compilation

Source: https://docs.kannika.io/0.17/user-guide/plugins/wasi

Installs the componentize-py package, a tool for converting Python code into WebAssembly components.

```bash
$ pip install componentize-py
```

--------------------------------

### Rust Component Project Structure

Source: https://docs.kannika.io/user-guide/plugins/wasi

Illustrates the expected file structure for a Rust WebAssembly component project after setup, including source files, WIT definitions, and configuration.

```tree
├── Cargo.lock
├── Cargo.toml
├── src
│   └── lib.rs
└── wit
    ├── restore.wit
    └── types.wit
```

--------------------------------

### Install Kannika CRDs using Helm

Source: https://docs.kannika.io/0.17/installation/upgrading/0-12-x

Install the Kannika CRDs using Helm, specifying version 0.12.4.

```bash
$ helm install kannika-crd oci://quay.io/kannika/charts/kannika-crd \
  --version 0.12.4
```

--------------------------------

### Configure Partition Roll-over Triggers

Source: https://docs.kannika.io/blog/announcing-release-070

Define when a new partition should be created based on size or time. This example sets a new partition to be created when the current partition reaches 100MiB or after 1 hour of inactivity.

```yaml
apiVersion: kannika.io/v1alpha
kind: Backup
metadata:
  name: my-backup
spec:
  source: "my-kafka-cluster"
  sink: "my-storage"
  partitionRolloverTriggers:
     size: 100Mi # Create a new partition when the current partition reaches 100MiB
     timeoutSeconds: 3600 # Or after an hour (when the worker is idle)

```

--------------------------------

### Install Kannika CRDs using Helm

Source: https://docs.kannika.io/0.17/installation/upgrading/0-10-x

Use this Helm command to install the Kannika CRDs for version 0.10.1.

```bash
$ helm install kannika-crd oci://quay.io/kannika/charts/kannika-crd \
  --version 0.10.1
```

--------------------------------

### Install Kannika CRDs using Helm

Source: https://docs.kannika.io/0.17/installation/upgrading/0-11-x

Installs the Kannika CRDs for version 0.11.1 using a Helm chart.

```bash
$ helm install kannika-crd oci://quay.io/kannika/charts/kannika-crd \
  --version 0.11.1

```

--------------------------------

### Configure Backup Topics (GraphQL)

Source: https://docs.kannika.io/0.17/getting-started/creating-your-first-backup

Use the `configureBackupTopics` GraphQL mutation to enable specific topics for a backup. Specify the backup name and the list of topics to import.

```graphql
mutation {
  configureBackupTopics(
    input: {
      backupName: "my-backup",
      topics: ["my-topic"]
      enable: true
    }
  ) {
    ...on BackupTopicsConfigured {
      backup {
        name
      }
    }
    ...on ConfigureBackupTopicsFailed {
      problems {
        message
        type
      }
    }
  }
}

```

--------------------------------

### WARN: Offset Reset Warning Example

Source: https://docs.kannika.io/0.17/faq/offset-reset

Example log message indicating an offset reset warning during a backup operation.

```log
WARN  offset reset (at offset 42, broker 1) to offset BEGINNING:
      fetch failed due to requested offset not available on the broker:
      Broker: Offset out of range
```

--------------------------------

### Backup using Source and Sink Credentials

Source: https://docs.kannika.io/0.17/user-guide/authentication/credentials

This example demonstrates how to configure a Backup resource to use specific credentials for both its source (EventHub) and sink (Storage). Ensure the referenced credential names match existing Kubernetes Secrets.

```yaml
apiVersion: kannika.io/v1alpha
kind: Backup
metadata:
  name: backup
spec:
  source: kafka            # References an EventHub
  sourceCredentialsFrom:
    credentialsRef:
       name: kafka-creds   # References a Credentials


  sink: s3-storage         # References a Storage
  sinkCredentialsFrom:
    credentialsRef:
       name: aws-creds     # References a Credentials

```

--------------------------------

### Get Schema Registry Restore

Source: https://docs.kannika.io/refs/0.17.2/openapi/kannika-openapi-spec-0.17.2.json

Retrieves a schema registry restore by its name. This allows you to get details about a specific restore operation.

```APIDOC
## GET /rest/schemaregistryrestores/{name}

### Description
Get a schema registry restore by name.

### Method
GET

### Endpoint
/rest/schemaregistryrestores/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the schema registry restore.

### Response
#### Success Response (200)
- **SchemaRegistryRestoreResource** - OK
```

--------------------------------

### Install CRDs using Helm

Source: https://docs.kannika.io/installation/upgrading/0-9-x

Use this command to install the new Custom Resource Definitions (CRDs) for 0.9.x using Helm.

```bash
helm install kannika-crd oci://quay.io/kannika/charts/kannika-crd \
  --version 0.9.1
```

--------------------------------

### Install CRDs using kubectl

Source: https://docs.kannika.io/installation/upgrading/0-9-x

Use this command to install the new Custom Resource Definitions (CRDs) for 0.9.x using kubectl.

```bash
kubectl apply -f https://docs.kannika.io/refs/0.9.1/crd/kannika-crd-v1alpha.yml
```
Tokens:
Raw