k8s.v1alpha1.mariaDB

"MariaDB is the Schema for the mariadbs API. It is used to define MariaDB clusters."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of MariaDB

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"MariaDBSpec defines the desired state of MariaDB"

fn spec.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.withCommand

withCommand(command)

"Command to be used in the Container."

fn spec.withCommandMixin

withCommandMixin(command)

"Command to be used in the Container."

Note: This function appends passed data to existing values

fn spec.withDatabase

withDatabase(database)

"Database is the name of the initial Database."

fn spec.withEnv

withEnv(env)

"Env represents the environment variables to be injected in a container."

fn spec.withEnvFrom

withEnvFrom(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.withEnvFromMixin

withEnvFromMixin(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

Note: This function appends passed data to existing values

fn spec.withEnvMixin

withEnvMixin(env)

"Env represents the environment variables to be injected in a container."

Note: This function appends passed data to existing values

fn spec.withImage

withImage(image)

"Image name to be used by the MariaDB instances. The supported format is <image>:<tag>.\nOnly MariaDB official images are supported."

fn spec.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

fn spec.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

Note: This function appends passed data to existing values

fn spec.withInitContainers

withInitContainers(initContainers)

"InitContainers to be used in the Pod."

fn spec.withInitContainersMixin

withInitContainersMixin(initContainers)

"InitContainers to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.withMyCnf

withMyCnf(myCnf)

"MyCnf allows to specify the my.cnf file mounted by Mariadb.\nUpdating this field will trigger an update to the Mariadb resource."

fn spec.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector to be used in the Pod."

fn spec.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.withPort

withPort(port)

"Port where the instances will be listening for connections."

fn spec.withPriorityClassName

withPriorityClassName(priorityClassName)

"PriorityClassName to be used in the Pod."

fn spec.withReplicas

withReplicas(replicas)

"Replicas indicates the number of desired instances."

fn spec.withReplicasAllowEvenNumber

withReplicasAllowEvenNumber(replicasAllowEvenNumber)

"disables the validation check for an odd number of replicas."

fn spec.withRootEmptyPassword

withRootEmptyPassword(rootEmptyPassword)

"RootEmptyPassword indicates if the root password should be empty. Don't use this feature in production, it is only intended for development and test environments."

fn spec.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName is the name of the ServiceAccount to be used by the Pods."

fn spec.withServicePorts

withServicePorts(servicePorts)

"ServicePorts is the list of additional named ports to be added to the Services created by the operator."

fn spec.withServicePortsMixin

withServicePortsMixin(servicePorts)

"ServicePorts is the list of additional named ports to be added to the Services created by the operator."

Note: This function appends passed data to existing values

fn spec.withSidecarContainers

withSidecarContainers(sidecarContainers)

"SidecarContainers to be used in the Pod."

fn spec.withSidecarContainersMixin

withSidecarContainersMixin(sidecarContainers)

"SidecarContainers to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.withSuspend

withSuspend(suspend)

"Suspend indicates whether the current resource should be suspended or not.\nThis can be useful for maintenance, as disabling the reconciliation prevents the operator from interfering with user operations during maintenance activities."

fn spec.withTimeZone

withTimeZone(timeZone)

"TimeZone sets the default timezone. If not provided, it defaults to SYSTEM and the timezone data is not loaded."

fn spec.withTolerations

withTolerations(tolerations)

"Tolerations to be used in the Pod."

fn spec.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.withTopologySpreadConstraints

withTopologySpreadConstraints(topologySpreadConstraints)

"TopologySpreadConstraints to be used in the Pod."

fn spec.withTopologySpreadConstraintsMixin

withTopologySpreadConstraintsMixin(topologySpreadConstraints)

"TopologySpreadConstraints to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.withUsername

withUsername(username)

"Username is the initial username to be created by the operator once MariaDB is ready.\nThe initial User will have ALL PRIVILEGES in the initial Database."

fn spec.withVolumeMounts

withVolumeMounts(volumeMounts)

"VolumeMounts to be used in the Container."

fn spec.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"VolumeMounts to be used in the Container."

Note: This function appends passed data to existing values

fn spec.withVolumes

withVolumes(volumes)

"Volumes to be used in the Pod."

fn spec.withVolumesMixin

withVolumesMixin(volumes)

"Volumes to be used in the Pod."

Note: This function appends passed data to existing values

obj spec.affinity

"Affinity to be used in the Pod."

fn spec.affinity.withAntiAffinityEnabled

withAntiAffinityEnabled(antiAffinityEnabled)

"AntiAffinityEnabled configures PodAntiAffinity so each Pod is scheduled in a different Node, enabling HA.\nMake sure you have at least as many Nodes available as the replicas to not end up with unscheduled Pods."

obj spec.affinity.nodeAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeaffinity-v1-core"

fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselectorterm-v1-core"

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselector-v1-core"

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podantiaffinity-v1-core."

fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podaffinityterm-v1-core."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom

"BootstrapFrom defines a source to bootstrap from."

fn spec.bootstrapFrom.withBackupContentType

withBackupContentType(backupContentType)

"BackupContentType is the backup content type available in the source to bootstrap from.\nIt is inferred based on the BackupRef and VolumeSnapshotRef fields. If inference is not possible, it defaults to Logical.\nSet this field explicitly when using physical backups from S3 or Volume sources."

fn spec.bootstrapFrom.withTargetRecoveryTime

withTargetRecoveryTime(targetRecoveryTime)

"TargetRecoveryTime is a RFC3339 (1970-01-01T00:00:00Z) date and time that defines the point in time recovery objective.\nIt is used to determine the closest restoration source in time."

obj spec.bootstrapFrom.backupRef

"BackupRef is reference to a backup object. If the Kind is not specified, a logical Backup is assumed.\nThis field takes precedence over S3 and Volume sources."

fn spec.bootstrapFrom.backupRef.withKind

withKind(kind)

"Kind of the referent."

fn spec.bootstrapFrom.backupRef.withName

withName(name)

"Name of the referent."

obj spec.bootstrapFrom.restoreJob

"RestoreJob defines additional properties for the Job used to perform the restoration."

fn spec.bootstrapFrom.restoreJob.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.bootstrapFrom.restoreJob.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.restoreJob.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector to be used in the Pod."

fn spec.bootstrapFrom.restoreJob.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.restoreJob.withTolerations

withTolerations(tolerations)

"Tolerations to be used in the Pod."

fn spec.bootstrapFrom.restoreJob.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations to be used in the Pod."

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity

"Affinity to be used in the Pod."

fn spec.bootstrapFrom.restoreJob.affinity.withAntiAffinityEnabled

withAntiAffinityEnabled(antiAffinityEnabled)

"AntiAffinityEnabled configures PodAntiAffinity so each Pod is scheduled in a different Node, enabling HA.\nMake sure you have at least as many Nodes available as the replicas to not end up with unscheduled Pods."

obj spec.bootstrapFrom.restoreJob.affinity.nodeAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeaffinity-v1-core"

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselectorterm-v1-core"

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselector-v1-core"

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

fn spec.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podantiaffinity-v1-core."

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podaffinityterm-v1-core."

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

obj spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

obj spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.metadata

"Metadata defines additional metadata for the bootstrap Jobs."

fn spec.bootstrapFrom.restoreJob.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.bootstrapFrom.restoreJob.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.restoreJob.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.bootstrapFrom.restoreJob.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.resources

"Resources describes the compute resource requirements."

fn spec.bootstrapFrom.restoreJob.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.bootstrapFrom.restoreJob.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.restoreJob.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.bootstrapFrom.restoreJob.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.restoreJob.tolerations

"Tolerations to be used in the Pod."

fn spec.bootstrapFrom.restoreJob.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.bootstrapFrom.restoreJob.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.bootstrapFrom.restoreJob.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.bootstrapFrom.restoreJob.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.bootstrapFrom.restoreJob.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.bootstrapFrom.s3

"S3 defines the configuration to restore backups from a S3 compatible storage.\nThis field takes precedence over the Volume source."

fn spec.bootstrapFrom.s3.withBucket

withBucket(bucket)

"Bucket is the name Name of the bucket to store backups."

fn spec.bootstrapFrom.s3.withEndpoint

withEndpoint(endpoint)

"Endpoint is the S3 API endpoint without scheme."

fn spec.bootstrapFrom.s3.withPrefix

withPrefix(prefix)

"Prefix indicates a folder/subfolder in the bucket. For example: mariadb/ or mariadb/backups. A trailing slash '/' is added if not provided."

fn spec.bootstrapFrom.s3.withRegion

withRegion(region)

"Region is the S3 region name to use."

obj spec.bootstrapFrom.s3.accessKeyIdSecretKeyRef

"AccessKeyIdSecretKeyRef is a reference to a Secret key containing the S3 access key id."

fn spec.bootstrapFrom.s3.accessKeyIdSecretKeyRef.withKey

withKey(key)

fn spec.bootstrapFrom.s3.accessKeyIdSecretKeyRef.withName

withName(name)

obj spec.bootstrapFrom.s3.secretAccessKeySecretKeyRef

"AccessKeyIdSecretKeyRef is a reference to a Secret key containing the S3 secret key."

fn spec.bootstrapFrom.s3.secretAccessKeySecretKeyRef.withKey

withKey(key)

fn spec.bootstrapFrom.s3.secretAccessKeySecretKeyRef.withName

withName(name)

obj spec.bootstrapFrom.s3.sessionTokenSecretKeyRef

"SessionTokenSecretKeyRef is a reference to a Secret key containing the S3 session token."

fn spec.bootstrapFrom.s3.sessionTokenSecretKeyRef.withKey

withKey(key)

fn spec.bootstrapFrom.s3.sessionTokenSecretKeyRef.withName

withName(name)

obj spec.bootstrapFrom.s3.tls

"TLS provides the configuration required to establish TLS connections with S3."

fn spec.bootstrapFrom.s3.tls.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable TLS."

obj spec.bootstrapFrom.s3.tls.caSecretKeyRef

"CASecretKeyRef is a reference to a Secret key containing a CA bundle in PEM format used to establish TLS connections with S3.\nBy default, the system trust chain will be used, but you can use this field to add more CAs to the bundle."

fn spec.bootstrapFrom.s3.tls.caSecretKeyRef.withKey

withKey(key)

fn spec.bootstrapFrom.s3.tls.caSecretKeyRef.withName

withName(name)

obj spec.bootstrapFrom.stagingStorage

"StagingStorage defines the temporary storage used to keep external backups (i.e. S3) while they are being processed.\nIt defaults to an emptyDir volume, meaning that the backups will be temporarily stored in the node where the Job is scheduled."

obj spec.bootstrapFrom.stagingStorage.persistentVolumeClaim

"PersistentVolumeClaim is a Kubernetes PVC specification."

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.withAccessModes

withAccessModes(accessModes)

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.withAccessModesMixin

withAccessModesMixin(accessModes)

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.withStorageClassName

withStorageClassName(storageClassName)

obj spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.resources

"VolumeResourceRequirements describes the storage resource requirements for a volume."

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector

"A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects."

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.bootstrapFrom.stagingStorage.persistentVolumeClaim.selector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.stagingStorage.volume

"Volume is a Kubernetes volume specification."

obj spec.bootstrapFrom.stagingStorage.volume.csi

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#csivolumesource-v1-core."

fn spec.bootstrapFrom.stagingStorage.volume.csi.withDriver

withDriver(driver)

fn spec.bootstrapFrom.stagingStorage.volume.csi.withFsType

withFsType(fsType)

fn spec.bootstrapFrom.stagingStorage.volume.csi.withReadOnly

withReadOnly(readOnly)

fn spec.bootstrapFrom.stagingStorage.volume.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

fn spec.bootstrapFrom.stagingStorage.volume.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.stagingStorage.volume.csi.nodePublishSecretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.bootstrapFrom.stagingStorage.volume.csi.nodePublishSecretRef.withName

withName(name)

obj spec.bootstrapFrom.stagingStorage.volume.emptyDir

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#emptydirvolumesource-v1-core."

fn spec.bootstrapFrom.stagingStorage.volume.emptyDir.withMedium

withMedium(medium)

"StorageMedium defines ways that storage can be allocated to a volume."

fn spec.bootstrapFrom.stagingStorage.volume.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

obj spec.bootstrapFrom.stagingStorage.volume.hostPath

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#hostpathvolumesource-v1-core"

fn spec.bootstrapFrom.stagingStorage.volume.hostPath.withPath

withPath(path)

fn spec.bootstrapFrom.stagingStorage.volume.hostPath.withType

withType(type)

obj spec.bootstrapFrom.stagingStorage.volume.nfs

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nfsvolumesource-v1-core."

fn spec.bootstrapFrom.stagingStorage.volume.nfs.withPath

withPath(path)

fn spec.bootstrapFrom.stagingStorage.volume.nfs.withReadOnly

withReadOnly(readOnly)

fn spec.bootstrapFrom.stagingStorage.volume.nfs.withServer

withServer(server)

obj spec.bootstrapFrom.stagingStorage.volume.persistentVolumeClaim

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#persistentvolumeclaimvolumesource-v1-core."

fn spec.bootstrapFrom.stagingStorage.volume.persistentVolumeClaim.withClaimName

withClaimName(claimName)

fn spec.bootstrapFrom.stagingStorage.volume.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

obj spec.bootstrapFrom.volume

"Volume is a Kubernetes Volume object that contains a backup."

obj spec.bootstrapFrom.volume.csi

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#csivolumesource-v1-core."

fn spec.bootstrapFrom.volume.csi.withDriver

withDriver(driver)

fn spec.bootstrapFrom.volume.csi.withFsType

withFsType(fsType)

fn spec.bootstrapFrom.volume.csi.withReadOnly

withReadOnly(readOnly)

fn spec.bootstrapFrom.volume.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

fn spec.bootstrapFrom.volume.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

Note: This function appends passed data to existing values

obj spec.bootstrapFrom.volume.csi.nodePublishSecretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.bootstrapFrom.volume.csi.nodePublishSecretRef.withName

withName(name)

obj spec.bootstrapFrom.volume.emptyDir

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#emptydirvolumesource-v1-core."

fn spec.bootstrapFrom.volume.emptyDir.withMedium

withMedium(medium)

"StorageMedium defines ways that storage can be allocated to a volume."

fn spec.bootstrapFrom.volume.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

obj spec.bootstrapFrom.volume.hostPath

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#hostpathvolumesource-v1-core"

fn spec.bootstrapFrom.volume.hostPath.withPath

withPath(path)

fn spec.bootstrapFrom.volume.hostPath.withType

withType(type)

obj spec.bootstrapFrom.volume.nfs

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nfsvolumesource-v1-core."

fn spec.bootstrapFrom.volume.nfs.withPath

withPath(path)

fn spec.bootstrapFrom.volume.nfs.withReadOnly

withReadOnly(readOnly)

fn spec.bootstrapFrom.volume.nfs.withServer

withServer(server)

obj spec.bootstrapFrom.volume.persistentVolumeClaim

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#persistentvolumeclaimvolumesource-v1-core."

fn spec.bootstrapFrom.volume.persistentVolumeClaim.withClaimName

withClaimName(claimName)

fn spec.bootstrapFrom.volume.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

obj spec.bootstrapFrom.volumeSnapshotRef

"VolumeSnapshotRef is a reference to a VolumeSnapshot object.\nThis field takes precedence over S3 and Volume sources."

fn spec.bootstrapFrom.volumeSnapshotRef.withName

withName(name)

obj spec.connection

"Connection defines a template to configure the general Connection object.\nThis Connection provides the initial User access to the initial Database.\nIt will make use of the Service to route network traffic to all Pods."

fn spec.connection.withParams

withParams(params)

"Params to be used in the Connection."

fn spec.connection.withParamsMixin

withParamsMixin(params)

"Params to be used in the Connection."

Note: This function appends passed data to existing values

fn spec.connection.withPort

withPort(port)

"Port to connect to. If not provided, it defaults to the MariaDB port or to the first MaxScale listener."

fn spec.connection.withSecretName

withSecretName(secretName)

"SecretName to be used in the Connection."

fn spec.connection.withServiceName

withServiceName(serviceName)

"ServiceName to be used in the Connection."

obj spec.connection.healthCheck

"HealthCheck to be used in the Connection."

fn spec.connection.healthCheck.withInterval

withInterval(interval)

"Interval used to perform health checks."

fn spec.connection.healthCheck.withRetryInterval

withRetryInterval(retryInterval)

"RetryInterval is the interval used to perform health check retries."

obj spec.connection.secretTemplate

"SecretTemplate to be used in the Connection."

fn spec.connection.secretTemplate.withDatabaseKey

withDatabaseKey(databaseKey)

"DatabaseKey to be used in the Secret."

fn spec.connection.secretTemplate.withFormat

withFormat(format)

"Format to be used in the Secret."

fn spec.connection.secretTemplate.withHostKey

withHostKey(hostKey)

"HostKey to be used in the Secret."

fn spec.connection.secretTemplate.withKey

withKey(key)

"Key to be used in the Secret."

fn spec.connection.secretTemplate.withPasswordKey

withPasswordKey(passwordKey)

"PasswordKey to be used in the Secret."

fn spec.connection.secretTemplate.withPortKey

withPortKey(portKey)

"PortKey to be used in the Secret."

fn spec.connection.secretTemplate.withUsernameKey

withUsernameKey(usernameKey)

"UsernameKey to be used in the Secret."

obj spec.connection.secretTemplate.metadata

"Metadata to be added to the Secret object."

fn spec.connection.secretTemplate.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.connection.secretTemplate.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.connection.secretTemplate.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.connection.secretTemplate.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.env

"Env represents the environment variables to be injected in a container."

fn spec.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.env.withValue

withValue(value)

obj spec.env.valueFrom

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#envvarsource-v1-core."

obj spec.env.valueFrom.configMapKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#configmapkeyselector-v1-core."

fn spec.env.valueFrom.configMapKeyRef.withKey

withKey(key)

fn spec.env.valueFrom.configMapKeyRef.withName

withName(name)

obj spec.env.valueFrom.fieldRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectfieldselector-v1-core."

fn spec.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

fn spec.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

obj spec.env.valueFrom.secretKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#secretkeyselector-v1-core."

fn spec.env.valueFrom.secretKeyRef.withKey

withKey(key)

fn spec.env.valueFrom.secretKeyRef.withName

withName(name)

obj spec.envFrom

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.envFrom.withPrefix

withPrefix(prefix)

obj spec.envFrom.configMapRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.envFrom.configMapRef.withName

withName(name)

obj spec.envFrom.secretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.envFrom.secretRef.withName

withName(name)

obj spec.galera

"Replication configures high availability via Galera."

fn spec.galera.withAvailableWhenDonor

withAvailableWhenDonor(availableWhenDonor)

"AvailableWhenDonor indicates whether a donor node should be responding to queries. It defaults to false."

fn spec.galera.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable Galera."

fn spec.galera.withGaleraLibPath

withGaleraLibPath(galeraLibPath)

"GaleraLibPath is a path inside the MariaDB image to the wsrep provider plugin. It is defaulted if not provided.\nMore info: https://galeracluster.com/library/documentation/mysql-wsrep-options.html#wsrep-provider."

fn spec.galera.withProviderOptions

withProviderOptions(providerOptions)

"ProviderOptions is map of Galera configuration parameters.\nMore info: https://mariadb.com/kb/en/galera-cluster-system-variables/#wsrep_provider_options."

fn spec.galera.withProviderOptionsMixin

withProviderOptionsMixin(providerOptions)

"ProviderOptions is map of Galera configuration parameters.\nMore info: https://mariadb.com/kb/en/galera-cluster-system-variables/#wsrep_provider_options."

Note: This function appends passed data to existing values

fn spec.galera.withReplicaThreads

withReplicaThreads(replicaThreads)

"ReplicaThreads is the number of replica threads used to apply Galera write sets in parallel.\nMore info: https://mariadb.com/kb/en/galera-cluster-system-variables/#wsrep_slave_threads."

fn spec.galera.withSst

withSst(sst)

"SST is the Snapshot State Transfer used when new Pods join the cluster.\nMore info: https://galeracluster.com/library/documentation/sst.html."

obj spec.galera.agent

"Agent is a sidecar agent that co-operates with mariadb-operator."

fn spec.galera.agent.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.galera.agent.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.galera.agent.withCommand

withCommand(command)

"Command to be used in the Container."

fn spec.galera.agent.withCommandMixin

withCommandMixin(command)

"Command to be used in the Container."

Note: This function appends passed data to existing values

fn spec.galera.agent.withEnv

withEnv(env)

"Env represents the environment variables to be injected in a container."

fn spec.galera.agent.withEnvFrom

withEnvFrom(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.galera.agent.withEnvFromMixin

withEnvFromMixin(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

Note: This function appends passed data to existing values

fn spec.galera.agent.withEnvMixin

withEnvMixin(env)

"Env represents the environment variables to be injected in a container."

Note: This function appends passed data to existing values

fn spec.galera.agent.withGracefulShutdownTimeout

withGracefulShutdownTimeout(gracefulShutdownTimeout)

"GracefulShutdownTimeout is the time we give to the agent container in order to gracefully terminate in-flight requests."

fn spec.galera.agent.withImage

withImage(image)

"Image name to be used by the MariaDB instances. The supported format is <image>:<tag>."

fn spec.galera.agent.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.galera.agent.withPort

withPort(port)

"Port where the agent will be listening for API connections."

fn spec.galera.agent.withProbePort

withProbePort(probePort)

"Port where the agent will be listening for probe connections."

fn spec.galera.agent.withVolumeMounts

withVolumeMounts(volumeMounts)

"VolumeMounts to be used in the Container."

fn spec.galera.agent.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"VolumeMounts to be used in the Container."

Note: This function appends passed data to existing values

obj spec.galera.agent.basicAuth

"BasicAuth to be used by the agent container"

fn spec.galera.agent.basicAuth.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable BasicAuth"

fn spec.galera.agent.basicAuth.withUsername

withUsername(username)

"Username to be used for basic authentication"

obj spec.galera.agent.basicAuth.passwordSecretKeyRef

"PasswordSecretKeyRef to be used for basic authentication"

fn spec.galera.agent.basicAuth.passwordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.galera.agent.basicAuth.passwordSecretKeyRef.withKey

withKey(key)

fn spec.galera.agent.basicAuth.passwordSecretKeyRef.withName

withName(name)

obj spec.galera.agent.env

"Env represents the environment variables to be injected in a container."

fn spec.galera.agent.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.galera.agent.env.withValue

withValue(value)

obj spec.galera.agent.env.valueFrom

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#envvarsource-v1-core."

obj spec.galera.agent.env.valueFrom.configMapKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#configmapkeyselector-v1-core."

fn spec.galera.agent.env.valueFrom.configMapKeyRef.withKey

withKey(key)

fn spec.galera.agent.env.valueFrom.configMapKeyRef.withName

withName(name)

obj spec.galera.agent.env.valueFrom.fieldRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectfieldselector-v1-core."

fn spec.galera.agent.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

fn spec.galera.agent.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

obj spec.galera.agent.env.valueFrom.secretKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#secretkeyselector-v1-core."

fn spec.galera.agent.env.valueFrom.secretKeyRef.withKey

withKey(key)

fn spec.galera.agent.env.valueFrom.secretKeyRef.withName

withName(name)

obj spec.galera.agent.envFrom

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.galera.agent.envFrom.withPrefix

withPrefix(prefix)

obj spec.galera.agent.envFrom.configMapRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.galera.agent.envFrom.configMapRef.withName

withName(name)

obj spec.galera.agent.envFrom.secretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.galera.agent.envFrom.secretRef.withName

withName(name)

obj spec.galera.agent.kubernetesAuth

"KubernetesAuth to be used by the agent container"

fn spec.galera.agent.kubernetesAuth.withAuthDelegatorRoleName

withAuthDelegatorRoleName(authDelegatorRoleName)

"AuthDelegatorRoleName is the name of the ClusterRoleBinding that is associated with the \"system:auth-delegator\" ClusterRole.\nIt is necessary for creating TokenReview objects in order for the agent to validate the service account token."

fn spec.galera.agent.kubernetesAuth.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable KubernetesAuth"

obj spec.galera.agent.livenessProbe

"LivenessProbe to be used in the Container."

fn spec.galera.agent.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.galera.agent.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.galera.agent.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.galera.agent.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.galera.agent.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.galera.agent.livenessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.galera.agent.livenessProbe.exec.withCommand

withCommand(command)

fn spec.galera.agent.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.galera.agent.livenessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.galera.agent.livenessProbe.httpGet.withHost

withHost(host)

fn spec.galera.agent.livenessProbe.httpGet.withPath

withPath(path)

fn spec.galera.agent.livenessProbe.httpGet.withPort

withPort(port)

fn spec.galera.agent.livenessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.galera.agent.livenessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.galera.agent.livenessProbe.tcpSocket.withHost

withHost(host)

fn spec.galera.agent.livenessProbe.tcpSocket.withPort

withPort(port)

obj spec.galera.agent.readinessProbe

"ReadinessProbe to be used in the Container."

fn spec.galera.agent.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.galera.agent.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.galera.agent.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.galera.agent.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.galera.agent.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.galera.agent.readinessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.galera.agent.readinessProbe.exec.withCommand

withCommand(command)

fn spec.galera.agent.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.galera.agent.readinessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.galera.agent.readinessProbe.httpGet.withHost

withHost(host)

fn spec.galera.agent.readinessProbe.httpGet.withPath

withPath(path)

fn spec.galera.agent.readinessProbe.httpGet.withPort

withPort(port)

fn spec.galera.agent.readinessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.galera.agent.readinessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.galera.agent.readinessProbe.tcpSocket.withHost

withHost(host)

fn spec.galera.agent.readinessProbe.tcpSocket.withPort

withPort(port)

obj spec.galera.agent.resources

"Resources describes the compute resource requirements."

fn spec.galera.agent.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.galera.agent.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.galera.agent.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.galera.agent.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.galera.agent.securityContext

"SecurityContext holds security configuration that will be applied to a container."

fn spec.galera.agent.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

fn spec.galera.agent.securityContext.withPrivileged

withPrivileged(privileged)

fn spec.galera.agent.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

fn spec.galera.agent.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.galera.agent.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.galera.agent.securityContext.withRunAsUser

withRunAsUser(runAsUser)

obj spec.galera.agent.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn spec.galera.agent.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.galera.agent.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.galera.agent.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.galera.agent.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.galera.agent.startupProbe

"StartupProbe to be used in the Container."

fn spec.galera.agent.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.galera.agent.startupProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.galera.agent.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.galera.agent.startupProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.galera.agent.startupProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.galera.agent.startupProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.galera.agent.startupProbe.exec.withCommand

withCommand(command)

fn spec.galera.agent.startupProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.galera.agent.startupProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.galera.agent.startupProbe.httpGet.withHost

withHost(host)

fn spec.galera.agent.startupProbe.httpGet.withPath

withPath(path)

fn spec.galera.agent.startupProbe.httpGet.withPort

withPort(port)

fn spec.galera.agent.startupProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.galera.agent.startupProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.galera.agent.startupProbe.tcpSocket.withHost

withHost(host)

fn spec.galera.agent.startupProbe.tcpSocket.withPort

withPort(port)

obj spec.galera.agent.volumeMounts

"VolumeMounts to be used in the Container."

fn spec.galera.agent.volumeMounts.withMountPath

withMountPath(mountPath)

fn spec.galera.agent.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.galera.agent.volumeMounts.withReadOnly

withReadOnly(readOnly)

fn spec.galera.agent.volumeMounts.withSubPath

withSubPath(subPath)

obj spec.galera.config

"GaleraConfig defines storage options for the Galera configuration files."

fn spec.galera.config.withReuseStorageVolume

withReuseStorageVolume(reuseStorageVolume)

"ReuseStorageVolume indicates that storage volume used by MariaDB should be reused to store the Galera configuration files.\nIt defaults to false, which implies that a dedicated volume for the Galera configuration files is provisioned."

obj spec.galera.config.volumeClaimTemplate

"VolumeClaimTemplate is a template for the PVC that will contain the Galera configuration files shared between the InitContainer, Agent and MariaDB."

fn spec.galera.config.volumeClaimTemplate.withAccessModes

withAccessModes(accessModes)

fn spec.galera.config.volumeClaimTemplate.withAccessModesMixin

withAccessModesMixin(accessModes)

Note: This function appends passed data to existing values

fn spec.galera.config.volumeClaimTemplate.withStorageClassName

withStorageClassName(storageClassName)

obj spec.galera.config.volumeClaimTemplate.metadata

"Metadata to be added to the PVC metadata."

fn spec.galera.config.volumeClaimTemplate.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.galera.config.volumeClaimTemplate.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.galera.config.volumeClaimTemplate.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.galera.config.volumeClaimTemplate.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.galera.config.volumeClaimTemplate.resources

"VolumeResourceRequirements describes the storage resource requirements for a volume."

fn spec.galera.config.volumeClaimTemplate.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.galera.config.volumeClaimTemplate.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.galera.config.volumeClaimTemplate.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.galera.config.volumeClaimTemplate.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

obj spec.galera.config.volumeClaimTemplate.selector

"A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects."

fn spec.galera.config.volumeClaimTemplate.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.galera.config.volumeClaimTemplate.selector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.galera.config.volumeClaimTemplate.selector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.galera.config.volumeClaimTemplate.selector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.galera.config.volumeClaimTemplate.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.galera.config.volumeClaimTemplate.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.galera.config.volumeClaimTemplate.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.galera.config.volumeClaimTemplate.selector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.galera.config.volumeClaimTemplate.selector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.galera.initContainer

"InitContainer is an init container that runs in the MariaDB Pod and co-operates with mariadb-operator."

fn spec.galera.initContainer.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.galera.initContainer.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.galera.initContainer.withCommand

withCommand(command)

"Command to be used in the Container."

fn spec.galera.initContainer.withCommandMixin

withCommandMixin(command)

"Command to be used in the Container."

Note: This function appends passed data to existing values

fn spec.galera.initContainer.withEnv

withEnv(env)

"Env represents the environment variables to be injected in a container."

fn spec.galera.initContainer.withEnvFrom

withEnvFrom(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.galera.initContainer.withEnvFromMixin

withEnvFromMixin(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

Note: This function appends passed data to existing values

fn spec.galera.initContainer.withEnvMixin

withEnvMixin(env)

"Env represents the environment variables to be injected in a container."

Note: This function appends passed data to existing values

fn spec.galera.initContainer.withImage

withImage(image)

"Image name to be used by the MariaDB instances. The supported format is <image>:<tag>."

fn spec.galera.initContainer.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.galera.initContainer.withVolumeMounts

withVolumeMounts(volumeMounts)

"VolumeMounts to be used in the Container."

fn spec.galera.initContainer.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"VolumeMounts to be used in the Container."

Note: This function appends passed data to existing values

obj spec.galera.initContainer.env

"Env represents the environment variables to be injected in a container."

fn spec.galera.initContainer.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.galera.initContainer.env.withValue

withValue(value)

obj spec.galera.initContainer.env.valueFrom

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#envvarsource-v1-core."

obj spec.galera.initContainer.env.valueFrom.configMapKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#configmapkeyselector-v1-core."

fn spec.galera.initContainer.env.valueFrom.configMapKeyRef.withKey

withKey(key)

fn spec.galera.initContainer.env.valueFrom.configMapKeyRef.withName

withName(name)

obj spec.galera.initContainer.env.valueFrom.fieldRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectfieldselector-v1-core."

fn spec.galera.initContainer.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

fn spec.galera.initContainer.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

obj spec.galera.initContainer.env.valueFrom.secretKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#secretkeyselector-v1-core."

fn spec.galera.initContainer.env.valueFrom.secretKeyRef.withKey

withKey(key)

fn spec.galera.initContainer.env.valueFrom.secretKeyRef.withName

withName(name)

obj spec.galera.initContainer.envFrom

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.galera.initContainer.envFrom.withPrefix

withPrefix(prefix)

obj spec.galera.initContainer.envFrom.configMapRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.galera.initContainer.envFrom.configMapRef.withName

withName(name)

obj spec.galera.initContainer.envFrom.secretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.galera.initContainer.envFrom.secretRef.withName

withName(name)

obj spec.galera.initContainer.livenessProbe

"LivenessProbe to be used in the Container."

fn spec.galera.initContainer.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.galera.initContainer.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.galera.initContainer.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.galera.initContainer.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.galera.initContainer.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.galera.initContainer.livenessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.galera.initContainer.livenessProbe.exec.withCommand

withCommand(command)

fn spec.galera.initContainer.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.galera.initContainer.livenessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.galera.initContainer.livenessProbe.httpGet.withHost

withHost(host)

fn spec.galera.initContainer.livenessProbe.httpGet.withPath

withPath(path)

fn spec.galera.initContainer.livenessProbe.httpGet.withPort

withPort(port)

fn spec.galera.initContainer.livenessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.galera.initContainer.livenessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.galera.initContainer.livenessProbe.tcpSocket.withHost

withHost(host)

fn spec.galera.initContainer.livenessProbe.tcpSocket.withPort

withPort(port)

obj spec.galera.initContainer.readinessProbe

"ReadinessProbe to be used in the Container."

fn spec.galera.initContainer.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.galera.initContainer.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.galera.initContainer.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.galera.initContainer.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.galera.initContainer.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.galera.initContainer.readinessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.galera.initContainer.readinessProbe.exec.withCommand

withCommand(command)

fn spec.galera.initContainer.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.galera.initContainer.readinessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.galera.initContainer.readinessProbe.httpGet.withHost

withHost(host)

fn spec.galera.initContainer.readinessProbe.httpGet.withPath

withPath(path)

fn spec.galera.initContainer.readinessProbe.httpGet.withPort

withPort(port)

fn spec.galera.initContainer.readinessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.galera.initContainer.readinessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.galera.initContainer.readinessProbe.tcpSocket.withHost

withHost(host)

fn spec.galera.initContainer.readinessProbe.tcpSocket.withPort

withPort(port)

obj spec.galera.initContainer.resources

"Resources describes the compute resource requirements."

fn spec.galera.initContainer.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.galera.initContainer.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.galera.initContainer.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.galera.initContainer.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.galera.initContainer.securityContext

"SecurityContext holds security configuration that will be applied to a container."

fn spec.galera.initContainer.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

fn spec.galera.initContainer.securityContext.withPrivileged

withPrivileged(privileged)

fn spec.galera.initContainer.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

fn spec.galera.initContainer.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.galera.initContainer.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.galera.initContainer.securityContext.withRunAsUser

withRunAsUser(runAsUser)

obj spec.galera.initContainer.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn spec.galera.initContainer.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.galera.initContainer.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.galera.initContainer.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.galera.initContainer.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.galera.initContainer.startupProbe

"StartupProbe to be used in the Container."

fn spec.galera.initContainer.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.galera.initContainer.startupProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.galera.initContainer.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.galera.initContainer.startupProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.galera.initContainer.startupProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.galera.initContainer.startupProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.galera.initContainer.startupProbe.exec.withCommand

withCommand(command)

fn spec.galera.initContainer.startupProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.galera.initContainer.startupProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.galera.initContainer.startupProbe.httpGet.withHost

withHost(host)

fn spec.galera.initContainer.startupProbe.httpGet.withPath

withPath(path)

fn spec.galera.initContainer.startupProbe.httpGet.withPort

withPort(port)

fn spec.galera.initContainer.startupProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.galera.initContainer.startupProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.galera.initContainer.startupProbe.tcpSocket.withHost

withHost(host)

fn spec.galera.initContainer.startupProbe.tcpSocket.withPort

withPort(port)

obj spec.galera.initContainer.volumeMounts

"VolumeMounts to be used in the Container."

fn spec.galera.initContainer.volumeMounts.withMountPath

withMountPath(mountPath)

fn spec.galera.initContainer.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.galera.initContainer.volumeMounts.withReadOnly

withReadOnly(readOnly)

fn spec.galera.initContainer.volumeMounts.withSubPath

withSubPath(subPath)

obj spec.galera.initJob

"InitJob defines a Job that co-operates with mariadb-operator by performing initialization tasks."

obj spec.galera.initJob.metadata

"Metadata defines additional metadata for the Galera init Job."

fn spec.galera.initJob.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.galera.initJob.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.galera.initJob.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.galera.initJob.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.galera.initJob.resources

"Resources describes the compute resource requirements."

fn spec.galera.initJob.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.galera.initJob.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.galera.initJob.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.galera.initJob.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.galera.primary

"Primary is the Galera configuration for the primary node."

fn spec.galera.primary.withAutoFailover

withAutoFailover(autoFailover)

"AutoFailover indicates whether the operator should automatically update PodIndex to perform an automatic primary failover."

fn spec.galera.primary.withPodIndex

withPodIndex(podIndex)

"PodIndex is the StatefulSet index of the primary node. The user may change this field to perform a manual switchover."

obj spec.galera.recovery

"GaleraRecovery is the recovery process performed by the operator whenever the Galera cluster is not healthy.\nMore info: https://galeracluster.com/library/documentation/crash-recovery.html."

fn spec.galera.recovery.withClusterBootstrapTimeout

withClusterBootstrapTimeout(clusterBootstrapTimeout)

"ClusterBootstrapTimeout is the time limit for bootstrapping a cluster.\nOnce this timeout is reached, the Galera recovery state is reset and a new cluster bootstrap will be attempted."

fn spec.galera.recovery.withClusterDownscaleTimeout

withClusterDownscaleTimeout(clusterDownscaleTimeout)

"ClusterDownscaleTimeout represents the maximum duration for downscaling the cluster's StatefulSet during the recovery process."

fn spec.galera.recovery.withClusterHealthyTimeout

withClusterHealthyTimeout(clusterHealthyTimeout)

"ClusterHealthyTimeout represents the duration at which a Galera cluster, that consistently failed health checks,\nis considered unhealthy, and consequently the Galera recovery process will be initiated by the operator."

fn spec.galera.recovery.withClusterMonitorInterval

withClusterMonitorInterval(clusterMonitorInterval)

"ClusterMonitorInterval represents the interval used to monitor the Galera cluster health."

fn spec.galera.recovery.withClusterUpscaleTimeout

withClusterUpscaleTimeout(clusterUpscaleTimeout)

"ClusterUpscaleTimeout represents the maximum duration for upscaling the cluster's StatefulSet during the recovery process."

fn spec.galera.recovery.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable GaleraRecovery."

fn spec.galera.recovery.withForceClusterBootstrapInPod

withForceClusterBootstrapInPod(forceClusterBootstrapInPod)

"ForceClusterBootstrapInPod allows you to manually initiate the bootstrap process in a specific Pod.\nIMPORTANT: Use this option only in exceptional circumstances. Not selecting the Pod with the highest sequence number may result in data loss.\nIMPORTANT: Ensure you unset this field after completing the bootstrap to allow the operator to choose the appropriate Pod to bootstrap from in an event of cluster recovery."

fn spec.galera.recovery.withMinClusterSize

withMinClusterSize(minClusterSize)

"MinClusterSize is the minimum number of replicas to consider the cluster healthy. It can be either a number of replicas (1) or a percentage (50%).\nIf Galera consistently reports less replicas than this value for the given 'ClusterHealthyTimeout' interval, a cluster recovery is iniated.\nIt defaults to '1' replica, and it is highly recommendeded to keep this value at '1' in most cases.\nIf set to more than one replica, the cluster recovery process may restart the healthy replicas as well."

fn spec.galera.recovery.withPodRecoveryTimeout

withPodRecoveryTimeout(podRecoveryTimeout)

"PodRecoveryTimeout is the time limit for recevorying the sequence of a Pod during the cluster recovery."

fn spec.galera.recovery.withPodSyncTimeout

withPodSyncTimeout(podSyncTimeout)

"PodSyncTimeout is the time limit for a Pod to join the cluster after having performed a cluster bootstrap during the cluster recovery."

obj spec.galera.recovery.job

"Job defines a Job that co-operates with mariadb-operator by performing the Galera cluster recovery ."

fn spec.galera.recovery.job.withPodAffinity

withPodAffinity(podAffinity)

"PodAffinity indicates whether the recovery Jobs should run in the same Node as the MariaDB Pods. It defaults to true."

obj spec.galera.recovery.job.metadata

"Metadata defines additional metadata for the Galera recovery Jobs."

fn spec.galera.recovery.job.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.galera.recovery.job.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.galera.recovery.job.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.galera.recovery.job.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.galera.recovery.job.resources

"Resources describes the compute resource requirements."

fn spec.galera.recovery.job.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.galera.recovery.job.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.galera.recovery.job.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.galera.recovery.job.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.imagePullSecrets

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

fn spec.imagePullSecrets.withName

withName(name)

obj spec.inheritMetadata

"InheritMetadata defines the metadata to be inherited by children resources."

fn spec.inheritMetadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.inheritMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.inheritMetadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.inheritMetadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.initContainers

"InitContainers to be used in the Pod."

fn spec.initContainers.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.initContainers.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.initContainers.withCommand

withCommand(command)

"Command to be used in the Container."

fn spec.initContainers.withCommandMixin

withCommandMixin(command)

"Command to be used in the Container."

Note: This function appends passed data to existing values

fn spec.initContainers.withEnv

withEnv(env)

"Env represents the environment variables to be injected in a container."

fn spec.initContainers.withEnvMixin

withEnvMixin(env)

"Env represents the environment variables to be injected in a container."

Note: This function appends passed data to existing values

fn spec.initContainers.withImage

withImage(image)

"Image name to be used by the container. The supported format is <image>:<tag>."

fn spec.initContainers.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.initContainers.withName

withName(name)

"Name to be given to the container."

fn spec.initContainers.withVolumeMounts

withVolumeMounts(volumeMounts)

"VolumeMounts to be used in the Container."

fn spec.initContainers.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"VolumeMounts to be used in the Container."

Note: This function appends passed data to existing values

obj spec.initContainers.env

"Env represents the environment variables to be injected in a container."

fn spec.initContainers.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.initContainers.env.withValue

withValue(value)

obj spec.initContainers.env.valueFrom

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#envvarsource-v1-core."

obj spec.initContainers.env.valueFrom.configMapKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#configmapkeyselector-v1-core."

fn spec.initContainers.env.valueFrom.configMapKeyRef.withKey

withKey(key)

fn spec.initContainers.env.valueFrom.configMapKeyRef.withName

withName(name)

obj spec.initContainers.env.valueFrom.fieldRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectfieldselector-v1-core."

fn spec.initContainers.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

fn spec.initContainers.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

obj spec.initContainers.env.valueFrom.secretKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#secretkeyselector-v1-core."

fn spec.initContainers.env.valueFrom.secretKeyRef.withKey

withKey(key)

fn spec.initContainers.env.valueFrom.secretKeyRef.withName

withName(name)

obj spec.initContainers.resources

"Resources describes the compute resource requirements."

fn spec.initContainers.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.initContainers.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.initContainers.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.initContainers.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.initContainers.volumeMounts

"VolumeMounts to be used in the Container."

fn spec.initContainers.volumeMounts.withMountPath

withMountPath(mountPath)

fn spec.initContainers.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.initContainers.volumeMounts.withReadOnly

withReadOnly(readOnly)

fn spec.initContainers.volumeMounts.withSubPath

withSubPath(subPath)

obj spec.livenessProbe

"LivenessProbe to be used in the Container."

fn spec.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.livenessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.livenessProbe.exec.withCommand

withCommand(command)

fn spec.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.livenessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.livenessProbe.httpGet.withHost

withHost(host)

fn spec.livenessProbe.httpGet.withPath

withPath(path)

fn spec.livenessProbe.httpGet.withPort

withPort(port)

fn spec.livenessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.livenessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.livenessProbe.tcpSocket.withHost

withHost(host)

fn spec.livenessProbe.tcpSocket.withPort

withPort(port)

obj spec.maxScale

"MaxScale is the MaxScale specification that defines the MaxScale resource to be used with the current MariaDB.\nWhen enabling this field, MaxScaleRef is automatically set."

fn spec.maxScale.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable a MaxScale instance to be used with the current MariaDB."

fn spec.maxScale.withImage

withImage(image)

"Image name to be used by the MaxScale instances. The supported format is <image>:<tag>.\nOnly MariaDB official images are supported."

fn spec.maxScale.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.maxScale.withReplicas

withReplicas(replicas)

"Replicas indicates the number of desired instances."

fn spec.maxScale.withRequeueInterval

withRequeueInterval(requeueInterval)

"RequeueInterval is used to perform requeue reconciliations."

fn spec.maxScale.withServices

withServices(services)

"Services define how the traffic is forwarded to the MariaDB servers."

fn spec.maxScale.withServicesMixin

withServicesMixin(services)

"Services define how the traffic is forwarded to the MariaDB servers."

Note: This function appends passed data to existing values

obj spec.maxScale.admin

"Admin configures the admin REST API and GUI."

fn spec.maxScale.admin.withGuiEnabled

withGuiEnabled(guiEnabled)

"GuiEnabled indicates whether the admin GUI should be enabled."

fn spec.maxScale.admin.withPort

withPort(port)

"Port where the admin REST API and GUI will be exposed."

obj spec.maxScale.auth

"Auth defines the credentials required for MaxScale to connect to MariaDB."

fn spec.maxScale.auth.withAdminUsername

withAdminUsername(adminUsername)

"AdminUsername is an admin username to call the admin REST API. It is defaulted if not provided."

fn spec.maxScale.auth.withClientMaxConnections

withClientMaxConnections(clientMaxConnections)

"ClientMaxConnections defines the maximum number of connections that the client can establish.\nIf HA is enabled, make sure to increase this value, as more MaxScale replicas implies more connections.\nIt defaults to 30 times the number of MaxScale replicas."

fn spec.maxScale.auth.withClientUsername

withClientUsername(clientUsername)

"ClientUsername is the user to connect to MaxScale. It is defaulted if not provided."

fn spec.maxScale.auth.withDeleteDefaultAdmin

withDeleteDefaultAdmin(deleteDefaultAdmin)

"DeleteDefaultAdmin determines whether the default admin user should be deleted after the initial configuration. If not provided, it defaults to true."

fn spec.maxScale.auth.withGenerate

withGenerate(generate)

"Generate defies whether the operator should generate users and grants for MaxScale to work.\nIt only supports MariaDBs specified via spec.mariaDbRef."

fn spec.maxScale.auth.withMetricsUsername

withMetricsUsername(metricsUsername)

"MetricsUsername is an metrics username to call the REST API. It is defaulted if metrics are enabled."

fn spec.maxScale.auth.withMonitorMaxConnections

withMonitorMaxConnections(monitorMaxConnections)

"MonitorMaxConnections defines the maximum number of connections that the monitor can establish.\nIf HA is enabled, make sure to increase this value, as more MaxScale replicas implies more connections.\nIt defaults to 30 times the number of MaxScale replicas."

fn spec.maxScale.auth.withMonitorUsername

withMonitorUsername(monitorUsername)

"MonitorUsername is the user used by MaxScale monitor to connect to MariaDB server. It is defaulted if not provided."

fn spec.maxScale.auth.withServerMaxConnections

withServerMaxConnections(serverMaxConnections)

"ServerMaxConnections defines the maximum number of connections that the server can establish.\nIf HA is enabled, make sure to increase this value, as more MaxScale replicas implies more connections.\nIt defaults to 30 times the number of MaxScale replicas."

fn spec.maxScale.auth.withServerUsername

withServerUsername(serverUsername)

"ServerUsername is the user used by MaxScale to connect to MariaDB server. It is defaulted if not provided."

fn spec.maxScale.auth.withSyncMaxConnections

withSyncMaxConnections(syncMaxConnections)

"SyncMaxConnections defines the maximum number of connections that the sync can establish.\nIf HA is enabled, make sure to increase this value, as more MaxScale replicas implies more connections.\nIt defaults to 30 times the number of MaxScale replicas."

fn spec.maxScale.auth.withSyncUsername

withSyncUsername(syncUsername)

"MonitoSyncUsernamerUsername is the user used by MaxScale config sync to connect to MariaDB server. It is defaulted when HA is enabled."

obj spec.maxScale.auth.adminPasswordSecretKeyRef

"AdminPasswordSecretKeyRef is Secret key reference to the admin password to call the admin REST API. It is defaulted if not provided."

fn spec.maxScale.auth.adminPasswordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.maxScale.auth.adminPasswordSecretKeyRef.withKey

withKey(key)

fn spec.maxScale.auth.adminPasswordSecretKeyRef.withName

withName(name)

obj spec.maxScale.auth.clientPasswordSecretKeyRef

"ClientPasswordSecretKeyRef is Secret key reference to the password to connect to MaxScale. It is defaulted if not provided.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the password."

fn spec.maxScale.auth.clientPasswordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.maxScale.auth.clientPasswordSecretKeyRef.withKey

withKey(key)

fn spec.maxScale.auth.clientPasswordSecretKeyRef.withName

withName(name)

obj spec.maxScale.auth.metricsPasswordSecretKeyRef

"MetricsPasswordSecretKeyRef is Secret key reference to the metrics password to call the admib REST API. It is defaulted if metrics are enabled."

fn spec.maxScale.auth.metricsPasswordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.maxScale.auth.metricsPasswordSecretKeyRef.withKey

withKey(key)

fn spec.maxScale.auth.metricsPasswordSecretKeyRef.withName

withName(name)

obj spec.maxScale.auth.monitorPasswordSecretKeyRef

"MonitorPasswordSecretKeyRef is Secret key reference to the password used by MaxScale monitor to connect to MariaDB server. It is defaulted if not provided.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the password."

fn spec.maxScale.auth.monitorPasswordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.maxScale.auth.monitorPasswordSecretKeyRef.withKey

withKey(key)

fn spec.maxScale.auth.monitorPasswordSecretKeyRef.withName

withName(name)

obj spec.maxScale.auth.serverPasswordSecretKeyRef

"ServerPasswordSecretKeyRef is Secret key reference to the password used by MaxScale to connect to MariaDB server. It is defaulted if not provided.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the password."

fn spec.maxScale.auth.serverPasswordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.maxScale.auth.serverPasswordSecretKeyRef.withKey

withKey(key)

fn spec.maxScale.auth.serverPasswordSecretKeyRef.withName

withName(name)

obj spec.maxScale.auth.syncPasswordSecretKeyRef

"SyncPasswordSecretKeyRef is Secret key reference to the password used by MaxScale config to connect to MariaDB server. It is defaulted when HA is enabled.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the password."

fn spec.maxScale.auth.syncPasswordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.maxScale.auth.syncPasswordSecretKeyRef.withKey

withKey(key)

fn spec.maxScale.auth.syncPasswordSecretKeyRef.withName

withName(name)

obj spec.maxScale.config

"Config defines the MaxScale configuration."

fn spec.maxScale.config.withParams

withParams(params)

"Params is a key value pair of parameters to be used in the MaxScale static configuration file.\nAny parameter supported by MaxScale may be specified here. See reference:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#global-settings."

fn spec.maxScale.config.withParamsMixin

withParamsMixin(params)

"Params is a key value pair of parameters to be used in the MaxScale static configuration file.\nAny parameter supported by MaxScale may be specified here. See reference:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#global-settings."

Note: This function appends passed data to existing values

obj spec.maxScale.config.sync

"Sync defines how to replicate configuration across MaxScale replicas. It is defaulted when HA is enabled."

fn spec.maxScale.config.sync.withDatabase

withDatabase(database)

"Database is the MariaDB logical database where the 'maxscale_config' table will be created in order to persist and synchronize config changes. If not provided, it defaults to 'mysql'."

fn spec.maxScale.config.sync.withInterval

withInterval(interval)

"Interval defines the config synchronization interval. It is defaulted if not provided."

fn spec.maxScale.config.sync.withTimeout

withTimeout(timeout)

"Interval defines the config synchronization timeout. It is defaulted if not provided."

obj spec.maxScale.config.volumeClaimTemplate

"VolumeClaimTemplate provides a template to define the PVCs for storing MaxScale runtime configuration files. It is defaulted if not provided."

fn spec.maxScale.config.volumeClaimTemplate.withAccessModes

withAccessModes(accessModes)

fn spec.maxScale.config.volumeClaimTemplate.withAccessModesMixin

withAccessModesMixin(accessModes)

Note: This function appends passed data to existing values

fn spec.maxScale.config.volumeClaimTemplate.withStorageClassName

withStorageClassName(storageClassName)

obj spec.maxScale.config.volumeClaimTemplate.metadata

"Metadata to be added to the PVC metadata."

fn spec.maxScale.config.volumeClaimTemplate.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.maxScale.config.volumeClaimTemplate.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.maxScale.config.volumeClaimTemplate.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.maxScale.config.volumeClaimTemplate.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.maxScale.config.volumeClaimTemplate.resources

"VolumeResourceRequirements describes the storage resource requirements for a volume."

fn spec.maxScale.config.volumeClaimTemplate.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.maxScale.config.volumeClaimTemplate.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.maxScale.config.volumeClaimTemplate.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.maxScale.config.volumeClaimTemplate.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

obj spec.maxScale.config.volumeClaimTemplate.selector

"A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects."

fn spec.maxScale.config.volumeClaimTemplate.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.maxScale.config.volumeClaimTemplate.selector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.maxScale.config.volumeClaimTemplate.selector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.maxScale.config.volumeClaimTemplate.selector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.maxScale.config.volumeClaimTemplate.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.maxScale.config.volumeClaimTemplate.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.maxScale.config.volumeClaimTemplate.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.maxScale.config.volumeClaimTemplate.selector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.maxScale.config.volumeClaimTemplate.selector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.maxScale.connection

"Connection provides a template to define the Connection for MaxScale."

fn spec.maxScale.connection.withParams

withParams(params)

"Params to be used in the Connection."

fn spec.maxScale.connection.withParamsMixin

withParamsMixin(params)

"Params to be used in the Connection."

Note: This function appends passed data to existing values

fn spec.maxScale.connection.withPort

withPort(port)

"Port to connect to. If not provided, it defaults to the MariaDB port or to the first MaxScale listener."

fn spec.maxScale.connection.withSecretName

withSecretName(secretName)

"SecretName to be used in the Connection."

fn spec.maxScale.connection.withServiceName

withServiceName(serviceName)

"ServiceName to be used in the Connection."

obj spec.maxScale.connection.healthCheck

"HealthCheck to be used in the Connection."

fn spec.maxScale.connection.healthCheck.withInterval

withInterval(interval)

"Interval used to perform health checks."

fn spec.maxScale.connection.healthCheck.withRetryInterval

withRetryInterval(retryInterval)

"RetryInterval is the interval used to perform health check retries."

obj spec.maxScale.connection.secretTemplate

"SecretTemplate to be used in the Connection."

fn spec.maxScale.connection.secretTemplate.withDatabaseKey

withDatabaseKey(databaseKey)

"DatabaseKey to be used in the Secret."

fn spec.maxScale.connection.secretTemplate.withFormat

withFormat(format)

"Format to be used in the Secret."

fn spec.maxScale.connection.secretTemplate.withHostKey

withHostKey(hostKey)

"HostKey to be used in the Secret."

fn spec.maxScale.connection.secretTemplate.withKey

withKey(key)

"Key to be used in the Secret."

fn spec.maxScale.connection.secretTemplate.withPasswordKey

withPasswordKey(passwordKey)

"PasswordKey to be used in the Secret."

fn spec.maxScale.connection.secretTemplate.withPortKey

withPortKey(portKey)

"PortKey to be used in the Secret."

fn spec.maxScale.connection.secretTemplate.withUsernameKey

withUsernameKey(usernameKey)

"UsernameKey to be used in the Secret."

obj spec.maxScale.connection.secretTemplate.metadata

"Metadata to be added to the Secret object."

fn spec.maxScale.connection.secretTemplate.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.maxScale.connection.secretTemplate.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.maxScale.connection.secretTemplate.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.maxScale.connection.secretTemplate.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.maxScale.guiKubernetesService

"GuiKubernetesService define a template for a Kubernetes Service object to connect to MaxScale's GUI."

fn spec.maxScale.guiKubernetesService.withAllocateLoadBalancerNodePorts

withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts)

"AllocateLoadBalancerNodePorts Service field."

fn spec.maxScale.guiKubernetesService.withExternalTrafficPolicy

withExternalTrafficPolicy(externalTrafficPolicy)

"ExternalTrafficPolicy Service field."

fn spec.maxScale.guiKubernetesService.withLoadBalancerIP

withLoadBalancerIP(loadBalancerIP)

"LoadBalancerIP Service field."

fn spec.maxScale.guiKubernetesService.withLoadBalancerSourceRanges

withLoadBalancerSourceRanges(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

fn spec.maxScale.guiKubernetesService.withLoadBalancerSourceRangesMixin

withLoadBalancerSourceRangesMixin(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

Note: This function appends passed data to existing values

fn spec.maxScale.guiKubernetesService.withSessionAffinity

withSessionAffinity(sessionAffinity)

"SessionAffinity Service field."

fn spec.maxScale.guiKubernetesService.withType

withType(type)

"Type is the Service type. One of ClusterIP, NodePort or LoadBalancer. If not defined, it defaults to ClusterIP."

obj spec.maxScale.guiKubernetesService.metadata

"Metadata to be added to the Service metadata."

fn spec.maxScale.guiKubernetesService.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.maxScale.guiKubernetesService.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.maxScale.guiKubernetesService.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.maxScale.guiKubernetesService.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.maxScale.kubernetesService

"KubernetesService defines a template for a Kubernetes Service object to connect to MaxScale."

fn spec.maxScale.kubernetesService.withAllocateLoadBalancerNodePorts

withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts)

"AllocateLoadBalancerNodePorts Service field."

fn spec.maxScale.kubernetesService.withExternalTrafficPolicy

withExternalTrafficPolicy(externalTrafficPolicy)

"ExternalTrafficPolicy Service field."

fn spec.maxScale.kubernetesService.withLoadBalancerIP

withLoadBalancerIP(loadBalancerIP)

"LoadBalancerIP Service field."

fn spec.maxScale.kubernetesService.withLoadBalancerSourceRanges

withLoadBalancerSourceRanges(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

fn spec.maxScale.kubernetesService.withLoadBalancerSourceRangesMixin

withLoadBalancerSourceRangesMixin(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

Note: This function appends passed data to existing values

fn spec.maxScale.kubernetesService.withSessionAffinity

withSessionAffinity(sessionAffinity)

"SessionAffinity Service field."

fn spec.maxScale.kubernetesService.withType

withType(type)

"Type is the Service type. One of ClusterIP, NodePort or LoadBalancer. If not defined, it defaults to ClusterIP."

obj spec.maxScale.kubernetesService.metadata

"Metadata to be added to the Service metadata."

fn spec.maxScale.kubernetesService.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.maxScale.kubernetesService.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.maxScale.kubernetesService.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.maxScale.kubernetesService.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.maxScale.metrics

"Metrics configures metrics and how to scrape them."

fn spec.maxScale.metrics.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable Metrics"

obj spec.maxScale.metrics.exporter

"Exporter defines the metrics exporter container."

fn spec.maxScale.metrics.exporter.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.maxScale.metrics.exporter.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.withImage

withImage(image)

"Image name to be used as metrics exporter. The supported format is <image>:<tag>.\nOnly mysqld-exporter >= v0.15.0 is supported: https://github.com/prometheus/mysqld_exporter"

fn spec.maxScale.metrics.exporter.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.maxScale.metrics.exporter.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

fn spec.maxScale.metrics.exporter.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector to be used in the Pod."

fn spec.maxScale.metrics.exporter.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.withPort

withPort(port)

"Port where the exporter will be listening for connections."

fn spec.maxScale.metrics.exporter.withPriorityClassName

withPriorityClassName(priorityClassName)

"PriorityClassName to be used in the Pod."

fn spec.maxScale.metrics.exporter.withTolerations

withTolerations(tolerations)

"Tolerations to be used in the Pod."

fn spec.maxScale.metrics.exporter.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations to be used in the Pod."

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity

"Affinity to be used in the Pod."

fn spec.maxScale.metrics.exporter.affinity.withAntiAffinityEnabled

withAntiAffinityEnabled(antiAffinityEnabled)

"AntiAffinityEnabled configures PodAntiAffinity so each Pod is scheduled in a different Node, enabling HA.\nMake sure you have at least as many Nodes available as the replicas to not end up with unscheduled Pods."

obj spec.maxScale.metrics.exporter.affinity.nodeAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeaffinity-v1-core"

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselectorterm-v1-core"

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselector-v1-core"

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

fn spec.maxScale.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.podAntiAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podantiaffinity-v1-core."

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podaffinityterm-v1-core."

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

obj spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

obj spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.maxScale.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.imagePullSecrets

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

fn spec.maxScale.metrics.exporter.imagePullSecrets.withName

withName(name)

obj spec.maxScale.metrics.exporter.podMetadata

"PodMetadata defines extra metadata for the Pod."

fn spec.maxScale.metrics.exporter.podMetadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.maxScale.metrics.exporter.podMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.podMetadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.maxScale.metrics.exporter.podMetadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.podSecurityContext

"SecurityContext holds pod-level security attributes and common container settings."

fn spec.maxScale.metrics.exporter.podSecurityContext.withFsGroup

withFsGroup(fsGroup)

fn spec.maxScale.metrics.exporter.podSecurityContext.withFsGroupChangePolicy

withFsGroupChangePolicy(fsGroupChangePolicy)

"PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume\nwhen volume is mounted."

fn spec.maxScale.metrics.exporter.podSecurityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.maxScale.metrics.exporter.podSecurityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.maxScale.metrics.exporter.podSecurityContext.withRunAsUser

withRunAsUser(runAsUser)

fn spec.maxScale.metrics.exporter.podSecurityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

fn spec.maxScale.metrics.exporter.podSecurityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.podSecurityContext.appArmorProfile

"AppArmorProfile defines a pod or container's AppArmor settings."

fn spec.maxScale.metrics.exporter.podSecurityContext.appArmorProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"."

fn spec.maxScale.metrics.exporter.podSecurityContext.appArmorProfile.withType

withType(type)

"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement."

obj spec.maxScale.metrics.exporter.podSecurityContext.seLinuxOptions

"SELinuxOptions are the labels to be applied to the container"

fn spec.maxScale.metrics.exporter.podSecurityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.maxScale.metrics.exporter.podSecurityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.maxScale.metrics.exporter.podSecurityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.maxScale.metrics.exporter.podSecurityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.maxScale.metrics.exporter.podSecurityContext.seccompProfile

"SeccompProfile defines a pod/container's seccomp profile settings.\nOnly one profile source may be set."

fn spec.maxScale.metrics.exporter.podSecurityContext.seccompProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type."

fn spec.maxScale.metrics.exporter.podSecurityContext.seccompProfile.withType

withType(type)

"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied."

obj spec.maxScale.metrics.exporter.resources

"Resources describes the compute resource requirements."

fn spec.maxScale.metrics.exporter.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.maxScale.metrics.exporter.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.maxScale.metrics.exporter.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.securityContext

"SecurityContext holds container-level security attributes."

fn spec.maxScale.metrics.exporter.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

fn spec.maxScale.metrics.exporter.securityContext.withPrivileged

withPrivileged(privileged)

fn spec.maxScale.metrics.exporter.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

fn spec.maxScale.metrics.exporter.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.maxScale.metrics.exporter.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.maxScale.metrics.exporter.securityContext.withRunAsUser

withRunAsUser(runAsUser)

obj spec.maxScale.metrics.exporter.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn spec.maxScale.metrics.exporter.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.maxScale.metrics.exporter.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.maxScale.metrics.exporter.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.maxScale.metrics.exporter.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.maxScale.metrics.exporter.tolerations

"Tolerations to be used in the Pod."

fn spec.maxScale.metrics.exporter.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.maxScale.metrics.exporter.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.maxScale.metrics.exporter.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.maxScale.metrics.exporter.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.maxScale.metrics.exporter.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.maxScale.metrics.serviceMonitor

"ServiceMonitor defines the ServiceMonior object."

fn spec.maxScale.metrics.serviceMonitor.withInterval

withInterval(interval)

"Interval for scraping metrics."

fn spec.maxScale.metrics.serviceMonitor.withJobLabel

withJobLabel(jobLabel)

"JobLabel to add to the ServiceMonitor object."

fn spec.maxScale.metrics.serviceMonitor.withPrometheusRelease

withPrometheusRelease(prometheusRelease)

"PrometheusRelease is the release label to add to the ServiceMonitor object."

fn spec.maxScale.metrics.serviceMonitor.withScrapeTimeout

withScrapeTimeout(scrapeTimeout)

"ScrapeTimeout defines the timeout for scraping metrics."

obj spec.maxScale.monitor

"Monitor monitors MariaDB server instances."

fn spec.maxScale.monitor.withCooperativeMonitoring

withCooperativeMonitoring(cooperativeMonitoring)

"CooperativeMonitoring enables coordination between multiple MaxScale instances running monitors. It is defaulted when HA is enabled."

fn spec.maxScale.monitor.withInterval

withInterval(interval)

"Interval used to monitor MariaDB servers. It is defaulted if not provided."

fn spec.maxScale.monitor.withModule

withModule(module)

"Module is the module to use to monitor MariaDB servers. It is mandatory when no MariaDB reference is provided."

fn spec.maxScale.monitor.withName

withName(name)

"Name is the identifier of the monitor. It is defaulted if not provided."

fn spec.maxScale.monitor.withParams

withParams(params)

"Params defines extra parameters to pass to the monitor.\nAny parameter supported by MaxScale may be specified here. See reference:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-common-monitor-parameters/.\nMonitor specific parameter are also supported:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-galera-monitor/#galera-monitor-optional-parameters.\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-monitor/#configuration."

fn spec.maxScale.monitor.withParamsMixin

withParamsMixin(params)

"Params defines extra parameters to pass to the monitor.\nAny parameter supported by MaxScale may be specified here. See reference:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-common-monitor-parameters/.\nMonitor specific parameter are also supported:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-galera-monitor/#galera-monitor-optional-parameters.\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-monitor/#configuration."

Note: This function appends passed data to existing values

fn spec.maxScale.monitor.withSuspend

withSuspend(suspend)

"Suspend indicates whether the current resource should be suspended or not.\nThis can be useful for maintenance, as disabling the reconciliation prevents the operator from interfering with user operations during maintenance activities."

obj spec.maxScale.podDisruptionBudget

"PodDisruptionBudget defines the budget for replica availability."

fn spec.maxScale.podDisruptionBudget.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

"MaxUnavailable defines the number of maximum unavailable Pods."

fn spec.maxScale.podDisruptionBudget.withMinAvailable

withMinAvailable(minAvailable)

"MinAvailable defines the number of minimum available Pods."

obj spec.maxScale.services

"Services define how the traffic is forwarded to the MariaDB servers."

fn spec.maxScale.services.withName

withName(name)

"Name is the identifier of the MaxScale service."

fn spec.maxScale.services.withParams

withParams(params)

"Params defines extra parameters to pass to the service.\nAny parameter supported by MaxScale may be specified here. See reference:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#service_1.\nRouter specific parameter are also supported:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-readwritesplit/#configuration.\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-readconnroute/#configuration."

fn spec.maxScale.services.withParamsMixin

withParamsMixin(params)

"Params defines extra parameters to pass to the service.\nAny parameter supported by MaxScale may be specified here. See reference:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#service_1.\nRouter specific parameter are also supported:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-readwritesplit/#configuration.\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-readconnroute/#configuration."

Note: This function appends passed data to existing values

fn spec.maxScale.services.withRouter

withRouter(router)

"Router is the type of router to use."

fn spec.maxScale.services.withSuspend

withSuspend(suspend)

"Suspend indicates whether the current resource should be suspended or not.\nThis can be useful for maintenance, as disabling the reconciliation prevents the operator from interfering with user operations during maintenance activities."

obj spec.maxScale.services.listener

"MaxScaleListener defines how the MaxScale server will listen for connections."

fn spec.maxScale.services.listener.withName

withName(name)

"Name is the identifier of the listener. It is defaulted if not provided"

fn spec.maxScale.services.listener.withParams

withParams(params)

"Params defines extra parameters to pass to the listener.\nAny parameter supported by MaxScale may be specified here. See reference:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#listener_1."

fn spec.maxScale.services.listener.withParamsMixin

withParamsMixin(params)

"Params defines extra parameters to pass to the listener.\nAny parameter supported by MaxScale may be specified here. See reference:\nhttps://mariadb.com/kb/en/mariadb-maxscale-2308-mariadb-maxscale-configuration-guide/#listener_1."

Note: This function appends passed data to existing values

fn spec.maxScale.services.listener.withPort

withPort(port)

"Port is the network port where the MaxScale server will listen."

fn spec.maxScale.services.listener.withProtocol

withProtocol(protocol)

"Protocol is the MaxScale protocol to use when communicating with the client. If not provided, it defaults to MariaDBProtocol."

fn spec.maxScale.services.listener.withSuspend

withSuspend(suspend)

"Suspend indicates whether the current resource should be suspended or not.\nThis can be useful for maintenance, as disabling the reconciliation prevents the operator from interfering with user operations during maintenance activities."

obj spec.maxScale.tls

"TLS defines the PKI to be used with MaxScale."

fn spec.maxScale.tls.withEnabled

withEnabled(enabled)

"Enabled indicates whether TLS is enabled, determining if certificates should be issued and mounted to the MaxScale instance.\nIt is enabled by default when the referred MariaDB instance (via mariaDbRef) has TLS enabled and enforced."

fn spec.maxScale.tls.withReplicationSSLEnabled

withReplicationSSLEnabled(replicationSSLEnabled)

"ReplicationSSLEnabled specifies whether the replication SSL is enabled. If enabled, the SSL options will be added to the server configuration.\nIt is enabled by default when the referred MariaDB instance (via mariaDbRef) has replication enabled.\nIf the MariaDB servers are manually provided by the user via the 'servers' field, this must be set by the user as well."

fn spec.maxScale.tls.withVerifyPeerCertificate

withVerifyPeerCertificate(verifyPeerCertificate)

"VerifyPeerCertificate specifies whether the peer certificate's signature should be validated against the CA.\nIt is disabled by default."

fn spec.maxScale.tls.withVerifyPeerHost

withVerifyPeerHost(verifyPeerHost)

"VerifyPeerHost specifies whether the peer certificate's SANs should match the peer host.\nIt is disabled by default."

obj spec.maxScale.tls.adminCASecretRef

"AdminCASecretRef is a reference to a Secret containing the admin certificate authority keypair. It is used to establish trust and issue certificates for the MaxScale's administrative REST API and GUI.\nOne of:\n- Secret containing both the 'ca.crt' and 'ca.key' keys. This allows you to bring your own CA to Kubernetes to issue certificates.\n- Secret containing only the 'ca.crt' in order to establish trust. In this case, either adminCertSecretRef or adminCertIssuerRef fields must be provided.\nIf not provided, a self-signed CA will be provisioned to issue the server certificate."

fn spec.maxScale.tls.adminCASecretRef.withName

withName(name)

obj spec.maxScale.tls.adminCertIssuerRef

"AdminCertIssuerRef is a reference to a cert-manager issuer object used to issue the MaxScale's administrative REST API and GUI certificate. cert-manager must be installed previously in the cluster.\nIt is mutually exclusive with adminCertSecretRef.\nBy default, the Secret field 'ca.crt' provisioned by cert-manager will be added to the trust chain. A custom trust bundle may be specified via adminCASecretRef."

fn spec.maxScale.tls.adminCertIssuerRef.withGroup

withGroup(group)

"Group of the resource being referred to."

fn spec.maxScale.tls.adminCertIssuerRef.withKind

withKind(kind)

"Kind of the resource being referred to."

fn spec.maxScale.tls.adminCertIssuerRef.withName

withName(name)

"Name of the resource being referred to."

obj spec.maxScale.tls.adminCertSecretRef

"AdminCertSecretRef is a reference to a TLS Secret used by the MaxScale's administrative REST API and GUI."

fn spec.maxScale.tls.adminCertSecretRef.withName

withName(name)

obj spec.maxScale.tls.listenerCASecretRef

"ListenerCASecretRef is a reference to a Secret containing the listener certificate authority keypair. It is used to establish trust and issue certificates for the MaxScale's listeners.\nOne of:\n- Secret containing both the 'ca.crt' and 'ca.key' keys. This allows you to bring your own CA to Kubernetes to issue certificates.\n- Secret containing only the 'ca.crt' in order to establish trust. In this case, either listenerCertSecretRef or listenerCertIssuerRef fields must be provided.\nIf not provided, a self-signed CA will be provisioned to issue the listener certificate."

fn spec.maxScale.tls.listenerCASecretRef.withName

withName(name)

obj spec.maxScale.tls.listenerCertIssuerRef

"ListenerCertIssuerRef is a reference to a cert-manager issuer object used to issue the MaxScale's listeners certificate. cert-manager must be installed previously in the cluster.\nIt is mutually exclusive with listenerCertSecretRef.\nBy default, the Secret field 'ca.crt' provisioned by cert-manager will be added to the trust chain. A custom trust bundle may be specified via listenerCASecretRef."

fn spec.maxScale.tls.listenerCertIssuerRef.withGroup

withGroup(group)

"Group of the resource being referred to."

fn spec.maxScale.tls.listenerCertIssuerRef.withKind

withKind(kind)

"Kind of the resource being referred to."

fn spec.maxScale.tls.listenerCertIssuerRef.withName

withName(name)

"Name of the resource being referred to."

obj spec.maxScale.tls.listenerCertSecretRef

"ListenerCertSecretRef is a reference to a TLS Secret used by the MaxScale's listeners."

fn spec.maxScale.tls.listenerCertSecretRef.withName

withName(name)

obj spec.maxScale.tls.serverCASecretRef

"ServerCASecretRef is a reference to a Secret containing the MariaDB server CA certificates. It is used to establish trust with MariaDB servers.\nThe Secret should contain a 'ca.crt' key in order to establish trust.\nIf not provided, and the reference to a MariaDB resource is set (mariaDbRef), it will be defaulted to the referred MariaDB CA bundle."

fn spec.maxScale.tls.serverCASecretRef.withName

withName(name)

obj spec.maxScale.tls.serverCertSecretRef

"ServerCertSecretRef is a reference to a TLS Secret used by MaxScale to connect to the MariaDB servers.\nIf not provided, and the reference to a MariaDB resource is set (mariaDbRef), it will be defaulted to the referred MariaDB client certificate (clientCertSecretRef)."

fn spec.maxScale.tls.serverCertSecretRef.withName

withName(name)

obj spec.maxScale.updateStrategy

"UpdateStrategy defines the update strategy for the StatefulSet object."

fn spec.maxScale.updateStrategy.withType

withType(type)

"Type indicates the type of the StatefulSetUpdateStrategy.\nDefault is RollingUpdate."

obj spec.maxScale.updateStrategy.rollingUpdate

"RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType."

fn spec.maxScale.updateStrategy.rollingUpdate.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

"The maximum number of pods that can be unavailable during the update.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nAbsolute number is calculated from percentage by rounding up. This can not be 0.\nDefaults to 1. This field is alpha-level and is only honored by servers that enable the\nMaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to\nReplicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it\nwill be counted towards MaxUnavailable."

fn spec.maxScale.updateStrategy.rollingUpdate.withPartition

withPartition(partition)

"Partition indicates the ordinal at which the StatefulSet should be partitioned\nfor updates. During a rolling update, all pods from ordinal Replicas-1 to\nPartition are updated. All pods from ordinal Partition-1 to 0 remain untouched.\nThis is helpful in being able to do a canary based deployment. The default value is 0."

obj spec.maxScaleRef

"MaxScaleRef is a reference to a MaxScale resource to be used with the current MariaDB.\nProviding this field implies delegating high availability tasks such as primary failover to MaxScale."

fn spec.maxScaleRef.withName

withName(name)

fn spec.maxScaleRef.withNamespace

withNamespace(namespace)

obj spec.metrics

"Metrics configures metrics and how to scrape them."

fn spec.metrics.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable Metrics"

fn spec.metrics.withUsername

withUsername(username)

"Username is the username of the monitoring user used by the exporter."

obj spec.metrics.exporter

"Exporter defines the metrics exporter container."

fn spec.metrics.exporter.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.metrics.exporter.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.metrics.exporter.withImage

withImage(image)

"Image name to be used as metrics exporter. The supported format is <image>:<tag>.\nOnly mysqld-exporter >= v0.15.0 is supported: https://github.com/prometheus/mysqld_exporter"

fn spec.metrics.exporter.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.metrics.exporter.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

fn spec.metrics.exporter.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

Note: This function appends passed data to existing values

fn spec.metrics.exporter.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector to be used in the Pod."

fn spec.metrics.exporter.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.metrics.exporter.withPort

withPort(port)

"Port where the exporter will be listening for connections."

fn spec.metrics.exporter.withPriorityClassName

withPriorityClassName(priorityClassName)

"PriorityClassName to be used in the Pod."

fn spec.metrics.exporter.withTolerations

withTolerations(tolerations)

"Tolerations to be used in the Pod."

fn spec.metrics.exporter.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations to be used in the Pod."

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity

"Affinity to be used in the Pod."

fn spec.metrics.exporter.affinity.withAntiAffinityEnabled

withAntiAffinityEnabled(antiAffinityEnabled)

"AntiAffinityEnabled configures PodAntiAffinity so each Pod is scheduled in a different Node, enabling HA.\nMake sure you have at least as many Nodes available as the replicas to not end up with unscheduled Pods."

obj spec.metrics.exporter.affinity.nodeAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeaffinity-v1-core"

fn spec.metrics.exporter.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.metrics.exporter.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselectorterm-v1-core"

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

fn spec.metrics.exporter.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselector-v1-core"

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

fn spec.metrics.exporter.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.podAntiAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podantiaffinity-v1-core."

fn spec.metrics.exporter.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.metrics.exporter.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

fn spec.metrics.exporter.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

fn spec.metrics.exporter.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podaffinityterm-v1-core."

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

obj spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.metrics.exporter.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

fn spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

obj spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

fn spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.metrics.exporter.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.imagePullSecrets

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

fn spec.metrics.exporter.imagePullSecrets.withName

withName(name)

obj spec.metrics.exporter.podMetadata

"PodMetadata defines extra metadata for the Pod."

fn spec.metrics.exporter.podMetadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.metrics.exporter.podMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.metrics.exporter.podMetadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.metrics.exporter.podMetadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.metrics.exporter.podSecurityContext

"SecurityContext holds pod-level security attributes and common container settings."

fn spec.metrics.exporter.podSecurityContext.withFsGroup

withFsGroup(fsGroup)

fn spec.metrics.exporter.podSecurityContext.withFsGroupChangePolicy

withFsGroupChangePolicy(fsGroupChangePolicy)

"PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume\nwhen volume is mounted."

fn spec.metrics.exporter.podSecurityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.metrics.exporter.podSecurityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.metrics.exporter.podSecurityContext.withRunAsUser

withRunAsUser(runAsUser)

fn spec.metrics.exporter.podSecurityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

fn spec.metrics.exporter.podSecurityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

Note: This function appends passed data to existing values

obj spec.metrics.exporter.podSecurityContext.appArmorProfile

"AppArmorProfile defines a pod or container's AppArmor settings."

fn spec.metrics.exporter.podSecurityContext.appArmorProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"."

fn spec.metrics.exporter.podSecurityContext.appArmorProfile.withType

withType(type)

"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement."

obj spec.metrics.exporter.podSecurityContext.seLinuxOptions

"SELinuxOptions are the labels to be applied to the container"

fn spec.metrics.exporter.podSecurityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.metrics.exporter.podSecurityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.metrics.exporter.podSecurityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.metrics.exporter.podSecurityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.metrics.exporter.podSecurityContext.seccompProfile

"SeccompProfile defines a pod/container's seccomp profile settings.\nOnly one profile source may be set."

fn spec.metrics.exporter.podSecurityContext.seccompProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type."

fn spec.metrics.exporter.podSecurityContext.seccompProfile.withType

withType(type)

"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied."

obj spec.metrics.exporter.resources

"Resources describes the compute resource requirements."

fn spec.metrics.exporter.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.metrics.exporter.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.metrics.exporter.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.metrics.exporter.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.metrics.exporter.securityContext

"SecurityContext holds container-level security attributes."

fn spec.metrics.exporter.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

fn spec.metrics.exporter.securityContext.withPrivileged

withPrivileged(privileged)

fn spec.metrics.exporter.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

fn spec.metrics.exporter.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.metrics.exporter.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.metrics.exporter.securityContext.withRunAsUser

withRunAsUser(runAsUser)

obj spec.metrics.exporter.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn spec.metrics.exporter.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.metrics.exporter.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.metrics.exporter.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.metrics.exporter.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.metrics.exporter.tolerations

"Tolerations to be used in the Pod."

fn spec.metrics.exporter.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.metrics.exporter.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.metrics.exporter.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.metrics.exporter.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.metrics.exporter.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.metrics.passwordSecretKeyRef

"PasswordSecretKeyRef is a reference to the password of the monitoring user used by the exporter.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the password."

fn spec.metrics.passwordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.metrics.passwordSecretKeyRef.withKey

withKey(key)

fn spec.metrics.passwordSecretKeyRef.withName

withName(name)

obj spec.metrics.serviceMonitor

"ServiceMonitor defines the ServiceMonior object."

fn spec.metrics.serviceMonitor.withInterval

withInterval(interval)

"Interval for scraping metrics."

fn spec.metrics.serviceMonitor.withJobLabel

withJobLabel(jobLabel)

"JobLabel to add to the ServiceMonitor object."

fn spec.metrics.serviceMonitor.withPrometheusRelease

withPrometheusRelease(prometheusRelease)

"PrometheusRelease is the release label to add to the ServiceMonitor object."

fn spec.metrics.serviceMonitor.withScrapeTimeout

withScrapeTimeout(scrapeTimeout)

"ScrapeTimeout defines the timeout for scraping metrics."

obj spec.myCnfConfigMapKeyRef

"MyCnfConfigMapKeyRef is a reference to the my.cnf config file provided via a ConfigMap.\nIf not provided, it will be defaulted with a reference to a ConfigMap containing the MyCnf field.\nIf the referred ConfigMap is labeled with \"k8s.mariadb.com/watch\", an update to the Mariadb resource will be triggered when the ConfigMap is updated."

fn spec.myCnfConfigMapKeyRef.withKey

withKey(key)

fn spec.myCnfConfigMapKeyRef.withName

withName(name)

obj spec.passwordHashSecretKeyRef

"PasswordHashSecretKeyRef is a reference to the password hash to be used by the initial User.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the password hash."

fn spec.passwordHashSecretKeyRef.withKey

withKey(key)

fn spec.passwordHashSecretKeyRef.withName

withName(name)

obj spec.passwordPlugin

"PasswordPlugin is a reference to the password plugin and arguments to be used by the initial User."

obj spec.passwordPlugin.pluginArgSecretKeyRef

"PluginArgSecretKeyRef is a reference to the arguments to be provided to the authentication plugin for the User.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the authentication plugin arguments."

fn spec.passwordPlugin.pluginArgSecretKeyRef.withKey

withKey(key)

fn spec.passwordPlugin.pluginArgSecretKeyRef.withName

withName(name)

obj spec.passwordPlugin.pluginNameSecretKeyRef

"PluginNameSecretKeyRef is a reference to the authentication plugin to be used by the User.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the authentication plugin."

fn spec.passwordPlugin.pluginNameSecretKeyRef.withKey

withKey(key)

fn spec.passwordPlugin.pluginNameSecretKeyRef.withName

withName(name)

obj spec.passwordSecretKeyRef

"PasswordSecretKeyRef is a reference to a Secret that contains the password to be used by the initial User.\nIf the referred Secret is labeled with \"k8s.mariadb.com/watch\", updates may be performed to the Secret in order to update the password."

fn spec.passwordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.passwordSecretKeyRef.withKey

withKey(key)

fn spec.passwordSecretKeyRef.withName

withName(name)

obj spec.podDisruptionBudget

"PodDisruptionBudget defines the budget for replica availability."

fn spec.podDisruptionBudget.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

"MaxUnavailable defines the number of maximum unavailable Pods."

fn spec.podDisruptionBudget.withMinAvailable

withMinAvailable(minAvailable)

"MinAvailable defines the number of minimum available Pods."

obj spec.podMetadata

"PodMetadata defines extra metadata for the Pod."

fn spec.podMetadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.podMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.podMetadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.podMetadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.podSecurityContext

"SecurityContext holds pod-level security attributes and common container settings."

fn spec.podSecurityContext.withFsGroup

withFsGroup(fsGroup)

fn spec.podSecurityContext.withFsGroupChangePolicy

withFsGroupChangePolicy(fsGroupChangePolicy)

"PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume\nwhen volume is mounted."

fn spec.podSecurityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.podSecurityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.podSecurityContext.withRunAsUser

withRunAsUser(runAsUser)

fn spec.podSecurityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

fn spec.podSecurityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

Note: This function appends passed data to existing values

obj spec.podSecurityContext.appArmorProfile

"AppArmorProfile defines a pod or container's AppArmor settings."

fn spec.podSecurityContext.appArmorProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"."

fn spec.podSecurityContext.appArmorProfile.withType

withType(type)

"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement."

obj spec.podSecurityContext.seLinuxOptions

"SELinuxOptions are the labels to be applied to the container"

fn spec.podSecurityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.podSecurityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.podSecurityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.podSecurityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.podSecurityContext.seccompProfile

"SeccompProfile defines a pod/container's seccomp profile settings.\nOnly one profile source may be set."

fn spec.podSecurityContext.seccompProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type."

fn spec.podSecurityContext.seccompProfile.withType

withType(type)

"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied."

obj spec.primaryConnection

"PrimaryConnection defines a template to configure the primary Connection object.\nThis Connection provides the initial User access to the initial Database.\nIt will make use of the PrimaryService to route network traffic to the primary Pod."

fn spec.primaryConnection.withParams

withParams(params)

"Params to be used in the Connection."

fn spec.primaryConnection.withParamsMixin

withParamsMixin(params)

"Params to be used in the Connection."

Note: This function appends passed data to existing values

fn spec.primaryConnection.withPort

withPort(port)

"Port to connect to. If not provided, it defaults to the MariaDB port or to the first MaxScale listener."

fn spec.primaryConnection.withSecretName

withSecretName(secretName)

"SecretName to be used in the Connection."

fn spec.primaryConnection.withServiceName

withServiceName(serviceName)

"ServiceName to be used in the Connection."

obj spec.primaryConnection.healthCheck

"HealthCheck to be used in the Connection."

fn spec.primaryConnection.healthCheck.withInterval

withInterval(interval)

"Interval used to perform health checks."

fn spec.primaryConnection.healthCheck.withRetryInterval

withRetryInterval(retryInterval)

"RetryInterval is the interval used to perform health check retries."

obj spec.primaryConnection.secretTemplate

"SecretTemplate to be used in the Connection."

fn spec.primaryConnection.secretTemplate.withDatabaseKey

withDatabaseKey(databaseKey)

"DatabaseKey to be used in the Secret."

fn spec.primaryConnection.secretTemplate.withFormat

withFormat(format)

"Format to be used in the Secret."

fn spec.primaryConnection.secretTemplate.withHostKey

withHostKey(hostKey)

"HostKey to be used in the Secret."

fn spec.primaryConnection.secretTemplate.withKey

withKey(key)

"Key to be used in the Secret."

fn spec.primaryConnection.secretTemplate.withPasswordKey

withPasswordKey(passwordKey)

"PasswordKey to be used in the Secret."

fn spec.primaryConnection.secretTemplate.withPortKey

withPortKey(portKey)

"PortKey to be used in the Secret."

fn spec.primaryConnection.secretTemplate.withUsernameKey

withUsernameKey(usernameKey)

"UsernameKey to be used in the Secret."

obj spec.primaryConnection.secretTemplate.metadata

"Metadata to be added to the Secret object."

fn spec.primaryConnection.secretTemplate.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.primaryConnection.secretTemplate.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.primaryConnection.secretTemplate.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.primaryConnection.secretTemplate.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.primaryService

"PrimaryService defines a template to configure the primary Service object.\nThe network traffic of this Service will be routed to the primary Pod."

fn spec.primaryService.withAllocateLoadBalancerNodePorts

withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts)

"AllocateLoadBalancerNodePorts Service field."

fn spec.primaryService.withExternalTrafficPolicy

withExternalTrafficPolicy(externalTrafficPolicy)

"ExternalTrafficPolicy Service field."

fn spec.primaryService.withLoadBalancerIP

withLoadBalancerIP(loadBalancerIP)

"LoadBalancerIP Service field."

fn spec.primaryService.withLoadBalancerSourceRanges

withLoadBalancerSourceRanges(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

fn spec.primaryService.withLoadBalancerSourceRangesMixin

withLoadBalancerSourceRangesMixin(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

Note: This function appends passed data to existing values

fn spec.primaryService.withSessionAffinity

withSessionAffinity(sessionAffinity)

"SessionAffinity Service field."

fn spec.primaryService.withType

withType(type)

"Type is the Service type. One of ClusterIP, NodePort or LoadBalancer. If not defined, it defaults to ClusterIP."

obj spec.primaryService.metadata

"Metadata to be added to the Service metadata."

fn spec.primaryService.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.primaryService.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.primaryService.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.primaryService.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.readinessProbe

"ReadinessProbe to be used in the Container."

fn spec.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.readinessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.readinessProbe.exec.withCommand

withCommand(command)

fn spec.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.readinessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.readinessProbe.httpGet.withHost

withHost(host)

fn spec.readinessProbe.httpGet.withPath

withPath(path)

fn spec.readinessProbe.httpGet.withPort

withPort(port)

fn spec.readinessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.readinessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.readinessProbe.tcpSocket.withHost

withHost(host)

fn spec.readinessProbe.tcpSocket.withPort

withPort(port)

obj spec.replication

"Replication configures high availability via replication. This feature is still in alpha, use Galera if you are looking for a more production-ready HA."

fn spec.replication.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable replication."

fn spec.replication.withGtidStrictMode

withGtidStrictMode(gtidStrictMode)

"GtidStrictMode determines whether the GTID strict mode is enabled.\nSee: https://mariadb.com/docs/server/ha-and-performance/standard-replication/gtid#gtid_strict_mode.\nIt is enabled by default."

fn spec.replication.withSemiSyncAckTimeout

withSemiSyncAckTimeout(semiSyncAckTimeout)

"SemiSyncAckTimeout for the replica to acknowledge transactions to the primary.\nIt requires semi-synchronous replication to be enabled.\nSee: https://mariadb.com/docs/server/ha-and-performance/standard-replication/semisynchronous-replication#rpl_semi_sync_master_timeout"

fn spec.replication.withSemiSyncEnabled

withSemiSyncEnabled(semiSyncEnabled)

"SemiSyncEnabled determines whether semi-synchronous replication is enabled.\nSemi-synchronous replication requires that at least one replica should have sent an ACK to the primary node\nbefore committing the transaction back to the client.\nSee: https://mariadb.com/docs/server/ha-and-performance/standard-replication/semisynchronous-replication\nIt is enabled by default"

fn spec.replication.withSemiSyncWaitPoint

withSemiSyncWaitPoint(semiSyncWaitPoint)

"SemiSyncWaitPoint determines whether the transaction should wait for an ACK after having synced the binlog (AfterSync)\nor after having committed to the storage engine (AfterCommit, the default).\nIt requires semi-synchronous replication to be enabled.\nSee: https://mariadb.com/kb/en/semisynchronous-replication/#rpl_semi_sync_master_wait_point."

fn spec.replication.withStandaloneProbes

withStandaloneProbes(standaloneProbes)

"StandaloneProbes indicates whether to use the default non-HA startup and liveness probes.\nIt is disabled by default"

fn spec.replication.withSyncBinlog

withSyncBinlog(syncBinlog)

"SyncBinlog indicates after how many events the binary log is synchronized to the disk.\nSee: https://mariadb.com/docs/server/ha-and-performance/standard-replication/replication-and-binary-log-system-variables#sync_binlog"

obj spec.replication.agent

"Agent is a sidecar agent that runs in the MariaDB Pod and co-operates with mariadb-operator."

fn spec.replication.agent.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.replication.agent.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.replication.agent.withCommand

withCommand(command)

"Command to be used in the Container."

fn spec.replication.agent.withCommandMixin

withCommandMixin(command)

"Command to be used in the Container."

Note: This function appends passed data to existing values

fn spec.replication.agent.withEnv

withEnv(env)

"Env represents the environment variables to be injected in a container."

fn spec.replication.agent.withEnvFrom

withEnvFrom(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.replication.agent.withEnvFromMixin

withEnvFromMixin(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

Note: This function appends passed data to existing values

fn spec.replication.agent.withEnvMixin

withEnvMixin(env)

"Env represents the environment variables to be injected in a container."

Note: This function appends passed data to existing values

fn spec.replication.agent.withGracefulShutdownTimeout

withGracefulShutdownTimeout(gracefulShutdownTimeout)

"GracefulShutdownTimeout is the time we give to the agent container in order to gracefully terminate in-flight requests."

fn spec.replication.agent.withImage

withImage(image)

"Image name to be used by the MariaDB instances. The supported format is <image>:<tag>."

fn spec.replication.agent.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.replication.agent.withPort

withPort(port)

"Port where the agent will be listening for API connections."

fn spec.replication.agent.withProbePort

withProbePort(probePort)

"Port where the agent will be listening for probe connections."

fn spec.replication.agent.withVolumeMounts

withVolumeMounts(volumeMounts)

"VolumeMounts to be used in the Container."

fn spec.replication.agent.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"VolumeMounts to be used in the Container."

Note: This function appends passed data to existing values

obj spec.replication.agent.basicAuth

"BasicAuth to be used by the agent container"

fn spec.replication.agent.basicAuth.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable BasicAuth"

fn spec.replication.agent.basicAuth.withUsername

withUsername(username)

"Username to be used for basic authentication"

obj spec.replication.agent.basicAuth.passwordSecretKeyRef

"PasswordSecretKeyRef to be used for basic authentication"

fn spec.replication.agent.basicAuth.passwordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.replication.agent.basicAuth.passwordSecretKeyRef.withKey

withKey(key)

fn spec.replication.agent.basicAuth.passwordSecretKeyRef.withName

withName(name)

obj spec.replication.agent.env

"Env represents the environment variables to be injected in a container."

fn spec.replication.agent.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.replication.agent.env.withValue

withValue(value)

obj spec.replication.agent.env.valueFrom

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#envvarsource-v1-core."

obj spec.replication.agent.env.valueFrom.configMapKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#configmapkeyselector-v1-core."

fn spec.replication.agent.env.valueFrom.configMapKeyRef.withKey

withKey(key)

fn spec.replication.agent.env.valueFrom.configMapKeyRef.withName

withName(name)

obj spec.replication.agent.env.valueFrom.fieldRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectfieldselector-v1-core."

fn spec.replication.agent.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

fn spec.replication.agent.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

obj spec.replication.agent.env.valueFrom.secretKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#secretkeyselector-v1-core."

fn spec.replication.agent.env.valueFrom.secretKeyRef.withKey

withKey(key)

fn spec.replication.agent.env.valueFrom.secretKeyRef.withName

withName(name)

obj spec.replication.agent.envFrom

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.replication.agent.envFrom.withPrefix

withPrefix(prefix)

obj spec.replication.agent.envFrom.configMapRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.replication.agent.envFrom.configMapRef.withName

withName(name)

obj spec.replication.agent.envFrom.secretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.replication.agent.envFrom.secretRef.withName

withName(name)

obj spec.replication.agent.kubernetesAuth

"KubernetesAuth to be used by the agent container"

fn spec.replication.agent.kubernetesAuth.withAuthDelegatorRoleName

withAuthDelegatorRoleName(authDelegatorRoleName)

"AuthDelegatorRoleName is the name of the ClusterRoleBinding that is associated with the \"system:auth-delegator\" ClusterRole.\nIt is necessary for creating TokenReview objects in order for the agent to validate the service account token."

fn spec.replication.agent.kubernetesAuth.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable KubernetesAuth"

obj spec.replication.agent.livenessProbe

"LivenessProbe to be used in the Container."

fn spec.replication.agent.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.replication.agent.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.replication.agent.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.replication.agent.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.replication.agent.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.replication.agent.livenessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.replication.agent.livenessProbe.exec.withCommand

withCommand(command)

fn spec.replication.agent.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.replication.agent.livenessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.replication.agent.livenessProbe.httpGet.withHost

withHost(host)

fn spec.replication.agent.livenessProbe.httpGet.withPath

withPath(path)

fn spec.replication.agent.livenessProbe.httpGet.withPort

withPort(port)

fn spec.replication.agent.livenessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.replication.agent.livenessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.replication.agent.livenessProbe.tcpSocket.withHost

withHost(host)

fn spec.replication.agent.livenessProbe.tcpSocket.withPort

withPort(port)

obj spec.replication.agent.readinessProbe

"ReadinessProbe to be used in the Container."

fn spec.replication.agent.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.replication.agent.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.replication.agent.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.replication.agent.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.replication.agent.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.replication.agent.readinessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.replication.agent.readinessProbe.exec.withCommand

withCommand(command)

fn spec.replication.agent.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.replication.agent.readinessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.replication.agent.readinessProbe.httpGet.withHost

withHost(host)

fn spec.replication.agent.readinessProbe.httpGet.withPath

withPath(path)

fn spec.replication.agent.readinessProbe.httpGet.withPort

withPort(port)

fn spec.replication.agent.readinessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.replication.agent.readinessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.replication.agent.readinessProbe.tcpSocket.withHost

withHost(host)

fn spec.replication.agent.readinessProbe.tcpSocket.withPort

withPort(port)

obj spec.replication.agent.resources

"Resources describes the compute resource requirements."

fn spec.replication.agent.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.replication.agent.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.replication.agent.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.replication.agent.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.replication.agent.securityContext

"SecurityContext holds security configuration that will be applied to a container."

fn spec.replication.agent.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

fn spec.replication.agent.securityContext.withPrivileged

withPrivileged(privileged)

fn spec.replication.agent.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

fn spec.replication.agent.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.replication.agent.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.replication.agent.securityContext.withRunAsUser

withRunAsUser(runAsUser)

obj spec.replication.agent.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn spec.replication.agent.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.replication.agent.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.replication.agent.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.replication.agent.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.replication.agent.startupProbe

"StartupProbe to be used in the Container."

fn spec.replication.agent.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.replication.agent.startupProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.replication.agent.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.replication.agent.startupProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.replication.agent.startupProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.replication.agent.startupProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.replication.agent.startupProbe.exec.withCommand

withCommand(command)

fn spec.replication.agent.startupProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.replication.agent.startupProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.replication.agent.startupProbe.httpGet.withHost

withHost(host)

fn spec.replication.agent.startupProbe.httpGet.withPath

withPath(path)

fn spec.replication.agent.startupProbe.httpGet.withPort

withPort(port)

fn spec.replication.agent.startupProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.replication.agent.startupProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.replication.agent.startupProbe.tcpSocket.withHost

withHost(host)

fn spec.replication.agent.startupProbe.tcpSocket.withPort

withPort(port)

obj spec.replication.agent.volumeMounts

"VolumeMounts to be used in the Container."

fn spec.replication.agent.volumeMounts.withMountPath

withMountPath(mountPath)

fn spec.replication.agent.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.replication.agent.volumeMounts.withReadOnly

withReadOnly(readOnly)

fn spec.replication.agent.volumeMounts.withSubPath

withSubPath(subPath)

obj spec.replication.initContainer

"InitContainer is an init container that runs in the MariaDB Pod and co-operates with mariadb-operator."

fn spec.replication.initContainer.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.replication.initContainer.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.replication.initContainer.withCommand

withCommand(command)

"Command to be used in the Container."

fn spec.replication.initContainer.withCommandMixin

withCommandMixin(command)

"Command to be used in the Container."

Note: This function appends passed data to existing values

fn spec.replication.initContainer.withEnv

withEnv(env)

"Env represents the environment variables to be injected in a container."

fn spec.replication.initContainer.withEnvFrom

withEnvFrom(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.replication.initContainer.withEnvFromMixin

withEnvFromMixin(envFrom)

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

Note: This function appends passed data to existing values

fn spec.replication.initContainer.withEnvMixin

withEnvMixin(env)

"Env represents the environment variables to be injected in a container."

Note: This function appends passed data to existing values

fn spec.replication.initContainer.withImage

withImage(image)

"Image name to be used by the MariaDB instances. The supported format is <image>:<tag>."

fn spec.replication.initContainer.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.replication.initContainer.withVolumeMounts

withVolumeMounts(volumeMounts)

"VolumeMounts to be used in the Container."

fn spec.replication.initContainer.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"VolumeMounts to be used in the Container."

Note: This function appends passed data to existing values

obj spec.replication.initContainer.env

"Env represents the environment variables to be injected in a container."

fn spec.replication.initContainer.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.replication.initContainer.env.withValue

withValue(value)

obj spec.replication.initContainer.env.valueFrom

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#envvarsource-v1-core."

obj spec.replication.initContainer.env.valueFrom.configMapKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#configmapkeyselector-v1-core."

fn spec.replication.initContainer.env.valueFrom.configMapKeyRef.withKey

withKey(key)

fn spec.replication.initContainer.env.valueFrom.configMapKeyRef.withName

withName(name)

obj spec.replication.initContainer.env.valueFrom.fieldRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectfieldselector-v1-core."

fn spec.replication.initContainer.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

fn spec.replication.initContainer.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

obj spec.replication.initContainer.env.valueFrom.secretKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#secretkeyselector-v1-core."

fn spec.replication.initContainer.env.valueFrom.secretKeyRef.withKey

withKey(key)

fn spec.replication.initContainer.env.valueFrom.secretKeyRef.withName

withName(name)

obj spec.replication.initContainer.envFrom

"EnvFrom represents the references (via ConfigMap and Secrets) to environment variables to be injected in the container."

fn spec.replication.initContainer.envFrom.withPrefix

withPrefix(prefix)

obj spec.replication.initContainer.envFrom.configMapRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.replication.initContainer.envFrom.configMapRef.withName

withName(name)

obj spec.replication.initContainer.envFrom.secretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.replication.initContainer.envFrom.secretRef.withName

withName(name)

obj spec.replication.initContainer.livenessProbe

"LivenessProbe to be used in the Container."

fn spec.replication.initContainer.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.replication.initContainer.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.replication.initContainer.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.replication.initContainer.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.replication.initContainer.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.replication.initContainer.livenessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.replication.initContainer.livenessProbe.exec.withCommand

withCommand(command)

fn spec.replication.initContainer.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.replication.initContainer.livenessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.replication.initContainer.livenessProbe.httpGet.withHost

withHost(host)

fn spec.replication.initContainer.livenessProbe.httpGet.withPath

withPath(path)

fn spec.replication.initContainer.livenessProbe.httpGet.withPort

withPort(port)

fn spec.replication.initContainer.livenessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.replication.initContainer.livenessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.replication.initContainer.livenessProbe.tcpSocket.withHost

withHost(host)

fn spec.replication.initContainer.livenessProbe.tcpSocket.withPort

withPort(port)

obj spec.replication.initContainer.readinessProbe

"ReadinessProbe to be used in the Container."

fn spec.replication.initContainer.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.replication.initContainer.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.replication.initContainer.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.replication.initContainer.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.replication.initContainer.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.replication.initContainer.readinessProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.replication.initContainer.readinessProbe.exec.withCommand

withCommand(command)

fn spec.replication.initContainer.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.replication.initContainer.readinessProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.replication.initContainer.readinessProbe.httpGet.withHost

withHost(host)

fn spec.replication.initContainer.readinessProbe.httpGet.withPath

withPath(path)

fn spec.replication.initContainer.readinessProbe.httpGet.withPort

withPort(port)

fn spec.replication.initContainer.readinessProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.replication.initContainer.readinessProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.replication.initContainer.readinessProbe.tcpSocket.withHost

withHost(host)

fn spec.replication.initContainer.readinessProbe.tcpSocket.withPort

withPort(port)

obj spec.replication.initContainer.resources

"Resources describes the compute resource requirements."

fn spec.replication.initContainer.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.replication.initContainer.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.replication.initContainer.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.replication.initContainer.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.replication.initContainer.securityContext

"SecurityContext holds security configuration that will be applied to a container."

fn spec.replication.initContainer.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

fn spec.replication.initContainer.securityContext.withPrivileged

withPrivileged(privileged)

fn spec.replication.initContainer.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

fn spec.replication.initContainer.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.replication.initContainer.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.replication.initContainer.securityContext.withRunAsUser

withRunAsUser(runAsUser)

obj spec.replication.initContainer.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn spec.replication.initContainer.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.replication.initContainer.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.replication.initContainer.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.replication.initContainer.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.replication.initContainer.startupProbe

"StartupProbe to be used in the Container."

fn spec.replication.initContainer.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.replication.initContainer.startupProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.replication.initContainer.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.replication.initContainer.startupProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.replication.initContainer.startupProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.replication.initContainer.startupProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.replication.initContainer.startupProbe.exec.withCommand

withCommand(command)

fn spec.replication.initContainer.startupProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.replication.initContainer.startupProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.replication.initContainer.startupProbe.httpGet.withHost

withHost(host)

fn spec.replication.initContainer.startupProbe.httpGet.withPath

withPath(path)

fn spec.replication.initContainer.startupProbe.httpGet.withPort

withPort(port)

fn spec.replication.initContainer.startupProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.replication.initContainer.startupProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.replication.initContainer.startupProbe.tcpSocket.withHost

withHost(host)

fn spec.replication.initContainer.startupProbe.tcpSocket.withPort

withPort(port)

obj spec.replication.initContainer.volumeMounts

"VolumeMounts to be used in the Container."

fn spec.replication.initContainer.volumeMounts.withMountPath

withMountPath(mountPath)

fn spec.replication.initContainer.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.replication.initContainer.volumeMounts.withReadOnly

withReadOnly(readOnly)

fn spec.replication.initContainer.volumeMounts.withSubPath

withSubPath(subPath)

obj spec.replication.primary

"Primary is the replication configuration for the primary node."

fn spec.replication.primary.withAutoFailover

withAutoFailover(autoFailover)

"AutoFailover indicates whether the operator should automatically update PodIndex to perform an automatic primary failover.\nIt is enabled by default."

fn spec.replication.primary.withAutoFailoverDelay

withAutoFailoverDelay(autoFailoverDelay)

"AutoFailoverDelay indicates the duration before performing an automatic primary failover.\nBy default, no extra delay is added."

fn spec.replication.primary.withPodIndex

withPodIndex(podIndex)

"PodIndex is the StatefulSet index of the primary node. The user may change this field to perform a manual switchover."

obj spec.replication.replica

"ReplicaReplication is the replication configuration for the replica nodes."

fn spec.replication.replica.withConnectionRetrySeconds

withConnectionRetrySeconds(connectionRetrySeconds)

"ConnectionRetrySeconds is the number of seconds that the replica will wait between connection retries.\nSee: https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/replication-statements/change-master-to#master_connect_retry."

fn spec.replication.replica.withGtid

withGtid(gtid)

"Gtid indicates which Global Transaction ID (GTID) position mode should be used when connecting a replica to the master.\nBy default, CurrentPos is used.\nSee: https://mariadb.com/docs/server/reference/sql-statements/administrative-sql-statements/replication-statements/change-master-to#master_use_gtid."

fn spec.replication.replica.withMaxLagSeconds

withMaxLagSeconds(maxLagSeconds)

"MaxLagSeconds is the maximum number of seconds that replicas are allowed to lag behind the primary.\nIf a replica exceeds this threshold, it is marked as not ready and read queries will no longer be forwarded to it.\nIf not provided, it defaults to 0, which means that replicas are not allowed to lag behind the primary (recommended).\nLagged replicas will not be taken into account as candidates for the new primary during failover,\nand they will block other operations, such as switchover and upgrade.\nThis field is not taken into account by MaxScale, you can define the maximum lag as router parameters.\nSee: https://mariadb.com/docs/maxscale/reference/maxscale-routers/maxscale-readwritesplit#max_replication_lag."

fn spec.replication.replica.withSyncTimeout

withSyncTimeout(syncTimeout)

"SyncTimeout defines the timeout for the synchronization phase during switchover and failover operations.\nDuring switchover, all replicas must be synced with the current primary before promoting the new primary.\nDuring failover, the new primary must be synced before being promoted as primary. This implies processing all the events in the relay log.\nWhen the timeout is reached, the operator restarts the operation from the beginning.\nIt defaults to 10s.\nSee: https://mariadb.com/docs/server/reference/sql-functions/secondary-functions/miscellaneous-functions/master_gtid_wait"

obj spec.replication.replica.bootstrapFrom

"ReplicaBootstrapFrom defines the data sources used to bootstrap new replicas.\nThis will be used as part of the scaling out and recovery operations, when new replicas are created.\nIf not provided, scale out and recovery operations will return an error."

obj spec.replication.replica.bootstrapFrom.physicalBackupTemplateRef

"PhysicalBackupTemplateRef is a reference to a PhysicalBackup object that will be used as template to create a new PhysicalBackup object\nused synchronize the data from an up to date replica to the new replica to be bootstrapped."

fn spec.replication.replica.bootstrapFrom.physicalBackupTemplateRef.withName

withName(name)

obj spec.replication.replica.bootstrapFrom.restoreJob

"RestoreJob defines additional properties for the Job used to perform the restoration."

fn spec.replication.replica.bootstrapFrom.restoreJob.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.replication.replica.bootstrapFrom.restoreJob.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.replication.replica.bootstrapFrom.restoreJob.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector to be used in the Pod."

fn spec.replication.replica.bootstrapFrom.restoreJob.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.replication.replica.bootstrapFrom.restoreJob.withTolerations

withTolerations(tolerations)

"Tolerations to be used in the Pod."

fn spec.replication.replica.bootstrapFrom.restoreJob.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations to be used in the Pod."

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity

"Affinity to be used in the Pod."

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.withAntiAffinityEnabled

withAntiAffinityEnabled(antiAffinityEnabled)

"AntiAffinityEnabled configures PodAntiAffinity so each Pod is scheduled in a different Node, enabling HA.\nMake sure you have at least as many Nodes available as the replicas to not end up with unscheduled Pods."

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeaffinity-v1-core"

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselectorterm-v1-core"

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselector-v1-core"

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podantiaffinity-v1-core."

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podaffinityterm-v1-core."

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.replication.replica.bootstrapFrom.restoreJob.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.metadata

"Metadata defines additional metadata for the bootstrap Jobs."

fn spec.replication.replica.bootstrapFrom.restoreJob.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.replication.replica.bootstrapFrom.restoreJob.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.replication.replica.bootstrapFrom.restoreJob.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.replication.replica.bootstrapFrom.restoreJob.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.resources

"Resources describes the compute resource requirements."

fn spec.replication.replica.bootstrapFrom.restoreJob.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.replication.replica.bootstrapFrom.restoreJob.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.replication.replica.bootstrapFrom.restoreJob.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.replication.replica.bootstrapFrom.restoreJob.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.replication.replica.bootstrapFrom.restoreJob.tolerations

"Tolerations to be used in the Pod."

fn spec.replication.replica.bootstrapFrom.restoreJob.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.replication.replica.bootstrapFrom.restoreJob.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.replication.replica.bootstrapFrom.restoreJob.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.replication.replica.bootstrapFrom.restoreJob.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.replication.replica.bootstrapFrom.restoreJob.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.replication.replica.recovery

"ReplicaRecovery defines how the replicas should be recovered after they enter an error state.\nThis process deletes data from faulty replicas and recreates them using the source defined in the bootstrapFrom field.\nIt is disabled by default, and it requires the bootstrapFrom field to be set."

fn spec.replication.replica.recovery.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable replica recovery."

fn spec.replication.replica.recovery.withErrorDurationThreshold

withErrorDurationThreshold(errorDurationThreshold)

"ErrorDurationThreshold defines the time duration after which, if a replica continues to report errors,\nthe operator will initiate the recovery process for that replica.\nThis threshold applies only to error codes not identified as recoverable by the operator.\nErrors identified as recoverable will trigger the recovery process immediately.\nIt defaults to 5 minutes."

obj spec.replication.replica.replPasswordSecretKeyRef

"ReplPasswordSecretKeyRef provides a reference to the Secret to use as password for the replication user.\nBy default, a random password will be generated."

fn spec.replication.replica.replPasswordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.replication.replica.replPasswordSecretKeyRef.withKey

withKey(key)

fn spec.replication.replica.replPasswordSecretKeyRef.withName

withName(name)

obj spec.resources

"Resources describes the compute resource requirements."

fn spec.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.rootPasswordSecretKeyRef

"RootPasswordSecretKeyRef is a reference to a Secret key containing the root password."

fn spec.rootPasswordSecretKeyRef.withGenerate

withGenerate(generate)

"Generate indicates whether the Secret should be generated if the Secret referenced is not present."

fn spec.rootPasswordSecretKeyRef.withKey

withKey(key)

fn spec.rootPasswordSecretKeyRef.withName

withName(name)

obj spec.secondaryConnection

"SecondaryConnection defines a template to configure the secondary Connection object.\nThis Connection provides the initial User access to the initial Database.\nIt will make use of the SecondaryService to route network traffic to the secondary Pods."

fn spec.secondaryConnection.withParams

withParams(params)

"Params to be used in the Connection."

fn spec.secondaryConnection.withParamsMixin

withParamsMixin(params)

"Params to be used in the Connection."

Note: This function appends passed data to existing values

fn spec.secondaryConnection.withPort

withPort(port)

"Port to connect to. If not provided, it defaults to the MariaDB port or to the first MaxScale listener."

fn spec.secondaryConnection.withSecretName

withSecretName(secretName)

"SecretName to be used in the Connection."

fn spec.secondaryConnection.withServiceName

withServiceName(serviceName)

"ServiceName to be used in the Connection."

obj spec.secondaryConnection.healthCheck

"HealthCheck to be used in the Connection."

fn spec.secondaryConnection.healthCheck.withInterval

withInterval(interval)

"Interval used to perform health checks."

fn spec.secondaryConnection.healthCheck.withRetryInterval

withRetryInterval(retryInterval)

"RetryInterval is the interval used to perform health check retries."

obj spec.secondaryConnection.secretTemplate

"SecretTemplate to be used in the Connection."

fn spec.secondaryConnection.secretTemplate.withDatabaseKey

withDatabaseKey(databaseKey)

"DatabaseKey to be used in the Secret."

fn spec.secondaryConnection.secretTemplate.withFormat

withFormat(format)

"Format to be used in the Secret."

fn spec.secondaryConnection.secretTemplate.withHostKey

withHostKey(hostKey)

"HostKey to be used in the Secret."

fn spec.secondaryConnection.secretTemplate.withKey

withKey(key)

"Key to be used in the Secret."

fn spec.secondaryConnection.secretTemplate.withPasswordKey

withPasswordKey(passwordKey)

"PasswordKey to be used in the Secret."

fn spec.secondaryConnection.secretTemplate.withPortKey

withPortKey(portKey)

"PortKey to be used in the Secret."

fn spec.secondaryConnection.secretTemplate.withUsernameKey

withUsernameKey(usernameKey)

"UsernameKey to be used in the Secret."

obj spec.secondaryConnection.secretTemplate.metadata

"Metadata to be added to the Secret object."

fn spec.secondaryConnection.secretTemplate.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.secondaryConnection.secretTemplate.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.secondaryConnection.secretTemplate.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.secondaryConnection.secretTemplate.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.secondaryService

"SecondaryService defines a template to configure the secondary Service object.\nThe network traffic of this Service will be routed to the secondary Pods."

fn spec.secondaryService.withAllocateLoadBalancerNodePorts

withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts)

"AllocateLoadBalancerNodePorts Service field."

fn spec.secondaryService.withExternalTrafficPolicy

withExternalTrafficPolicy(externalTrafficPolicy)

"ExternalTrafficPolicy Service field."

fn spec.secondaryService.withLoadBalancerIP

withLoadBalancerIP(loadBalancerIP)

"LoadBalancerIP Service field."

fn spec.secondaryService.withLoadBalancerSourceRanges

withLoadBalancerSourceRanges(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

fn spec.secondaryService.withLoadBalancerSourceRangesMixin

withLoadBalancerSourceRangesMixin(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

Note: This function appends passed data to existing values

fn spec.secondaryService.withSessionAffinity

withSessionAffinity(sessionAffinity)

"SessionAffinity Service field."

fn spec.secondaryService.withType

withType(type)

"Type is the Service type. One of ClusterIP, NodePort or LoadBalancer. If not defined, it defaults to ClusterIP."

obj spec.secondaryService.metadata

"Metadata to be added to the Service metadata."

fn spec.secondaryService.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.secondaryService.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.secondaryService.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.secondaryService.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.securityContext

"SecurityContext holds security configuration that will be applied to a container."

fn spec.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

fn spec.securityContext.withPrivileged

withPrivileged(privileged)

fn spec.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

fn spec.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.securityContext.withRunAsUser

withRunAsUser(runAsUser)

obj spec.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn spec.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.service

"Service defines a template to configure the general Service object.\nThe network traffic of this Service will be routed to all Pods."

fn spec.service.withAllocateLoadBalancerNodePorts

withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts)

"AllocateLoadBalancerNodePorts Service field."

fn spec.service.withExternalTrafficPolicy

withExternalTrafficPolicy(externalTrafficPolicy)

"ExternalTrafficPolicy Service field."

fn spec.service.withLoadBalancerIP

withLoadBalancerIP(loadBalancerIP)

"LoadBalancerIP Service field."

fn spec.service.withLoadBalancerSourceRanges

withLoadBalancerSourceRanges(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

fn spec.service.withLoadBalancerSourceRangesMixin

withLoadBalancerSourceRangesMixin(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

Note: This function appends passed data to existing values

fn spec.service.withSessionAffinity

withSessionAffinity(sessionAffinity)

"SessionAffinity Service field."

fn spec.service.withType

withType(type)

"Type is the Service type. One of ClusterIP, NodePort or LoadBalancer. If not defined, it defaults to ClusterIP."

obj spec.service.metadata

"Metadata to be added to the Service metadata."

fn spec.service.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.service.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.service.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.service.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.servicePorts

"ServicePorts is the list of additional named ports to be added to the Services created by the operator."

fn spec.servicePorts.withName

withName(name)

fn spec.servicePorts.withPort

withPort(port)

obj spec.sidecarContainers

"SidecarContainers to be used in the Pod."

fn spec.sidecarContainers.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.sidecarContainers.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.sidecarContainers.withCommand

withCommand(command)

"Command to be used in the Container."

fn spec.sidecarContainers.withCommandMixin

withCommandMixin(command)

"Command to be used in the Container."

Note: This function appends passed data to existing values

fn spec.sidecarContainers.withEnv

withEnv(env)

"Env represents the environment variables to be injected in a container."

fn spec.sidecarContainers.withEnvMixin

withEnvMixin(env)

"Env represents the environment variables to be injected in a container."

Note: This function appends passed data to existing values

fn spec.sidecarContainers.withImage

withImage(image)

"Image name to be used by the container. The supported format is <image>:<tag>."

fn spec.sidecarContainers.withImagePullPolicy

withImagePullPolicy(imagePullPolicy)

"ImagePullPolicy is the image pull policy. One of Always, Never or IfNotPresent. If not defined, it defaults to IfNotPresent."

fn spec.sidecarContainers.withName

withName(name)

"Name to be given to the container."

fn spec.sidecarContainers.withVolumeMounts

withVolumeMounts(volumeMounts)

"VolumeMounts to be used in the Container."

fn spec.sidecarContainers.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"VolumeMounts to be used in the Container."

Note: This function appends passed data to existing values

obj spec.sidecarContainers.env

"Env represents the environment variables to be injected in a container."

fn spec.sidecarContainers.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.sidecarContainers.env.withValue

withValue(value)

obj spec.sidecarContainers.env.valueFrom

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#envvarsource-v1-core."

obj spec.sidecarContainers.env.valueFrom.configMapKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#configmapkeyselector-v1-core."

fn spec.sidecarContainers.env.valueFrom.configMapKeyRef.withKey

withKey(key)

fn spec.sidecarContainers.env.valueFrom.configMapKeyRef.withName

withName(name)

obj spec.sidecarContainers.env.valueFrom.fieldRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectfieldselector-v1-core."

fn spec.sidecarContainers.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

fn spec.sidecarContainers.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

obj spec.sidecarContainers.env.valueFrom.secretKeyRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#secretkeyselector-v1-core."

fn spec.sidecarContainers.env.valueFrom.secretKeyRef.withKey

withKey(key)

fn spec.sidecarContainers.env.valueFrom.secretKeyRef.withName

withName(name)

obj spec.sidecarContainers.resources

"Resources describes the compute resource requirements."

fn spec.sidecarContainers.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.sidecarContainers.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.sidecarContainers.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.sidecarContainers.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.sidecarContainers.volumeMounts

"VolumeMounts to be used in the Container."

fn spec.sidecarContainers.volumeMounts.withMountPath

withMountPath(mountPath)

fn spec.sidecarContainers.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.sidecarContainers.volumeMounts.withReadOnly

withReadOnly(readOnly)

fn spec.sidecarContainers.volumeMounts.withSubPath

withSubPath(subPath)

obj spec.startupProbe

"StartupProbe to be used in the Container."

fn spec.startupProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

fn spec.startupProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

fn spec.startupProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

fn spec.startupProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

fn spec.startupProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

obj spec.startupProbe.exec

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#execaction-v1-core."

fn spec.startupProbe.exec.withCommand

withCommand(command)

fn spec.startupProbe.exec.withCommandMixin

withCommandMixin(command)

Note: This function appends passed data to existing values

obj spec.startupProbe.httpGet

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#httpgetaction-v1-core."

fn spec.startupProbe.httpGet.withHost

withHost(host)

fn spec.startupProbe.httpGet.withPath

withPath(path)

fn spec.startupProbe.httpGet.withPort

withPort(port)

fn spec.startupProbe.httpGet.withScheme

withScheme(scheme)

"URIScheme identifies the scheme used for connection to a host for Get actions"

obj spec.startupProbe.tcpSocket

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#tcpsocketaction-v1-core."

fn spec.startupProbe.tcpSocket.withHost

withHost(host)

fn spec.startupProbe.tcpSocket.withPort

withPort(port)

obj spec.storage

"Storage defines the storage options to be used for provisioning the PVCs mounted by MariaDB."

fn spec.storage.withEphemeral

withEphemeral(ephemeral)

"Ephemeral indicates whether to use ephemeral storage in the PVCs. It is only compatible with non HA MariaDBs."

fn spec.storage.withResizeInUseVolumes

withResizeInUseVolumes(resizeInUseVolumes)

"ResizeInUseVolumes indicates whether the PVCs can be resized. The 'StorageClassName' used should have 'allowVolumeExpansion' set to 'true' to allow resizing.\nIt defaults to true."

fn spec.storage.withSize

withSize(size)

"Size of the PVCs to be mounted by MariaDB. Required if not provided in 'VolumeClaimTemplate'. It supersedes the storage size specified in 'VolumeClaimTemplate'."

fn spec.storage.withStorageClassName

withStorageClassName(storageClassName)

"StorageClassName to be used to provision the PVCS. It supersedes the 'StorageClassName' specified in 'VolumeClaimTemplate'.\nIf not provided, the default 'StorageClass' configured in the cluster is used."

fn spec.storage.withWaitForVolumeResize

withWaitForVolumeResize(waitForVolumeResize)

"WaitForVolumeResize indicates whether to wait for the PVCs to be resized before marking the MariaDB object as ready. This will block other operations such as cluster recovery while the resize is in progress.\nIt defaults to true."

obj spec.storage.volumeClaimTemplate

"VolumeClaimTemplate provides a template to define the PVCs."

fn spec.storage.volumeClaimTemplate.withAccessModes

withAccessModes(accessModes)

fn spec.storage.volumeClaimTemplate.withAccessModesMixin

withAccessModesMixin(accessModes)

Note: This function appends passed data to existing values

fn spec.storage.volumeClaimTemplate.withStorageClassName

withStorageClassName(storageClassName)

obj spec.storage.volumeClaimTemplate.metadata

"Metadata to be added to the PVC metadata."

fn spec.storage.volumeClaimTemplate.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.storage.volumeClaimTemplate.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.storage.volumeClaimTemplate.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.storage.volumeClaimTemplate.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.storage.volumeClaimTemplate.resources

"VolumeResourceRequirements describes the storage resource requirements for a volume."

fn spec.storage.volumeClaimTemplate.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.storage.volumeClaimTemplate.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.storage.volumeClaimTemplate.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.storage.volumeClaimTemplate.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

obj spec.storage.volumeClaimTemplate.selector

"A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects."

fn spec.storage.volumeClaimTemplate.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.storage.volumeClaimTemplate.selector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.storage.volumeClaimTemplate.selector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.storage.volumeClaimTemplate.selector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.storage.volumeClaimTemplate.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.storage.volumeClaimTemplate.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.storage.volumeClaimTemplate.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.storage.volumeClaimTemplate.selector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.storage.volumeClaimTemplate.selector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.tls

"TLS defines the PKI to be used with MariaDB."

fn spec.tls.withEnabled

withEnabled(enabled)

"Enabled indicates whether TLS is enabled, determining if certificates should be issued and mounted to the MariaDB instance.\nIt is enabled by default."

fn spec.tls.withGaleraSSTEnabled

withGaleraSSTEnabled(galeraSSTEnabled)

"GaleraSSTEnabled determines whether Galera SST connections should use TLS.\nIt disabled by default."

fn spec.tls.withRequired

withRequired(required)

"Required specifies whether TLS must be enforced for all connections.\nUser TLS requirements take precedence over this.\nIt disabled by default."

obj spec.tls.clientCASecretRef

"ClientCASecretRef is a reference to a Secret containing the client certificate authority keypair. It is used to establish trust and issue client certificates.\nOne of:\n- Secret containing both the 'ca.crt' and 'ca.key' keys. This allows you to bring your own CA to Kubernetes to issue certificates.\n- Secret containing only the 'ca.crt' in order to establish trust. In this case, either clientCertSecretRef or clientCertIssuerRef fields must be provided.\nIf not provided, a self-signed CA will be provisioned to issue the client certificate."

fn spec.tls.clientCASecretRef.withName

withName(name)

obj spec.tls.clientCertIssuerRef

"ClientCertIssuerRef is a reference to a cert-manager issuer object used to issue the client certificate. cert-manager must be installed previously in the cluster.\nIt is mutually exclusive with clientCertSecretRef.\nBy default, the Secret field 'ca.crt' provisioned by cert-manager will be added to the trust chain. A custom trust bundle may be specified via clientCASecretRef."

fn spec.tls.clientCertIssuerRef.withGroup

withGroup(group)

"Group of the resource being referred to."

fn spec.tls.clientCertIssuerRef.withKind

withKind(kind)

"Kind of the resource being referred to."

fn spec.tls.clientCertIssuerRef.withName

withName(name)

"Name of the resource being referred to."

obj spec.tls.clientCertSecretRef

"ClientCertSecretRef is a reference to a TLS Secret containing the client certificate.\nIt is mutually exclusive with clientCertIssuerRef."

fn spec.tls.clientCertSecretRef.withName

withName(name)

obj spec.tls.serverCASecretRef

"ServerCASecretRef is a reference to a Secret containing the server certificate authority keypair. It is used to establish trust and issue server certificates.\nOne of:\n- Secret containing both the 'ca.crt' and 'ca.key' keys. This allows you to bring your own CA to Kubernetes to issue certificates.\n- Secret containing only the 'ca.crt' in order to establish trust. In this case, either serverCertSecretRef or serverCertIssuerRef must be provided.\nIf not provided, a self-signed CA will be provisioned to issue the server certificate."

fn spec.tls.serverCASecretRef.withName

withName(name)

obj spec.tls.serverCertIssuerRef

"ServerCertIssuerRef is a reference to a cert-manager issuer object used to issue the server certificate. cert-manager must be installed previously in the cluster.\nIt is mutually exclusive with serverCertSecretRef.\nBy default, the Secret field 'ca.crt' provisioned by cert-manager will be added to the trust chain. A custom trust bundle may be specified via serverCASecretRef."

fn spec.tls.serverCertIssuerRef.withGroup

withGroup(group)

"Group of the resource being referred to."

fn spec.tls.serverCertIssuerRef.withKind

withKind(kind)

"Kind of the resource being referred to."

fn spec.tls.serverCertIssuerRef.withName

withName(name)

"Name of the resource being referred to."

obj spec.tls.serverCertSecretRef

"ServerCertSecretRef is a reference to a TLS Secret containing the server certificate.\nIt is mutually exclusive with serverCertIssuerRef."

fn spec.tls.serverCertSecretRef.withName

withName(name)

obj spec.tolerations

"Tolerations to be used in the Pod."

fn spec.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.topologySpreadConstraints

"TopologySpreadConstraints to be used in the Pod."

fn spec.topologySpreadConstraints.withMatchLabelKeys

withMatchLabelKeys(matchLabelKeys)

fn spec.topologySpreadConstraints.withMatchLabelKeysMixin

withMatchLabelKeysMixin(matchLabelKeys)

Note: This function appends passed data to existing values

fn spec.topologySpreadConstraints.withMaxSkew

withMaxSkew(maxSkew)

fn spec.topologySpreadConstraints.withMinDomains

withMinDomains(minDomains)

fn spec.topologySpreadConstraints.withNodeAffinityPolicy

withNodeAffinityPolicy(nodeAffinityPolicy)

"NodeInclusionPolicy defines the type of node inclusion policy"

fn spec.topologySpreadConstraints.withNodeTaintsPolicy

withNodeTaintsPolicy(nodeTaintsPolicy)

"NodeInclusionPolicy defines the type of node inclusion policy"

fn spec.topologySpreadConstraints.withTopologyKey

withTopologyKey(topologyKey)

fn spec.topologySpreadConstraints.withWhenUnsatisfiable

withWhenUnsatisfiable(whenUnsatisfiable)

obj spec.topologySpreadConstraints.labelSelector

"A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects."

fn spec.topologySpreadConstraints.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.topologySpreadConstraints.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.topologySpreadConstraints.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.topologySpreadConstraints.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.topologySpreadConstraints.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.updateStrategy

"UpdateStrategy defines how a MariaDB resource is updated."

fn spec.updateStrategy.withAutoUpdateDataPlane

withAutoUpdateDataPlane(autoUpdateDataPlane)

"AutoUpdateDataPlane indicates whether the Galera data-plane version (agent and init containers) should be automatically updated based on the operator version. It defaults to false.\nUpdating the operator will trigger updates on all the MariaDB instances that have this flag set to true. Thus, it is recommended to progressively set this flag after having updated the operator."

fn spec.updateStrategy.withType

withType(type)

"Type defines the type of updates. One of ReplicasFirstPrimaryLast, RollingUpdate or OnDelete. If not defined, it defaults to ReplicasFirstPrimaryLast."

obj spec.updateStrategy.rollingUpdate

"RollingUpdate defines parameters for the RollingUpdate type."

fn spec.updateStrategy.rollingUpdate.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

"The maximum number of pods that can be unavailable during the update.\nValue can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nAbsolute number is calculated from percentage by rounding up. This can not be 0.\nDefaults to 1. This field is alpha-level and is only honored by servers that enable the\nMaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to\nReplicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it\nwill be counted towards MaxUnavailable."

fn spec.updateStrategy.rollingUpdate.withPartition

withPartition(partition)

"Partition indicates the ordinal at which the StatefulSet should be partitioned\nfor updates. During a rolling update, all pods from ordinal Replicas-1 to\nPartition are updated. All pods from ordinal Partition-1 to 0 remain untouched.\nThis is helpful in being able to do a canary based deployment. The default value is 0."

obj spec.volumeMounts

"VolumeMounts to be used in the Container."

fn spec.volumeMounts.withMountPath

withMountPath(mountPath)

fn spec.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.volumeMounts.withReadOnly

withReadOnly(readOnly)

fn spec.volumeMounts.withSubPath

withSubPath(subPath)

obj spec.volumes

"Volumes to be used in the Pod."

fn spec.volumes.withName

withName(name)

obj spec.volumes.configMap

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#configmapvolumesource-v1-core."

fn spec.volumes.configMap.withDefaultMode

withDefaultMode(defaultMode)

fn spec.volumes.configMap.withName

withName(name)

obj spec.volumes.csi

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#csivolumesource-v1-core."

fn spec.volumes.csi.withDriver

withDriver(driver)

fn spec.volumes.csi.withFsType

withFsType(fsType)

fn spec.volumes.csi.withReadOnly

withReadOnly(readOnly)

fn spec.volumes.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

fn spec.volumes.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

Note: This function appends passed data to existing values

obj spec.volumes.csi.nodePublishSecretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.volumes.csi.nodePublishSecretRef.withName

withName(name)

obj spec.volumes.emptyDir

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#emptydirvolumesource-v1-core."

fn spec.volumes.emptyDir.withMedium

withMedium(medium)

"StorageMedium defines ways that storage can be allocated to a volume."

fn spec.volumes.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

obj spec.volumes.hostPath

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#hostpathvolumesource-v1-core"

fn spec.volumes.hostPath.withPath

withPath(path)

fn spec.volumes.hostPath.withType

withType(type)

obj spec.volumes.nfs

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nfsvolumesource-v1-core."

fn spec.volumes.nfs.withPath

withPath(path)

fn spec.volumes.nfs.withReadOnly

withReadOnly(readOnly)

fn spec.volumes.nfs.withServer

withServer(server)

obj spec.volumes.persistentVolumeClaim

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#persistentvolumeclaimvolumesource-v1-core."

fn spec.volumes.persistentVolumeClaim.withClaimName

withClaimName(claimName)

fn spec.volumes.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

obj spec.volumes.secret

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#secretvolumesource-v1-core."

fn spec.volumes.secret.withDefaultMode

withDefaultMode(defaultMode)

fn spec.volumes.secret.withSecretName

withSecretName(secretName)