k8s.v1alpha1.maxScale

"MaxScale is the Schema for the maxscales API. It is used to define MaxScale clusters."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of MaxScale

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

"MaxScaleSpec defines the desired state of MaxScale."

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.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 MaxScale instances. The supported format is <image>:<tag>.\nOnly MaxScale 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.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.withPrimaryServer

withPrimaryServer(primaryServer)

"PrimaryServer specifies the desired primary server. Setting this field triggers a switchover operation in MaxScale to the desired server.\nThis option is only valid when using monitors that support switchover, currently limited to the MariaDB monitor."

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.withRequeueInterval

withRequeueInterval(requeueInterval)

"RequeueInterval is used to perform requeue reconciliations. If not defined, it defaults to 10s."

fn spec.withServers

withServers(servers)

"Servers are the MariaDB servers to forward traffic to. It is required if 'spec.mariaDbRef' is not provided."

fn spec.withServersMixin

withServersMixin(servers)

"Servers are the MariaDB servers to forward traffic to. It is required if 'spec.mariaDbRef' is not provided."

Note: This function appends passed data to existing values

fn spec.withServiceAccountName

withServiceAccountName(serviceAccountName)

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

fn spec.withServices

withServices(services)

"Services define how the traffic is forwarded to the MariaDB servers. It is defaulted if not provided."

fn spec.withServicesMixin

withServicesMixin(services)

"Services define how the traffic is forwarded to the MariaDB servers. It is defaulted if not provided."

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.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.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

obj spec.admin

"Admin configures the admin REST API and GUI."

fn spec.admin.withGuiEnabled

withGuiEnabled(guiEnabled)

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

fn spec.admin.withPort

withPort(port)

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

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.auth

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

fn spec.auth.withAdminUsername

withAdminUsername(adminUsername)

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

fn spec.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.auth.withClientUsername

withClientUsername(clientUsername)

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

fn spec.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.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.auth.withMetricsUsername

withMetricsUsername(metricsUsername)

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

fn spec.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.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.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.auth.withServerUsername

withServerUsername(serverUsername)

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

fn spec.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.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.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.auth.adminPasswordSecretKeyRef.withGenerate

withGenerate(generate)

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

fn spec.auth.adminPasswordSecretKeyRef.withKey

withKey(key)

fn spec.auth.adminPasswordSecretKeyRef.withName

withName(name)

obj spec.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.auth.clientPasswordSecretKeyRef.withGenerate

withGenerate(generate)

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

fn spec.auth.clientPasswordSecretKeyRef.withKey

withKey(key)

fn spec.auth.clientPasswordSecretKeyRef.withName

withName(name)

obj spec.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.auth.metricsPasswordSecretKeyRef.withGenerate

withGenerate(generate)

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

fn spec.auth.metricsPasswordSecretKeyRef.withKey

withKey(key)

fn spec.auth.metricsPasswordSecretKeyRef.withName

withName(name)

obj spec.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.auth.monitorPasswordSecretKeyRef.withGenerate

withGenerate(generate)

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

fn spec.auth.monitorPasswordSecretKeyRef.withKey

withKey(key)

fn spec.auth.monitorPasswordSecretKeyRef.withName

withName(name)

obj spec.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.auth.serverPasswordSecretKeyRef.withGenerate

withGenerate(generate)

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

fn spec.auth.serverPasswordSecretKeyRef.withKey

withKey(key)

fn spec.auth.serverPasswordSecretKeyRef.withName

withName(name)

obj spec.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.auth.syncPasswordSecretKeyRef.withGenerate

withGenerate(generate)

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

fn spec.auth.syncPasswordSecretKeyRef.withKey

withKey(key)

fn spec.auth.syncPasswordSecretKeyRef.withName

withName(name)

obj spec.config

"Config defines the MaxScale configuration."

fn spec.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.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.config.sync

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

fn spec.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.config.sync.withInterval

withInterval(interval)

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

fn spec.config.sync.withTimeout

withTimeout(timeout)

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

obj spec.config.volumeClaimTemplate

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

fn spec.config.volumeClaimTemplate.withAccessModes

withAccessModes(accessModes)

fn spec.config.volumeClaimTemplate.withAccessModesMixin

withAccessModesMixin(accessModes)

Note: This function appends passed data to existing values

fn spec.config.volumeClaimTemplate.withStorageClassName

withStorageClassName(storageClassName)

obj spec.config.volumeClaimTemplate.metadata

"Metadata to be added to the PVC metadata."

fn spec.config.volumeClaimTemplate.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.config.volumeClaimTemplate.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.config.volumeClaimTemplate.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.config.volumeClaimTemplate.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.config.volumeClaimTemplate.resources

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

fn spec.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.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.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.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.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.config.volumeClaimTemplate.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

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

fn spec.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.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.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.config.volumeClaimTemplate.selector.matchExpressions

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

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

withKey(key)

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

fn spec.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.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.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.connection

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

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.guiKubernetesService

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

fn spec.guiKubernetesService.withAllocateLoadBalancerNodePorts

withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts)

"AllocateLoadBalancerNodePorts Service field."

fn spec.guiKubernetesService.withExternalTrafficPolicy

withExternalTrafficPolicy(externalTrafficPolicy)

"ExternalTrafficPolicy Service field."

fn spec.guiKubernetesService.withLoadBalancerIP

withLoadBalancerIP(loadBalancerIP)

"LoadBalancerIP Service field."

fn spec.guiKubernetesService.withLoadBalancerSourceRanges

