KafkaBackup CRD schema reference (group kafka.banzaicloud.io)

KafkaBackup is the Schema for the kafkabackups API

KafkaBackup

KafkaBackup is the Schema for the kafkabackups API

Full name:
kafkabackups.kafka.banzaicloud.io
Group:
kafka.banzaicloud.io
Singular name:
kafkabackup
Plural name:
kafkabackups
Scope:
Namespaced
Versions:
v1beta1

Version v1beta1

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object

.spec

object

KafkaBackupSpec defines the desired state of KafkaBackup

.spec.clusterRef

string Required

ClusterRef points to the Kafka cluster which backups to be managed for based on this spec

.spec.retentionTime

string

The amount of time until the taken backups will remain available for restore in the format of sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms” or “2h45m”. Valid time units are “ns”, “us”, “ms”, “s”, “m”, “h”. If not set backups are not deleted.

.spec.schedule

string Required

The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

.spec.startingDeadlineSeconds

integer

Optional deadline in seconds for starting the job if it misses scheduled time for any reason.

.spec.suspend

boolean

This flag tells the controller to suspend subsequent backup executions, it does not apply to already started executions. Defaults to false.

.spec.volumeSnapshotClassName

string Required

The name of the VolumeSnapshot class to be used for creating snapshots of the persistent volumes of the Kafka cluster

.status

object

KafkaBackupStatus defines the observed state of KafkaBackup

.status.lastExecutionTime

string

The timestamp of last backup execution

.status.nextExecutionTime

string

The timestamp of next backup execution