← Back to index Esc
Kind
PhysicalBackup
Group
k8s.mariadb.com
Version
v1alpha1
apiVersion: k8s.mariadb.com/v1alpha1 kind: PhysicalBackup metadata: name: example
Tip: use .spec.args for path-only search
View raw schema
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
PhysicalBackupSpec defines the desired state of PhysicalBackup.
args []string
Args to be used in the Container.
backoffLimit integer
BackoffLimit defines the maximum number of attempts to successfully take a PhysicalBackup.
format: int32
compression string
Compression algorithm to be used in the Backup.
enum: none, bzip2, gzip
imagePullSecrets []object
ImagePullSecrets is the list of pull Secrets to be used to pull the image.
name string
inheritMetadata object
InheritMetadata defines the metadata to be inherited by children resources.
annotations object
Annotations to be added to children resources.
labels object
Labels to be added to children resources.
logLevel string
LogLevel to be used in the PhysicalBackup Job. It defaults to 'info'.
enum: debug, info, warn, error, dpanic, panic, fatal
mariaDbRef object required
MariaDBRef is a reference to a MariaDB object.
kind string
Kind of the referent.
name string
namespace string
waitForIt boolean
WaitForIt indicates whether the controller using this reference should wait for MariaDB to be ready.
maxRetention string
MaxRetention defines the retention policy for backups. Old backups will be cleaned up by the Backup Job. It defaults to 30 days.
podAffinity boolean
PodAffinity indicates whether the Jobs should run in the same Node as the MariaDB Pods to be able to attach the PVC. It defaults to true.
podMetadata object
PodMetadata defines extra metadata for the Pod.
annotations object
Annotations to be added to children resources.
labels object
Labels to be added to children resources.
podSecurityContext object
SecurityContext holds pod-level security attributes and common container settings.
appArmorProfile object
AppArmorProfile defines a pod or container's AppArmor settings.
localhostProfile string
localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
type string required
type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.
fsGroup integer
format: int64
fsGroupChangePolicy string
PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume when volume is mounted.
runAsGroup integer
format: int64
runAsNonRoot boolean
runAsUser integer
format: int64
seLinuxOptions object
SELinuxOptions are the labels to be applied to the container
level string
Level is SELinux level label that applies to the container.
role string
Role is a SELinux role label that applies to the container.
type string
Type is a SELinux type label that applies to the container.
user string
User is a SELinux user label that applies to the container.
seccompProfile object
SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.
localhostProfile string
localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
type string required
type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
supplementalGroups []integer
priorityClassName string
PriorityClassName to be used in the Pod.
resources object
Resources describes the compute resource requirements.
limits object
ResourceList is a set of (resource name, quantity) pairs.
requests object
ResourceList is a set of (resource name, quantity) pairs.
restartPolicy string
RestartPolicy to be added to the PhysicalBackup Pod.
enum: Always, OnFailure, Never
schedule object
Schedule defines when the PhysicalBackup will be taken.
cron string
Cron is a cron expression that defines the schedule.
immediate boolean
Immediate indicates whether the first backup should be taken immediately after creating the PhysicalBackup.
onDemand string
OnDemand is an identifier used to trigger an on-demand backup. If the identifier is different than the one tracked under status.lastScheduleOnDemand, a new physical backup will be triggered.
suspend boolean
Suspend defines whether the schedule is active or not.
securityContext object
SecurityContext holds security configuration that will be applied to a container.
allowPrivilegeEscalation boolean
capabilities object
Adds and removes POSIX capabilities from running containers.
add []string
Added capabilities
drop []string
Removed capabilities
privileged boolean
readOnlyRootFilesystem boolean
runAsGroup integer
format: int64
runAsNonRoot boolean
runAsUser integer
format: int64
serviceAccountName string
ServiceAccountName is the name of the ServiceAccount to be used by the Pods.
stagingStorage object
StagingStorage defines the temporary storage used to keep external backups (i.e. S3) while they are being processed. It defaults to an emptyDir volume, meaning that the backups will be temporarily stored in the node where the PhysicalBackup Job is scheduled. The staging area gets cleaned up after each backup is completed, consider this for sizing it appropriately.
persistentVolumeClaim object
PersistentVolumeClaim is a Kubernetes PVC specification.
accessModes []string
resources object
VolumeResourceRequirements describes the storage resource requirements for a volume.
limits object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
selector object
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key string required
key is the label key that the selector applies to.
operator string required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values []string
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
storageClassName string
volume object
Volume is a Kubernetes volume specification.
csi object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#csivolumesource-v1-core.
driver string required
fsType string
nodePublishSecretRef object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core.
name string
readOnly boolean
volumeAttributes object
emptyDir object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#emptydirvolumesource-v1-core.
medium string
StorageMedium defines ways that storage can be allocated to a volume.
sizeLimit string | integer
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
hostPath object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostpathvolumesource-v1-core
path string required
type string
nfs object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#nfsvolumesource-v1-core.
path string required
readOnly boolean
server string required
persistentVolumeClaim object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaimvolumesource-v1-core.
claimName string required
readOnly boolean
storage object required
Storage defines the final storage for backups.
azureBlob object
AzureBlob defines the configuration to store backups in a AzureBlob compatible storage.
containerName string required
ContainerName is the name of the storage container.
prefix string
Prefix indicates a folder/subfolder in the container. For example: mariadb/ or mariadb/backups. A trailing slash '/' is added if not provided.
serviceURL string required
ServiceURL is the full URL for connecting to Azure, usually in the form: http(s)://<account>.blob.core.windows.net/.
storageAccountKey object
StorageAccountKey is a reference to a Secret key containing the Azure Blob Storage Storage account Key. Pairs with StorageAccountKey for static credential authentication
key string required
name string
storageAccountName string
StorageAccountName is the name of the storage account. Pairs with StorageAccountKey for static credential authentication
tls object
TLS provides the configuration required to establish TLS connections with Azure Blob Storage.
caSecretKeyRef object
CASecretKeyRef is a reference to a Secret key containing a CA bundle in PEM format used to establish TLS connections with S3. By default, the system trust chain will be used, but you can use this field to add more CAs to the bundle.
key string required
name string
enabled boolean
Enabled is a flag to enable TLS.
persistentVolumeClaim object
PersistentVolumeClaim is a Kubernetes PVC specification.
accessModes []string
resources object
VolumeResourceRequirements describes the storage resource requirements for a volume.
limits object
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests object
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
selector object
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key string required
key is the label key that the selector applies to.
operator string required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values []string
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
storageClassName string
s3 object
S3 defines the configuration to store backups in a S3 compatible storage.
accessKeyIdSecretKeyRef object
AccessKeyIdSecretKeyRef is a reference to a Secret key containing the S3 access key id.
key string required
name string
bucket string required
Bucket is the name Name of the bucket to store backups.
endpoint string required
Endpoint is the S3 API endpoint without scheme.
prefix string
Prefix indicates a folder/subfolder in the bucket. For example: mariadb/ or mariadb/backups. A trailing slash '/' is added if not provided.
region string
Region is the S3 region name to use.
secretAccessKeySecretKeyRef object
AccessKeyIdSecretKeyRef is a reference to a Secret key containing the S3 secret key.
key string required
name string
sessionTokenSecretKeyRef object
SessionTokenSecretKeyRef is a reference to a Secret key containing the S3 session token.
key string required
name string
ssec object
SSEC is a reference to a Secret containing the SSE-C (Server-Side Encryption with Customer-Provided Keys) key. The secret must contain a 32-byte key (256 bits) in the specified key. This enables server-side encryption where you provide and manage the encryption key.
customerKeySecretKeyRef object required
CustomerKeySecretKeyRef is a reference to a Secret key containing the SSE-C customer-provided encryption key. The key must be a 32-byte (256-bit) key encoded in base64.
key string required
name string
tls object
TLS provides the configuration required to establish TLS connections with S3.
caSecretKeyRef object
CASecretKeyRef is a reference to a Secret key containing a CA bundle in PEM format used to establish TLS connections with S3. By default, the system trust chain will be used, but you can use this field to add more CAs to the bundle.
key string required
name string
enabled boolean
Enabled is a flag to enable TLS.
volume object
Volume is a Kubernetes volume specification.
csi object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#csivolumesource-v1-core.
driver string required
fsType string
nodePublishSecretRef object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core.
name string
readOnly boolean
volumeAttributes object
emptyDir object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#emptydirvolumesource-v1-core.
medium string
StorageMedium defines ways that storage can be allocated to a volume.
sizeLimit string | integer
string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
hostPath object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#hostpathvolumesource-v1-core
path string required
type string
nfs object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#nfsvolumesource-v1-core.
path string required
readOnly boolean
server string required
persistentVolumeClaim object
Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#persistentvolumeclaimvolumesource-v1-core.
claimName string required
readOnly boolean
volumeSnapshot object
VolumeSnapshot is a Kubernetes VolumeSnapshot specification.
metadata object
Metadata is extra metadata to the added to the VolumeSnapshot objects.
annotations object
Annotations to be added to children resources.
labels object
Labels to be added to children resources.
volumeSnapshotClassName string required
VolumeSnapshotClassName is the VolumeSnapshot class to be used to take snapshots.
successfulJobsHistoryLimit integer
SuccessfulJobsHistoryLimit defines the maximum number of successful Jobs to be displayed. It defaults to 5.
format: int32
minimum: 0
target string
Target defines in which Pod the physical backups will be taken. It defaults to "Replica", meaning that the physical backups will only be taken in ready replicas.
enum: Replica, PreferReplica
timeout string
Timeout defines the maximum duration of a PhysicalBackup job or snapshot. If this duration is exceeded, the job or snapshot is considered expired and is deleted by the operator. A new job or snapshot will then be created according to the schedule. It defaults to 1 hour.
tolerations []object
Tolerations to be used in the Pod.
effect string
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key string
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator string
Operator represents a key's relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).
tolerationSeconds integer
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
format: int64
value string
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
status object
PhysicalBackupStatus defines the observed state of PhysicalBackup.
conditions []object
Conditions for the PhysicalBackup object.
lastTransitionTime string required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
message string required
message is a human readable message indicating details about the transition. This may be an empty string.
maxLength: 32768
observedGeneration integer
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
format: int64
minimum: 0
reason string required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
minLength: 1
maxLength: 1024
status string required
status of the condition, one of True, False, Unknown.
enum: True, False, Unknown
type string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
maxLength: 316
lastScheduleCheckTime string
LastScheduleCheckTime is the last time that the schedule was checked.
format: date-time
lastScheduleOnDemand string
LastScheduleOnDemand is the last on-demand schedule identifier.
lastScheduleTime string
LastScheduleTime is the last time that a backup was scheduled.
format: date-time
nextScheduleTime string
NextScheduleTime is the next time that a backup will be scheduled.
format: date-time

No matches. Try .spec.args for an exact path

Copied!