withLoadBalancerSourceRanges(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

fn spec.guiKubernetesService.withLoadBalancerSourceRangesMixin

withLoadBalancerSourceRangesMixin(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

Note: This function appends passed data to existing values

fn spec.guiKubernetesService.withSessionAffinity

withSessionAffinity(sessionAffinity)

"SessionAffinity Service field."

fn spec.guiKubernetesService.withType

withType(type)

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

obj spec.guiKubernetesService.metadata

"Metadata to be added to the Service metadata."

fn spec.guiKubernetesService.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.guiKubernetesService.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.guiKubernetesService.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.guiKubernetesService.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

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.kubernetesService

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

fn spec.kubernetesService.withAllocateLoadBalancerNodePorts

withAllocateLoadBalancerNodePorts(allocateLoadBalancerNodePorts)

"AllocateLoadBalancerNodePorts Service field."

fn spec.kubernetesService.withExternalTrafficPolicy

withExternalTrafficPolicy(externalTrafficPolicy)

"ExternalTrafficPolicy Service field."

fn spec.kubernetesService.withLoadBalancerIP

withLoadBalancerIP(loadBalancerIP)

"LoadBalancerIP Service field."

fn spec.kubernetesService.withLoadBalancerSourceRanges

withLoadBalancerSourceRanges(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

fn spec.kubernetesService.withLoadBalancerSourceRangesMixin

withLoadBalancerSourceRangesMixin(loadBalancerSourceRanges)

"LoadBalancerSourceRanges Service field."

Note: This function appends passed data to existing values

fn spec.kubernetesService.withSessionAffinity

withSessionAffinity(sessionAffinity)

"SessionAffinity Service field."

fn spec.kubernetesService.withType

withType(type)

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

obj spec.kubernetesService.metadata

"Metadata to be added to the Service metadata."

fn spec.kubernetesService.metadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.kubernetesService.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.kubernetesService.metadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.kubernetesService.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

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.mariaDbRef

"MariaDBRef is a reference to the MariaDB that MaxScale points to. It is used to initialize the servers field."

fn spec.mariaDbRef.withKind

withKind(kind)

"Kind of the referent."

fn spec.mariaDbRef.withName

withName(name)

fn spec.mariaDbRef.withNamespace

withNamespace(namespace)

fn spec.mariaDbRef.withWaitForIt

withWaitForIt(waitForIt)

"WaitForIt indicates whether the controller using this reference should wait for MariaDB to be ready."

obj spec.metrics

"Metrics configures metrics and how to scrape them."

fn spec.metrics.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable Metrics"

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.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.monitor

"Monitor monitors MariaDB server instances. It is required if 'spec.mariaDbRef' is not provided."

fn spec.monitor.withCooperativeMonitoring

withCooperativeMonitoring(cooperativeMonitoring)

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

fn spec.monitor.withInterval

withInterval(interval)

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

fn spec.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.monitor.withName

withName(name)

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

fn spec.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.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.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.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.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.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.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.servers

"Servers are the MariaDB servers to forward traffic to. It is required if 'spec.mariaDbRef' is not provided."

fn spec.servers.withAddress

withAddress(address)

"Address is the network address of the MariaDB server."

fn spec.servers.withMaintenance

withMaintenance(maintenance)

"Maintenance indicates whether the server is in maintenance mode."

fn spec.servers.withName

withName(name)

"Name is the identifier of the MariaDB server."

fn spec.servers.withParams

withParams(params)

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

fn spec.servers.withParamsMixin

withParamsMixin(params)

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

Note: This function appends passed data to existing values

fn spec.servers.withPort

withPort(port)

"Port is the network port of the MariaDB server. If not provided, it defaults to 3306."

fn spec.servers.withProtocol

withProtocol(protocol)

"Protocol is the MaxScale protocol to use when communicating with this MariaDB server. If not provided, it defaults to MariaDBBackend."

obj spec.services

"Services define how the traffic is forwarded to the MariaDB servers. It is defaulted if not provided."

fn spec.services.withName

withName(name)

"Name is the identifier of the MaxScale service."

fn spec.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.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.services.withRouter

withRouter(router)

"Router is the type of router to use."

fn spec.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.services.listener

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

fn spec.services.listener.withName

withName(name)

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

fn spec.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.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.services.listener.withPort

withPort(port)

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

fn spec.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.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.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.tls

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

fn spec.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.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.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.tls.withVerifyPeerHost

withVerifyPeerHost(verifyPeerHost)

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

obj spec.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.tls.adminCASecretRef.withName

withName(name)

obj spec.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.tls.adminCertIssuerRef.withGroup

withGroup(group)

"Group of the resource being referred to."

fn spec.tls.adminCertIssuerRef.withKind

withKind(kind)

"Kind of the resource being referred to."

fn spec.tls.adminCertIssuerRef.withName

withName(name)

"Name of the resource being referred to."

obj spec.tls.adminCertSecretRef

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

fn spec.tls.adminCertSecretRef.withName

withName(name)

obj spec.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.tls.listenerCASecretRef.withName

withName(name)

obj spec.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.tls.listenerCertIssuerRef.withGroup

withGroup(group)

"Group of the resource being referred to."

fn spec.tls.listenerCertIssuerRef.withKind

withKind(kind)

"Kind of the resource being referred to."

fn spec.tls.listenerCertIssuerRef.withName

withName(name)

"Name of the resource being referred to."

obj spec.tls.listenerCertSecretRef

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

fn spec.tls.listenerCertSecretRef.withName

withName(name)

obj spec.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.tls.serverCASecretRef.withName

withName(name)

obj spec.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.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 the update strategy for the StatefulSet object."

fn spec.updateStrategy.withType

withType(type)

"Type indicates the type of the StatefulSetUpdateStrategy.\nDefault is RollingUpdate."

obj spec.updateStrategy.rollingUpdate

"RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType."

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)