cluster.v1beta1.clusterClass

"ClusterClass is a template which can be used to create managed topologies."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of ClusterClass

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

"spec is the desired state of ClusterClass."

fn spec.withAvailabilityGates

withAvailabilityGates(availabilityGates)

"availabilityGates specifies additional conditions to include when evaluating Cluster Available condition.\n\nNOTE: this field is considered only for computing v1beta2 conditions.\nNOTE: If a Cluster is using this ClusterClass, and this Cluster defines a custom list of availabilityGates,\nsuch list overrides availabilityGates defined in this field."

fn spec.withAvailabilityGatesMixin

withAvailabilityGatesMixin(availabilityGates)

"availabilityGates specifies additional conditions to include when evaluating Cluster Available condition.\n\nNOTE: this field is considered only for computing v1beta2 conditions.\nNOTE: If a Cluster is using this ClusterClass, and this Cluster defines a custom list of availabilityGates,\nsuch list overrides availabilityGates defined in this field."

Note: This function appends passed data to existing values

fn spec.withKubernetesVersions

withKubernetesVersions(kubernetesVersions)

"kubernetesVersions is the list of Kubernetes versions that can be\nused for clusters using this ClusterClass.\nThe list of version must be ordered from the older to the newer version, and there should be\nat least one version for every minor in between the first and the last version."

fn spec.withKubernetesVersionsMixin

withKubernetesVersionsMixin(kubernetesVersions)

"kubernetesVersions is the list of Kubernetes versions that can be\nused for clusters using this ClusterClass.\nThe list of version must be ordered from the older to the newer version, and there should be\nat least one version for every minor in between the first and the last version."

Note: This function appends passed data to existing values

fn spec.withPatches

withPatches(patches)

"patches defines the patches which are applied to customize\nreferenced templates of a ClusterClass.\nNote: Patches will be applied in the order of the array."

fn spec.withPatchesMixin

withPatchesMixin(patches)

"patches defines the patches which are applied to customize\nreferenced templates of a ClusterClass.\nNote: Patches will be applied in the order of the array."

Note: This function appends passed data to existing values

fn spec.withVariables

withVariables(variables)

"variables defines the variables which can be configured\nin the Cluster topology and are then used in patches."

fn spec.withVariablesMixin

withVariablesMixin(variables)

"variables defines the variables which can be configured\nin the Cluster topology and are then used in patches."

Note: This function appends passed data to existing values

obj spec.availabilityGates

"availabilityGates specifies additional conditions to include when evaluating Cluster Available condition.\n\nNOTE: this field is considered only for computing v1beta2 conditions.\nNOTE: If a Cluster is using this ClusterClass, and this Cluster defines a custom list of availabilityGates,\nsuch list overrides availabilityGates defined in this field."

fn spec.availabilityGates.withConditionType

withConditionType(conditionType)

"conditionType refers to a condition with matching type in the Cluster's condition list.\nIf the conditions doesn't exist, it will be treated as unknown.\nNote: Both Cluster API conditions or conditions added by 3rd party controllers can be used as availability gates."

fn spec.availabilityGates.withPolarity

withPolarity(polarity)

"polarity of the conditionType specified in this availabilityGate.\nValid values are Positive, Negative and omitted.\nWhen omitted, the default behaviour will be Positive.\nA positive polarity means that the condition should report a true status under normal conditions.\nA negative polarity means that the condition should report a false status under normal conditions."

obj spec.controlPlane

"controlPlane is a reference to a local struct that holds the details\nfor provisioning the Control Plane for the Cluster."

fn spec.controlPlane.withNodeDeletionTimeout

withNodeDeletionTimeout(nodeDeletionTimeout)

"nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine\nhosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely.\nDefaults to 10 seconds.\nNOTE: This value can be overridden while defining a Cluster.Topology."

fn spec.controlPlane.withNodeDrainTimeout

withNodeDrainTimeout(nodeDrainTimeout)

"nodeDrainTimeout is the total amount of time that the controller will spend on draining a node.\nThe default value is 0, meaning that the node can be drained without any time limitations.\nNOTE: NodeDrainTimeout is different from kubectl drain --timeout\nNOTE: This value can be overridden while defining a Cluster.Topology."

fn spec.controlPlane.withNodeVolumeDetachTimeout

withNodeVolumeDetachTimeout(nodeVolumeDetachTimeout)

"nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes\nto be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.\nNOTE: This value can be overridden while defining a Cluster.Topology."

fn spec.controlPlane.withReadinessGates

withReadinessGates(readinessGates)

"readinessGates specifies additional conditions to include when evaluating Machine Ready condition.\n\nThis field can be used e.g. to instruct the machine controller to include in the computation for Machine's ready\ncomputation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.\n\nNOTE: This field is considered only for computing v1beta2 conditions.\nNOTE: If a Cluster defines a custom list of readinessGates for the control plane,\nsuch list overrides readinessGates defined in this field.\nNOTE: Specific control plane provider implementations might automatically extend the list of readinessGates;\ne.g. the kubeadm control provider adds ReadinessGates for the APIServerPodHealthy, SchedulerPodHealthy conditions, etc."

fn spec.controlPlane.withReadinessGatesMixin

withReadinessGatesMixin(readinessGates)

"readinessGates specifies additional conditions to include when evaluating Machine Ready condition.\n\nThis field can be used e.g. to instruct the machine controller to include in the computation for Machine's ready\ncomputation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.\n\nNOTE: This field is considered only for computing v1beta2 conditions.\nNOTE: If a Cluster defines a custom list of readinessGates for the control plane,\nsuch list overrides readinessGates defined in this field.\nNOTE: Specific control plane provider implementations might automatically extend the list of readinessGates;\ne.g. the kubeadm control provider adds ReadinessGates for the APIServerPodHealthy, SchedulerPodHealthy conditions, etc."

Note: This function appends passed data to existing values

fn spec.controlPlane.withTaints

withTaints(taints)

"taints are the node taints that Cluster API will manage.\nThis list is not necessarily complete: other Kubernetes components may add or remove other taints from nodes,\ne.g. the node controller might add the node.kubernetes.io/not-ready taint.\nOnly those taints defined in this list will be added or removed by core Cluster API controllers.\n\nThere can be at most 64 taints.\nA pod would have to tolerate all existing taints to run on the corresponding node.\n\nNOTE: This list is implemented as a \"map\" type, meaning that individual elements can be managed by different owners."

fn spec.controlPlane.withTaintsMixin

withTaintsMixin(taints)

"taints are the node taints that Cluster API will manage.\nThis list is not necessarily complete: other Kubernetes components may add or remove other taints from nodes,\ne.g. the node controller might add the node.kubernetes.io/not-ready taint.\nOnly those taints defined in this list will be added or removed by core Cluster API controllers.\n\nThere can be at most 64 taints.\nA pod would have to tolerate all existing taints to run on the corresponding node.\n\nNOTE: This list is implemented as a \"map\" type, meaning that individual elements can be managed by different owners."

Note: This function appends passed data to existing values

obj spec.controlPlane.machineHealthCheck

"machineHealthCheck defines a MachineHealthCheck for this ControlPlaneClass.\nThis field is supported if and only if the ControlPlane provider template\nreferenced above is Machine based and supports setting replicas."

fn spec.controlPlane.machineHealthCheck.withMaxUnhealthy

withMaxUnhealthy(maxUnhealthy)

"maxUnhealthy specifies the maximum number of unhealthy machines allowed.\nAny further remediation is only allowed if at most \"maxUnhealthy\" machines selected by\n\"selector\" are not healthy."

fn spec.controlPlane.machineHealthCheck.withNodeStartupTimeout

withNodeStartupTimeout(nodeStartupTimeout)

"nodeStartupTimeout allows to set the maximum time for MachineHealthCheck\nto consider a Machine unhealthy if a corresponding Node isn't associated\nthrough a Spec.ProviderID field.\n\nThe duration set in this field is compared to the greatest of:\n- Cluster's infrastructure ready condition timestamp (if and when available)\n- Control Plane's initialized condition timestamp (if and when available)\n- Machine's infrastructure ready condition timestamp (if and when available)\n- Machine's metadata creation timestamp\n\nDefaults to 10 minutes.\nIf you wish to disable this feature, set the value explicitly to 0."

fn spec.controlPlane.machineHealthCheck.withUnhealthyConditions

withUnhealthyConditions(unhealthyConditions)

"unhealthyConditions contains a list of the conditions that determine\nwhether a node is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the node is unhealthy."

fn spec.controlPlane.machineHealthCheck.withUnhealthyConditionsMixin

withUnhealthyConditionsMixin(unhealthyConditions)

"unhealthyConditions contains a list of the conditions that determine\nwhether a node is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the node is unhealthy."

Note: This function appends passed data to existing values

fn spec.controlPlane.machineHealthCheck.withUnhealthyMachineConditions

withUnhealthyMachineConditions(unhealthyMachineConditions)

"unhealthyMachineConditions contains a list of the machine conditions that determine\nwhether a machine is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the machine is unhealthy."

fn spec.controlPlane.machineHealthCheck.withUnhealthyMachineConditionsMixin

withUnhealthyMachineConditionsMixin(unhealthyMachineConditions)

"unhealthyMachineConditions contains a list of the machine conditions that determine\nwhether a machine is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the machine is unhealthy."

Note: This function appends passed data to existing values

fn spec.controlPlane.machineHealthCheck.withUnhealthyRange

withUnhealthyRange(unhealthyRange)

"unhealthyRange specifies the range of unhealthy machines allowed.\nAny further remediation is only allowed if the number of machines selected by \"selector\" as not healthy\nis within the range of \"unhealthyRange\". Takes precedence over maxUnhealthy.\nEg. \"[3-5]\" - This means that remediation will be allowed only when:\n(a) there are at least 3 unhealthy machines (and)\n(b) there are at most 5 unhealthy machines"

obj spec.controlPlane.machineHealthCheck.remediationTemplate

"remediationTemplate is a reference to a remediation template\nprovided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller\ncreates a new object from the template referenced and hands off remediation of the machine to\na controller that lives outside of Cluster API."

fn spec.controlPlane.machineHealthCheck.remediationTemplate.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.controlPlane.machineHealthCheck.remediationTemplate.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object."

fn spec.controlPlane.machineHealthCheck.remediationTemplate.withKind

withKind(kind)

"Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.controlPlane.machineHealthCheck.remediationTemplate.withName

withName(name)

"Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.controlPlane.machineHealthCheck.remediationTemplate.withNamespace

withNamespace(namespace)

"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.controlPlane.machineHealthCheck.remediationTemplate.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.controlPlane.machineHealthCheck.remediationTemplate.withUid

withUid(uid)

"UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.controlPlane.machineHealthCheck.unhealthyConditions

"unhealthyConditions contains a list of the conditions that determine\nwhether a node is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the node is unhealthy."

fn spec.controlPlane.machineHealthCheck.unhealthyConditions.withTimeout

withTimeout(timeout)

"timeout is the duration that a node must be in a given status for,\nafter which the node is considered unhealthy.\nFor example, with a value of \"1h\", the node must match the status\nfor at least 1 hour before being considered unhealthy."

fn spec.controlPlane.machineHealthCheck.unhealthyConditions.withType

withType(type)

"type of Node condition"

obj spec.controlPlane.machineHealthCheck.unhealthyMachineConditions

"unhealthyMachineConditions contains a list of the machine conditions that determine\nwhether a machine is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the machine is unhealthy."

fn spec.controlPlane.machineHealthCheck.unhealthyMachineConditions.withTimeout

withTimeout(timeout)

"timeout is the duration that a Machine must be in a given status for,\nafter which the Machine is considered unhealthy.\nFor example, with a value of \"1h\", the Machine must match the status\nfor at least 1 hour before being considered unhealthy."

fn spec.controlPlane.machineHealthCheck.unhealthyMachineConditions.withType

withType(type)

"type of Machine condition"

obj spec.controlPlane.machineInfrastructure

"machineInfrastructure defines the metadata and infrastructure information\nfor control plane machines.\n\nThis field is supported if and only if the control plane provider template\nreferenced above is Machine based and supports setting replicas."

obj spec.controlPlane.machineInfrastructure.ref

"ref is a required reference to a custom resource\noffered by a provider."

fn spec.controlPlane.machineInfrastructure.ref.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.controlPlane.machineInfrastructure.ref.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object."

fn spec.controlPlane.machineInfrastructure.ref.withKind

withKind(kind)

"Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.controlPlane.machineInfrastructure.ref.withName

withName(name)

"Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.controlPlane.machineInfrastructure.ref.withNamespace

withNamespace(namespace)

"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.controlPlane.machineInfrastructure.ref.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.controlPlane.machineInfrastructure.ref.withUid

withUid(uid)

"UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.controlPlane.metadata

"metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane\nif the ControlPlaneTemplate referenced is machine based. If not, it is applied only to the\nControlPlane.\nAt runtime this metadata is merged with the corresponding metadata from the topology.\n\nThis field is supported if and only if the control plane provider template\nreferenced is Machine based."

fn spec.controlPlane.metadata.withAnnotations

withAnnotations(annotations)

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

fn spec.controlPlane.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.controlPlane.metadata.withLabels

withLabels(labels)

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

fn spec.controlPlane.metadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values

obj spec.controlPlane.namingStrategy

"namingStrategy allows changing the naming pattern used when creating the control plane provider object."

fn spec.controlPlane.namingStrategy.withTemplate

withTemplate(template)

"template defines the template to use for generating the name of the ControlPlane object.\nIf not defined, it will fallback to {{ .cluster.name }}-{{ .random }}.\nIf the templated string exceeds 63 characters, it will be trimmed to 58 characters and will\nget concatenated with a random suffix of length 5.\nThe templating mechanism provides the following arguments:\n .cluster.name: The name of the cluster object.\n .random: A random alphanumeric string, without vowels, of length 5."

obj spec.controlPlane.readinessGates

"readinessGates specifies additional conditions to include when evaluating Machine Ready condition.\n\nThis field can be used e.g. to instruct the machine controller to include in the computation for Machine's ready\ncomputation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.\n\nNOTE: This field is considered only for computing v1beta2 conditions.\nNOTE: If a Cluster defines a custom list of readinessGates for the control plane,\nsuch list overrides readinessGates defined in this field.\nNOTE: Specific control plane provider implementations might automatically extend the list of readinessGates;\ne.g. the kubeadm control provider adds ReadinessGates for the APIServerPodHealthy, SchedulerPodHealthy conditions, etc."

fn spec.controlPlane.readinessGates.withConditionType

withConditionType(conditionType)

"conditionType refers to a condition with matching type in the Machine's condition list.\nIf the conditions doesn't exist, it will be treated as unknown.\nNote: Both Cluster API conditions or conditions added by 3rd party controllers can be used as readiness gates."

fn spec.controlPlane.readinessGates.withPolarity

withPolarity(polarity)

"polarity of the conditionType specified in this readinessGate.\nValid values are Positive, Negative and omitted.\nWhen omitted, the default behaviour will be Positive.\nA positive polarity means that the condition should report a true status under normal conditions.\nA negative polarity means that the condition should report a false status under normal conditions."

obj spec.controlPlane.ref

"ref is a required reference to a custom resource\noffered by a provider."

fn spec.controlPlane.ref.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.controlPlane.ref.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object."

fn spec.controlPlane.ref.withKind

withKind(kind)

"Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.controlPlane.ref.withName

withName(name)

"Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.controlPlane.ref.withNamespace

withNamespace(namespace)

"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.controlPlane.ref.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.controlPlane.ref.withUid

withUid(uid)

"UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.controlPlane.taints

"taints are the node taints that Cluster API will manage.\nThis list is not necessarily complete: other Kubernetes components may add or remove other taints from nodes,\ne.g. the node controller might add the node.kubernetes.io/not-ready taint.\nOnly those taints defined in this list will be added or removed by core Cluster API controllers.\n\nThere can be at most 64 taints.\nA pod would have to tolerate all existing taints to run on the corresponding node.\n\nNOTE: This list is implemented as a \"map\" type, meaning that individual elements can be managed by different owners."

fn spec.controlPlane.taints.withEffect

withEffect(effect)

"effect is the effect for the taint. Valid values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.controlPlane.taints.withKey

withKey(key)

"key is the taint key to be applied to a node.\nMust be a valid qualified name of maximum size 63 characters\nwith an optional subdomain prefix of maximum size 253 characters,\nseparated by a /."

fn spec.controlPlane.taints.withPropagation

withPropagation(propagation)

"propagation defines how this taint should be propagated to nodes.\nValid values are 'Always' and 'OnInitialization'.\nAlways: The taint will be continuously reconciled. If it is not set for a node, it will be added during reconciliation.\nOnInitialization: The taint will be added during node initialization. If it gets removed from the node later on it will not get added again."

fn spec.controlPlane.taints.withValue

withValue(value)

"value is the taint value corresponding to the taint key.\nIt must be a valid label value of maximum size 63 characters."

obj spec.infrastructure

"infrastructure is a reference to a provider-specific template that holds\nthe details for provisioning infrastructure specific cluster\nfor the underlying provider.\nThe underlying provider is responsible for the implementation\nof the template to an infrastructure cluster."

obj spec.infrastructure.ref

"ref is a required reference to a custom resource\noffered by a provider."

fn spec.infrastructure.ref.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.infrastructure.ref.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object."

fn spec.infrastructure.ref.withKind

withKind(kind)

"Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.infrastructure.ref.withName

withName(name)

"Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.infrastructure.ref.withNamespace

withNamespace(namespace)

"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.infrastructure.ref.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.infrastructure.ref.withUid

withUid(uid)

"UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.infrastructureNamingStrategy

"infrastructureNamingStrategy allows changing the naming pattern used when creating the infrastructure object."

fn spec.infrastructureNamingStrategy.withTemplate

withTemplate(template)

"template defines the template to use for generating the name of the Infrastructure object.\nIf not defined, it will fallback to {{ .cluster.name }}-{{ .random }}.\nIf the templated string exceeds 63 characters, it will be trimmed to 58 characters and will\nget concatenated with a random suffix of length 5.\nThe templating mechanism provides the following arguments:\n .cluster.name: The name of the cluster object.\n .random: A random alphanumeric string, without vowels, of length 5."

obj spec.patches

"patches defines the patches which are applied to customize\nreferenced templates of a ClusterClass.\nNote: Patches will be applied in the order of the array."

fn spec.patches.withDefinitions

withDefinitions(definitions)

"definitions define inline patches.\nNote: Patches will be applied in the order of the array.\nNote: Exactly one of Definitions or External must be set."

fn spec.patches.withDefinitionsMixin

withDefinitionsMixin(definitions)

"definitions define inline patches.\nNote: Patches will be applied in the order of the array.\nNote: Exactly one of Definitions or External must be set."

Note: This function appends passed data to existing values

fn spec.patches.withDescription

withDescription(description)

"description is a human-readable description of this patch."

fn spec.patches.withEnabledIf

withEnabledIf(enabledIf)

"enabledIf is a Go template to be used to calculate if a patch should be enabled.\nIt can reference variables defined in .spec.variables and builtin variables.\nThe patch will be enabled if the template evaluates to true, otherwise it will\nbe disabled.\nIf EnabledIf is not set, the patch will be enabled per default."

fn spec.patches.withName

withName(name)

"name of the patch."

obj spec.patches.definitions

"definitions define inline patches.\nNote: Patches will be applied in the order of the array.\nNote: Exactly one of Definitions or External must be set."

fn spec.patches.definitions.withJsonPatches

withJsonPatches(jsonPatches)

"jsonPatches defines the patches which should be applied on the templates\nmatching the selector.\nNote: Patches will be applied in the order of the array."

fn spec.patches.definitions.withJsonPatchesMixin

withJsonPatchesMixin(jsonPatches)

"jsonPatches defines the patches which should be applied on the templates\nmatching the selector.\nNote: Patches will be applied in the order of the array."

Note: This function appends passed data to existing values

obj spec.patches.definitions.jsonPatches

"jsonPatches defines the patches which should be applied on the templates\nmatching the selector.\nNote: Patches will be applied in the order of the array."

fn spec.patches.definitions.jsonPatches.withOp

withOp(op)

"op defines the operation of the patch.\nNote: Only add, replace and remove are supported."

fn spec.patches.definitions.jsonPatches.withPath

withPath(path)

"path defines the path of the patch.\nNote: Only the spec of a template can be patched, thus the path has to start with /spec/.\nNote: For now the only allowed array modifications are append and prepend, i.e.:\n for op: add: only index 0 (prepend) and - (append) are allowed\n for op: replace or remove: no indexes are allowed"

fn spec.patches.definitions.jsonPatches.withValue

withValue(value)

"value defines the value of the patch.\nNote: Either Value or ValueFrom is required for add and replace\noperations. Only one of them is allowed to be set at the same time.\nNote: We have to use apiextensionsv1.JSON instead of our JSON type,\nbecause controller-tools has a hard-coded schema for apiextensionsv1.JSON\nwhich cannot be produced by another type (unset type field).\nRef: https://github.com/kubernetes-sigs/controller-tools/blob/d0e03a142d0ecdd5491593e941ee1d6b5d91dba6/pkg/crd/known_types.go#L106-L111"

obj spec.patches.definitions.jsonPatches.valueFrom

"valueFrom defines the value of the patch.\nNote: Either Value or ValueFrom is required for add and replace\noperations. Only one of them is allowed to be set at the same time."

fn spec.patches.definitions.jsonPatches.valueFrom.withTemplate

withTemplate(template)

"template is the Go template to be used to calculate the value.\nA template can reference variables defined in .spec.variables and builtin variables.\nNote: The template must evaluate to a valid YAML or JSON value."

fn spec.patches.definitions.jsonPatches.valueFrom.withVariable

withVariable(variable)

"variable is the variable to be used as value.\nVariable can be one of the variables defined in .spec.variables or a builtin variable."

obj spec.patches.definitions.selector

"selector defines on which templates the patch should be applied."

fn spec.patches.definitions.selector.withApiVersion

withApiVersion(apiVersion)

"apiVersion filters templates by apiVersion."

fn spec.patches.definitions.selector.withKind

withKind(kind)

"kind filters templates by kind."

obj spec.patches.definitions.selector.matchResources

"matchResources selects templates based on where they are referenced."

fn spec.patches.definitions.selector.matchResources.withControlPlane

withControlPlane(controlPlane)

"controlPlane selects templates referenced in .spec.ControlPlane.\nNote: this will match the controlPlane and also the controlPlane\nmachineInfrastructure (depending on the kind and apiVersion)."

fn spec.patches.definitions.selector.matchResources.withInfrastructureCluster

withInfrastructureCluster(infrastructureCluster)

"infrastructureCluster selects templates referenced in .spec.infrastructure."

obj spec.patches.definitions.selector.matchResources.machineDeploymentClass

"machineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in\n.spec.workers.machineDeployments."

fn spec.patches.definitions.selector.matchResources.machineDeploymentClass.withNames

withNames(names)

"names selects templates by class names."

fn spec.patches.definitions.selector.matchResources.machineDeploymentClass.withNamesMixin

withNamesMixin(names)

"names selects templates by class names."

Note: This function appends passed data to existing values

obj spec.patches.definitions.selector.matchResources.machinePoolClass

"machinePoolClass selects templates referenced in specific MachinePoolClasses in\n.spec.workers.machinePools."

fn spec.patches.definitions.selector.matchResources.machinePoolClass.withNames

withNames(names)

"names selects templates by class names."

fn spec.patches.definitions.selector.matchResources.machinePoolClass.withNamesMixin

withNamesMixin(names)

"names selects templates by class names."

Note: This function appends passed data to existing values

obj spec.patches.external

"external defines an external patch.\nNote: Exactly one of Definitions or External must be set."

fn spec.patches.external.withDiscoverVariablesExtension

withDiscoverVariablesExtension(discoverVariablesExtension)

"discoverVariablesExtension references an extension which is called to discover variables."

fn spec.patches.external.withGenerateExtension

withGenerateExtension(generateExtension)

"generateExtension references an extension which is called to generate patches."

fn spec.patches.external.withSettings

withSettings(settings)

"settings defines key value pairs to be passed to the extensions.\nValues defined here take precedence over the values defined in the\ncorresponding ExtensionConfig."

fn spec.patches.external.withSettingsMixin

withSettingsMixin(settings)

"settings defines key value pairs to be passed to the extensions.\nValues defined here take precedence over the values defined in the\ncorresponding ExtensionConfig."

Note: This function appends passed data to existing values

fn spec.patches.external.withValidateExtension

withValidateExtension(validateExtension)

"validateExtension references an extension which is called to validate the topology."

obj spec.upgrade

"upgrade defines the upgrade configuration for clusters using this ClusterClass."

obj spec.upgrade.external

"external defines external runtime extensions for upgrade operations."

fn spec.upgrade.external.withGenerateUpgradePlanExtension

withGenerateUpgradePlanExtension(generateUpgradePlanExtension)

"generateUpgradePlanExtension references an extension which is called to generate upgrade plan."

obj spec.variables

"variables defines the variables which can be configured\nin the Cluster topology and are then used in patches."

fn spec.variables.withName

withName(name)

"name of the variable."

fn spec.variables.withRequired

withRequired(required)

"required specifies if the variable is required.\nNote: this applies to the variable as a whole and thus the\ntop-level object defined in the schema. If nested fields are\nrequired, this will be specified inside the schema."

obj spec.variables.metadata

"metadata is the metadata of a variable.\nIt can be used to add additional data for higher level tools to\na ClusterClassVariable.\n\nDeprecated: This field is deprecated and is going to be removed in the next apiVersion. Please use XMetadata in JSONSchemaProps instead."

fn spec.variables.metadata.withAnnotations

withAnnotations(annotations)

"annotations is an unstructured key value map that can be used to store and\nretrieve arbitrary metadata.\nThey are not queryable."

fn spec.variables.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"annotations is an unstructured key value map that can be used to store and\nretrieve arbitrary metadata.\nThey are not queryable."

Note: This function appends passed data to existing values

fn spec.variables.metadata.withLabels

withLabels(labels)

"labels is a map of string keys and values that can be used to organize and categorize\n(scope and select) variables."

fn spec.variables.metadata.withLabelsMixin

withLabelsMixin(labels)

"labels is a map of string keys and values that can be used to organize and categorize\n(scope and select) variables."

Note: This function appends passed data to existing values

obj spec.variables.schema

"schema defines the schema of the variable."

obj spec.variables.schema.openAPIV3Schema

"openAPIV3Schema defines the schema of a variable via OpenAPI v3\nschema. The schema is a subset of the schema used in\nKubernetes CRDs."

fn spec.variables.schema.openAPIV3Schema.withAdditionalProperties

withAdditionalProperties(additionalProperties)

"additionalProperties specifies the schema of values in a map (keys are always strings).\nNOTE: Can only be set if type is object.\nNOTE: AdditionalProperties is mutually exclusive with Properties.\nNOTE: This field uses PreserveUnknownFields and Schemaless,\nbecause recursive validation is not possible."

fn spec.variables.schema.openAPIV3Schema.withAllOf

withAllOf(allOf)

"allOf specifies that the variable must validate against all of the subschemas in the array.\nNOTE: This field uses PreserveUnknownFields and Schemaless,\nbecause recursive validation is not possible."

fn spec.variables.schema.openAPIV3Schema.withAnyOf

withAnyOf(anyOf)

"anyOf specifies that the variable must validate against one or more of the subschemas in the array.\nNOTE: This field uses PreserveUnknownFields and Schemaless,\nbecause recursive validation is not possible."

fn spec.variables.schema.openAPIV3Schema.withDefault

withDefault(default)

"default is the default value of the variable.\nNOTE: Can be set for all types."

fn spec.variables.schema.openAPIV3Schema.withDescription

withDescription(description)

"description is a human-readable description of this variable."

fn spec.variables.schema.openAPIV3Schema.withEnum

withEnum(enum)

"enum is the list of valid values of the variable.\nNOTE: Can be set for all types."

fn spec.variables.schema.openAPIV3Schema.withEnumMixin

withEnumMixin(enum)

"enum is the list of valid values of the variable.\nNOTE: Can be set for all types."

Note: This function appends passed data to existing values

fn spec.variables.schema.openAPIV3Schema.withExample

withExample(example)

"example is an example for this variable."

fn spec.variables.schema.openAPIV3Schema.withExclusiveMaximum

withExclusiveMaximum(exclusiveMaximum)

"exclusiveMaximum specifies if the Maximum is exclusive.\nNOTE: Can only be set if type is integer or number."

fn spec.variables.schema.openAPIV3Schema.withExclusiveMinimum

withExclusiveMinimum(exclusiveMinimum)

"exclusiveMinimum specifies if the Minimum is exclusive.\nNOTE: Can only be set if type is integer or number."

fn spec.variables.schema.openAPIV3Schema.withFormat

withFormat(format)

"format is an OpenAPI v3 format string. Unknown formats are ignored.\nFor a list of supported formats please see: (of the k8s.io/apiextensions-apiserver version we're currently using)\nhttps://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apiserver/validation/formats.go\nNOTE: Can only be set if type is string."

fn spec.variables.schema.openAPIV3Schema.withItems

withItems(items)

"items specifies fields of an array.\nNOTE: Can only be set if type is array.\nNOTE: This field uses PreserveUnknownFields and Schemaless,\nbecause recursive validation is not possible."

fn spec.variables.schema.openAPIV3Schema.withMaxItems

withMaxItems(maxItems)

"maxItems is the max length of an array variable.\nNOTE: Can only be set if type is array."

fn spec.variables.schema.openAPIV3Schema.withMaxLength

withMaxLength(maxLength)

"maxLength is the max length of a string variable.\nNOTE: Can only be set if type is string."

fn spec.variables.schema.openAPIV3Schema.withMaxProperties

withMaxProperties(maxProperties)

"maxProperties is the maximum amount of entries in a map or properties in an object.\nNOTE: Can only be set if type is object."

fn spec.variables.schema.openAPIV3Schema.withMaximum

withMaximum(maximum)

"maximum is the maximum of an integer or number variable.\nIf ExclusiveMaximum is false, the variable is valid if it is lower than, or equal to, the value of Maximum.\nIf ExclusiveMaximum is true, the variable is valid if it is strictly lower than the value of Maximum.\nNOTE: Can only be set if type is integer or number."

fn spec.variables.schema.openAPIV3Schema.withMinItems

withMinItems(minItems)

"minItems is the min length of an array variable.\nNOTE: Can only be set if type is array."

fn spec.variables.schema.openAPIV3Schema.withMinLength

withMinLength(minLength)

"minLength is the min length of a string variable.\nNOTE: Can only be set if type is string."

fn spec.variables.schema.openAPIV3Schema.withMinProperties

withMinProperties(minProperties)

"minProperties is the minimum amount of entries in a map or properties in an object.\nNOTE: Can only be set if type is object."

fn spec.variables.schema.openAPIV3Schema.withMinimum

withMinimum(minimum)

"minimum is the minimum of an integer or number variable.\nIf ExclusiveMinimum is false, the variable is valid if it is greater than, or equal to, the value of Minimum.\nIf ExclusiveMinimum is true, the variable is valid if it is strictly greater than the value of Minimum.\nNOTE: Can only be set if type is integer or number."

fn spec.variables.schema.openAPIV3Schema.withNot

withNot(not)

"not specifies that the variable must not validate against the subschema.\nNOTE: This field uses PreserveUnknownFields and Schemaless,\nbecause recursive validation is not possible."

fn spec.variables.schema.openAPIV3Schema.withOneOf

withOneOf(oneOf)

"oneOf specifies that the variable must validate against exactly one of the subschemas in the array.\nNOTE: This field uses PreserveUnknownFields and Schemaless,\nbecause recursive validation is not possible."

fn spec.variables.schema.openAPIV3Schema.withPattern

withPattern(pattern)

"pattern is the regex which a string variable must match.\nNOTE: Can only be set if type is string."

fn spec.variables.schema.openAPIV3Schema.withProperties

withProperties(properties)

"properties specifies fields of an object.\nNOTE: Can only be set if type is object.\nNOTE: Properties is mutually exclusive with AdditionalProperties.\nNOTE: This field uses PreserveUnknownFields and Schemaless,\nbecause recursive validation is not possible."

fn spec.variables.schema.openAPIV3Schema.withRequired

withRequired(required)

"required specifies which fields of an object are required.\nNOTE: Can only be set if type is object."

fn spec.variables.schema.openAPIV3Schema.withRequiredMixin

withRequiredMixin(required)

"required specifies which fields of an object are required.\nNOTE: Can only be set if type is object."

Note: This function appends passed data to existing values

fn spec.variables.schema.openAPIV3Schema.withType

withType(type)

"type is the type of the variable.\nValid values are: object, array, string, integer, number or boolean."

fn spec.variables.schema.openAPIV3Schema.withUniqueItems

withUniqueItems(uniqueItems)

"uniqueItems specifies if items in an array must be unique.\nNOTE: Can only be set if type is array."

fn spec.variables.schema.openAPIV3Schema.withX-Kubernetes-Int-Or-String

withX-Kubernetes-Int-Or-String(x_kubernetes_int_or_string)

"x-kubernetes-int-or-string specifies that this value is\neither an integer or a string. If this is true, an empty\ntype is allowed and type as child of anyOf is permitted\nif following one of the following patterns:\n\n1) anyOf:\n - type: integer\n - type: string\n2) allOf:\n - anyOf:\n - type: integer\n - type: string\n - ... zero or more"

fn spec.variables.schema.openAPIV3Schema.withX-Kubernetes-Preserve-Unknown-Fields

withX-Kubernetes-Preserve-Unknown-Fields(x_kubernetes_preserve_unknown_fields)

"x-kubernetes-preserve-unknown-fields allows setting fields in a variable object\nwhich are not defined in the variable schema. This affects fields recursively,\nexcept if nested properties or additionalProperties are specified in the schema."

fn spec.variables.schema.openAPIV3Schema.withX-Kubernetes-Validations

withX-Kubernetes-Validations(x_kubernetes_validations)

"x-kubernetes-validations describes a list of validation rules written in the CEL expression language."

fn spec.variables.schema.openAPIV3Schema.withX-Kubernetes-ValidationsMixin

withX-Kubernetes-ValidationsMixin(x_kubernetes_validations)

"x-kubernetes-validations describes a list of validation rules written in the CEL expression language."

Note: This function appends passed data to existing values

obj spec.variables.schema.openAPIV3Schema.x-kubernetes-validations

"x-kubernetes-validations describes a list of validation rules written in the CEL expression language."

fn spec.variables.schema.openAPIV3Schema.x-kubernetes-validations.withFieldPath

withFieldPath(fieldPath)

"fieldPath represents the field path returned when the validation fails.\nIt must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field.\ne.g. when validation checks if a specific attribute foo under a map testMap, the fieldPath could be set to .testMap.foo\nIf the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. .testList\nIt does not support list numeric index.\nIt supports child operation to refer to an existing field currently. Refer to JSONPath support in Kubernetes for more info.\nNumeric index of array is not supported.\nFor field name which contains special characters, use ['specialName'] to refer the field name.\ne.g. for attribute foo.34$ appears in a list testList, the fieldPath could be set to .testList['foo.34$']"

fn spec.variables.schema.openAPIV3Schema.x-kubernetes-validations.withMessage

withMessage(message)

"message represents the message displayed when validation fails. The message is required if the Rule contains\nline breaks. The message must not contain line breaks.\nIf unset, the message is \"failed rule: {Rule}\".\ne.g. \"must be a URL with the host matching spec.host\

fn spec.variables.schema.openAPIV3Schema.x-kubernetes-validations.withMessageExpression

withMessageExpression(messageExpression)

"messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails.\nSince messageExpression is used as a failure message, it must evaluate to a string.\nIf both message and messageExpression are present on a rule, then messageExpression will be used if validation\nfails. If messageExpression results in a runtime error, the validation failure message is produced\nas if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string\nthat contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset.\nmessageExpression has access to all the same variables as the rule; the only difference is the return type.\nExample:\n\"x must be less than max (\"+string(self.max)+\")\

fn spec.variables.schema.openAPIV3Schema.x-kubernetes-validations.withReason

withReason(reason)

"reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule.\nThe currently supported reasons are: \"FieldValueInvalid\", \"FieldValueForbidden\", \"FieldValueRequired\", \"FieldValueDuplicate\".\nIf not set, default to use \"FieldValueInvalid\".\nAll future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid."

fn spec.variables.schema.openAPIV3Schema.x-kubernetes-validations.withRule

withRule(rule)

"rule represents the expression which will be evaluated by CEL.\nref: https://github.com/google/cel-spec\nThe Rule is scoped to the location of the x-kubernetes-validations extension in the schema.\nThe self variable in the CEL expression is bound to the scoped value.\nIf the Rule is scoped to an object with properties, the accessible properties of the object are field selectable\nvia self.field and field presence can be checked via has(self.field).\nIf the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map\nare accessible via self[mapKey], map containment can be checked via mapKey in self and all entries of the map\nare accessible via CEL macros and functions such as self.all(...).\nIf the Rule is scoped to an array, the elements of the array are accessible via self[i] and also by macros and\nfunctions.\nIf the Rule is scoped to a scalar, self is bound to the scalar value.\nExamples:\n- Rule scoped to a map of objects: {\"rule\": \"self.components['Widget'].priority < 10\"}\n- Rule scoped to a list of integers: {\"rule\": \"self.values.all(value, value >= 0 && value < 100)\"}\n- Rule scoped to a string value: {\"rule\": \"self.startsWith('kube')\"}\n\nUnknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL\nexpressions. This includes:\n- Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields.\n- Object properties where the property schema is of an \"unknown type\". An \"unknown type\" is recursively defined as:\n - A schema with no type and x-kubernetes-preserve-unknown-fields set to true\n - An array where the items schema is of an \"unknown type\"\n - An object where the additionalProperties schema is of an \"unknown type\"\n\nOnly property names of the form [a-zA-Z_.-/][a-zA-Z0-9_.-/]* are accessible.\nAccessible property names are escaped according to the following rules when accessed in the expression:\n- '' escapes to '__underscores'\n- '.' escapes to 'dot'\n- '-' escapes to 'dash'\n- '/' escapes to 'slash'\n- Property names that exactly match a CEL RESERVED keyword escape to '{keyword}'. The keywords are:\n\t \"true\", \"false\", \"null\", \"in\", \"as\", \"break\", \"const\", \"continue\", \"else\", \"for\", \"function\", \"if\",\n\t \"import\", \"let\", \"loop\", \"package\", \"namespace\", \"return\".\nExamples:\n - Rule accessing a property named \"namespace\": {\"rule\": \"self.namespace > 0\"}\n - Rule accessing a property named \"x-prop\": {\"rule\": \"self.x__dash__prop > 0\"}\n - Rule accessing a property named \"redact__d\": {\"rule\": \"self.redact__underscores__d > 0\"}\n\nIf rule makes use of the oldSelf variable it is implicitly a\ntransition rule.\n\nBy default, the oldSelf variable is the same type as self.\n\nTransition rules by default are applied only on UPDATE requests and are\nskipped if an old value could not be found."

obj spec.variables.schema.openAPIV3Schema.x-metadata

"x-metadata is the metadata of a variable or a nested field within a variable.\nIt can be used to add additional data for higher level tools."

fn spec.variables.schema.openAPIV3Schema.x-metadata.withAnnotations

withAnnotations(annotations)

"annotations is an unstructured key value map that can be used to store and\nretrieve arbitrary metadata.\nThey are not queryable."

fn spec.variables.schema.openAPIV3Schema.x-metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"annotations is an unstructured key value map that can be used to store and\nretrieve arbitrary metadata.\nThey are not queryable."

Note: This function appends passed data to existing values

fn spec.variables.schema.openAPIV3Schema.x-metadata.withLabels

withLabels(labels)

"labels is a map of string keys and values that can be used to organize and categorize\n(scope and select) variables."

fn spec.variables.schema.openAPIV3Schema.x-metadata.withLabelsMixin

withLabelsMixin(labels)

"labels is a map of string keys and values that can be used to organize and categorize\n(scope and select) variables."

Note: This function appends passed data to existing values

obj spec.workers

"workers describes the worker nodes for the cluster.\nIt is a collection of node types which can be used to create\nthe worker nodes of the cluster."

fn spec.workers.withMachineDeployments

withMachineDeployments(machineDeployments)

"machineDeployments is a list of machine deployment classes that can be used to create\na set of worker nodes."

fn spec.workers.withMachineDeploymentsMixin

withMachineDeploymentsMixin(machineDeployments)

"machineDeployments is a list of machine deployment classes that can be used to create\na set of worker nodes."

Note: This function appends passed data to existing values

fn spec.workers.withMachinePools

withMachinePools(machinePools)

"machinePools is a list of machine pool classes that can be used to create\na set of worker nodes."

fn spec.workers.withMachinePoolsMixin

withMachinePoolsMixin(machinePools)

"machinePools is a list of machine pool classes that can be used to create\na set of worker nodes."

Note: This function appends passed data to existing values

obj spec.workers.machineDeployments

"machineDeployments is a list of machine deployment classes that can be used to create\na set of worker nodes."

fn spec.workers.machineDeployments.withClass

withClass(class)

"class denotes a type of worker node present in the cluster,\nthis name MUST be unique within a ClusterClass and can be referenced\nin the Cluster to create a managed MachineDeployment."

fn spec.workers.machineDeployments.withFailureDomain

withFailureDomain(failureDomain)

"failureDomain is the failure domain the machines will be created in.\nMust match a key in the FailureDomains map stored on the cluster object.\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass."

fn spec.workers.machineDeployments.withMinReadySeconds

withMinReadySeconds(minReadySeconds)

"minReadySeconds is the minimum number of seconds for which a newly created machine should\nbe ready.\nDefaults to 0 (machine will be considered available as soon as it\nis ready)\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass."

fn spec.workers.machineDeployments.withNodeDeletionTimeout

withNodeDeletionTimeout(nodeDeletionTimeout)

"nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine\nhosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely.\nDefaults to 10 seconds.\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass."

fn spec.workers.machineDeployments.withNodeDrainTimeout

withNodeDrainTimeout(nodeDrainTimeout)

"nodeDrainTimeout is the total amount of time that the controller will spend on draining a node.\nThe default value is 0, meaning that the node can be drained without any time limitations.\nNOTE: NodeDrainTimeout is different from kubectl drain --timeout\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass."

fn spec.workers.machineDeployments.withNodeVolumeDetachTimeout

withNodeVolumeDetachTimeout(nodeVolumeDetachTimeout)

"nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes\nto be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass."

fn spec.workers.machineDeployments.withReadinessGates

withReadinessGates(readinessGates)

"readinessGates specifies additional conditions to include when evaluating Machine Ready condition.\n\nThis field can be used e.g. to instruct the machine controller to include in the computation for Machine's ready\ncomputation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.\n\nNOTE: This field is considered only for computing v1beta2 conditions.\nNOTE: If a Cluster defines a custom list of readinessGates for a MachineDeployment using this MachineDeploymentClass,\nsuch list overrides readinessGates defined in this field."

fn spec.workers.machineDeployments.withReadinessGatesMixin

withReadinessGatesMixin(readinessGates)

"readinessGates specifies additional conditions to include when evaluating Machine Ready condition.\n\nThis field can be used e.g. to instruct the machine controller to include in the computation for Machine's ready\ncomputation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.\n\nNOTE: This field is considered only for computing v1beta2 conditions.\nNOTE: If a Cluster defines a custom list of readinessGates for a MachineDeployment using this MachineDeploymentClass,\nsuch list overrides readinessGates defined in this field."

Note: This function appends passed data to existing values

fn spec.workers.machineDeployments.withTaints

withTaints(taints)

"taints are the node taints that Cluster API will manage.\nThis list is not necessarily complete: other Kubernetes components may add or remove other taints from nodes,\ne.g. the node controller might add the node.kubernetes.io/not-ready taint.\nOnly those taints defined in this list will be added or removed by core Cluster API controllers.\n\nThere can be at most 64 taints.\nA pod would have to tolerate all existing taints to run on the corresponding node.\n\nNOTE: This list is implemented as a \"map\" type, meaning that individual elements can be managed by different owners."

fn spec.workers.machineDeployments.withTaintsMixin

withTaintsMixin(taints)

"taints are the node taints that Cluster API will manage.\nThis list is not necessarily complete: other Kubernetes components may add or remove other taints from nodes,\ne.g. the node controller might add the node.kubernetes.io/not-ready taint.\nOnly those taints defined in this list will be added or removed by core Cluster API controllers.\n\nThere can be at most 64 taints.\nA pod would have to tolerate all existing taints to run on the corresponding node.\n\nNOTE: This list is implemented as a \"map\" type, meaning that individual elements can be managed by different owners."

Note: This function appends passed data to existing values

obj spec.workers.machineDeployments.machineHealthCheck

"machineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass."

fn spec.workers.machineDeployments.machineHealthCheck.withMaxUnhealthy

withMaxUnhealthy(maxUnhealthy)

"maxUnhealthy specifies the maximum number of unhealthy machines allowed.\nAny further remediation is only allowed if at most \"maxUnhealthy\" machines selected by\n\"selector\" are not healthy."

fn spec.workers.machineDeployments.machineHealthCheck.withNodeStartupTimeout

withNodeStartupTimeout(nodeStartupTimeout)

"nodeStartupTimeout allows to set the maximum time for MachineHealthCheck\nto consider a Machine unhealthy if a corresponding Node isn't associated\nthrough a Spec.ProviderID field.\n\nThe duration set in this field is compared to the greatest of:\n- Cluster's infrastructure ready condition timestamp (if and when available)\n- Control Plane's initialized condition timestamp (if and when available)\n- Machine's infrastructure ready condition timestamp (if and when available)\n- Machine's metadata creation timestamp\n\nDefaults to 10 minutes.\nIf you wish to disable this feature, set the value explicitly to 0."

fn spec.workers.machineDeployments.machineHealthCheck.withUnhealthyConditions

withUnhealthyConditions(unhealthyConditions)

"unhealthyConditions contains a list of the conditions that determine\nwhether a node is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the node is unhealthy."

fn spec.workers.machineDeployments.machineHealthCheck.withUnhealthyConditionsMixin

withUnhealthyConditionsMixin(unhealthyConditions)

"unhealthyConditions contains a list of the conditions that determine\nwhether a node is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the node is unhealthy."

Note: This function appends passed data to existing values

fn spec.workers.machineDeployments.machineHealthCheck.withUnhealthyMachineConditions

withUnhealthyMachineConditions(unhealthyMachineConditions)

"unhealthyMachineConditions contains a list of the machine conditions that determine\nwhether a machine is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the machine is unhealthy."

fn spec.workers.machineDeployments.machineHealthCheck.withUnhealthyMachineConditionsMixin

withUnhealthyMachineConditionsMixin(unhealthyMachineConditions)

"unhealthyMachineConditions contains a list of the machine conditions that determine\nwhether a machine is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the machine is unhealthy."

Note: This function appends passed data to existing values

fn spec.workers.machineDeployments.machineHealthCheck.withUnhealthyRange

withUnhealthyRange(unhealthyRange)

"unhealthyRange specifies the range of unhealthy machines allowed.\nAny further remediation is only allowed if the number of machines selected by \"selector\" as not healthy\nis within the range of \"unhealthyRange\". Takes precedence over maxUnhealthy.\nEg. \"[3-5]\" - This means that remediation will be allowed only when:\n(a) there are at least 3 unhealthy machines (and)\n(b) there are at most 5 unhealthy machines"

obj spec.workers.machineDeployments.machineHealthCheck.remediationTemplate

"remediationTemplate is a reference to a remediation template\nprovided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller\ncreates a new object from the template referenced and hands off remediation of the machine to\na controller that lives outside of Cluster API."

fn spec.workers.machineDeployments.machineHealthCheck.remediationTemplate.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.workers.machineDeployments.machineHealthCheck.remediationTemplate.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object."

fn spec.workers.machineDeployments.machineHealthCheck.remediationTemplate.withKind

withKind(kind)

"Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.workers.machineDeployments.machineHealthCheck.remediationTemplate.withName

withName(name)

"Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.workers.machineDeployments.machineHealthCheck.remediationTemplate.withNamespace

withNamespace(namespace)

"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.workers.machineDeployments.machineHealthCheck.remediationTemplate.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.workers.machineDeployments.machineHealthCheck.remediationTemplate.withUid

withUid(uid)

"UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.workers.machineDeployments.machineHealthCheck.unhealthyConditions

"unhealthyConditions contains a list of the conditions that determine\nwhether a node is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the node is unhealthy."

fn spec.workers.machineDeployments.machineHealthCheck.unhealthyConditions.withTimeout

withTimeout(timeout)

"timeout is the duration that a node must be in a given status for,\nafter which the node is considered unhealthy.\nFor example, with a value of \"1h\", the node must match the status\nfor at least 1 hour before being considered unhealthy."

fn spec.workers.machineDeployments.machineHealthCheck.unhealthyConditions.withType

withType(type)

"type of Node condition"

obj spec.workers.machineDeployments.machineHealthCheck.unhealthyMachineConditions

"unhealthyMachineConditions contains a list of the machine conditions that determine\nwhether a machine is considered unhealthy. The conditions are combined in a\nlogical OR, i.e. if any of the conditions is met, the machine is unhealthy."

fn spec.workers.machineDeployments.machineHealthCheck.unhealthyMachineConditions.withTimeout

withTimeout(timeout)

"timeout is the duration that a Machine must be in a given status for,\nafter which the Machine is considered unhealthy.\nFor example, with a value of \"1h\", the Machine must match the status\nfor at least 1 hour before being considered unhealthy."

fn spec.workers.machineDeployments.machineHealthCheck.unhealthyMachineConditions.withType

withType(type)

"type of Machine condition"

obj spec.workers.machineDeployments.namingStrategy

"namingStrategy allows changing the naming pattern used when creating the MachineDeployment."

fn spec.workers.machineDeployments.namingStrategy.withTemplate

withTemplate(template)

"template defines the template to use for generating the name of the MachineDeployment object.\nIf not defined, it will fallback to {{ .cluster.name }}-{{ .machineDeployment.topologyName }}-{{ .random }}.\nIf the templated string exceeds 63 characters, it will be trimmed to 58 characters and will\nget concatenated with a random suffix of length 5.\nThe templating mechanism provides the following arguments:\n .cluster.name: The name of the cluster object.\n .random: A random alphanumeric string, without vowels, of length 5.\n* .machineDeployment.topologyName: The name of the MachineDeployment topology (Cluster.spec.topology.workers.machineDeployments[].name)."

obj spec.workers.machineDeployments.readinessGates

"readinessGates specifies additional conditions to include when evaluating Machine Ready condition.\n\nThis field can be used e.g. to instruct the machine controller to include in the computation for Machine's ready\ncomputation a condition, managed by an external controllers, reporting the status of special software/hardware installed on the Machine.\n\nNOTE: This field is considered only for computing v1beta2 conditions.\nNOTE: If a Cluster defines a custom list of readinessGates for a MachineDeployment using this MachineDeploymentClass,\nsuch list overrides readinessGates defined in this field."

fn spec.workers.machineDeployments.readinessGates.withConditionType

withConditionType(conditionType)

"conditionType refers to a condition with matching type in the Machine's condition list.\nIf the conditions doesn't exist, it will be treated as unknown.\nNote: Both Cluster API conditions or conditions added by 3rd party controllers can be used as readiness gates."

fn spec.workers.machineDeployments.readinessGates.withPolarity

withPolarity(polarity)

"polarity of the conditionType specified in this readinessGate.\nValid values are Positive, Negative and omitted.\nWhen omitted, the default behaviour will be Positive.\nA positive polarity means that the condition should report a true status under normal conditions.\nA negative polarity means that the condition should report a false status under normal conditions."

obj spec.workers.machineDeployments.strategy

"strategy is the deployment strategy to use to replace existing machines with\nnew ones.\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass."

fn spec.workers.machineDeployments.strategy.withType

withType(type)

"type of deployment. Allowed values are RollingUpdate and OnDelete.\nThe default is RollingUpdate."

obj spec.workers.machineDeployments.strategy.remediation

"remediation controls the strategy of remediating unhealthy machines\nand how remediating operations should occur during the lifecycle of the dependant MachineSets."

fn spec.workers.machineDeployments.strategy.remediation.withMaxInFlight

withMaxInFlight(maxInFlight)

"maxInFlight determines how many in flight remediations should happen at the same time.\n\nRemediation only happens on the MachineSet with the most current revision, while\nolder MachineSets (usually present during rollout operations) aren't allowed to remediate.\n\nNote: In general (independent of remediations), unhealthy machines are always\nprioritized during scale down operations over healthy ones.\n\nMaxInFlight can be set to a fixed number or a percentage.\nExample: when this is set to 20%, the MachineSet controller deletes at most 20% of\nthe desired replicas.\n\nIf not set, remediation is limited to all machines (bounded by replicas)\nunder the active MachineSet's management."

obj spec.workers.machineDeployments.strategy.rollingUpdate

"rollingUpdate is the rolling update config params. Present only if\nMachineDeploymentStrategyType = RollingUpdate."

fn spec.workers.machineDeployments.strategy.rollingUpdate.withDeletePolicy

withDeletePolicy(deletePolicy)

"deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling.\nValid values are \"Random, \"Newest\", \"Oldest\"\nWhen no value is supplied, the default DeletePolicy of MachineSet is used"

fn spec.workers.machineDeployments.strategy.rollingUpdate.withMaxSurge

withMaxSurge(maxSurge)

"maxSurge is the maximum number of machines that can be scheduled above the\ndesired number of machines.\nValue can be an absolute number (ex: 5) or a percentage of\ndesired machines (ex: 10%).\nThis can not be 0 if MaxUnavailable is 0.\nAbsolute number is calculated from percentage by rounding up.\nDefaults to 1.\nExample: when this is set to 30%, the new MachineSet can be scaled\nup immediately when the rolling update starts, such that the total\nnumber of old and new machines do not exceed 130% of desired\nmachines. Once old machines have been killed, new MachineSet can\nbe scaled up further, ensuring that total number of machines running\nat any time during the update is at most 130% of desired machines."

fn spec.workers.machineDeployments.strategy.rollingUpdate.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

"maxUnavailable is the maximum number of machines that can be unavailable during the update.\nValue can be an absolute number (ex: 5) or a percentage of desired\nmachines (ex: 10%).\nAbsolute number is calculated from percentage by rounding down.\nThis can not be 0 if MaxSurge is 0.\nDefaults to 0.\nExample: when this is set to 30%, the old MachineSet can be scaled\ndown to 70% of desired machines immediately when the rolling update\nstarts. Once new machines are ready, old MachineSet can be scaled\ndown further, followed by scaling up the new MachineSet, ensuring\nthat the total number of machines available at all times\nduring the update is at least 70% of desired machines."

obj spec.workers.machineDeployments.taints

"taints are the node taints that Cluster API will manage.\nThis list is not necessarily complete: other Kubernetes components may add or remove other taints from nodes,\ne.g. the node controller might add the node.kubernetes.io/not-ready taint.\nOnly those taints defined in this list will be added or removed by core Cluster API controllers.\n\nThere can be at most 64 taints.\nA pod would have to tolerate all existing taints to run on the corresponding node.\n\nNOTE: This list is implemented as a \"map\" type, meaning that individual elements can be managed by different owners."

fn spec.workers.machineDeployments.taints.withEffect

withEffect(effect)

"effect is the effect for the taint. Valid values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.workers.machineDeployments.taints.withKey

withKey(key)

"key is the taint key to be applied to a node.\nMust be a valid qualified name of maximum size 63 characters\nwith an optional subdomain prefix of maximum size 253 characters,\nseparated by a /."

fn spec.workers.machineDeployments.taints.withPropagation

withPropagation(propagation)

"propagation defines how this taint should be propagated to nodes.\nValid values are 'Always' and 'OnInitialization'.\nAlways: The taint will be continuously reconciled. If it is not set for a node, it will be added during reconciliation.\nOnInitialization: The taint will be added during node initialization. If it gets removed from the node later on it will not get added again."

fn spec.workers.machineDeployments.taints.withValue

withValue(value)

"value is the taint value corresponding to the taint key.\nIt must be a valid label value of maximum size 63 characters."

obj spec.workers.machineDeployments.template

"template is a local struct containing a collection of templates for creation of\nMachineDeployment objects representing a set of worker nodes."

obj spec.workers.machineDeployments.template.bootstrap

"bootstrap contains the bootstrap template reference to be used\nfor the creation of worker Machines."

obj spec.workers.machineDeployments.template.bootstrap.ref

"ref is a required reference to a custom resource\noffered by a provider."

fn spec.workers.machineDeployments.template.bootstrap.ref.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.workers.machineDeployments.template.bootstrap.ref.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object."

fn spec.workers.machineDeployments.template.bootstrap.ref.withKind

withKind(kind)

"Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.workers.machineDeployments.template.bootstrap.ref.withName

withName(name)

"Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.workers.machineDeployments.template.bootstrap.ref.withNamespace

withNamespace(namespace)

"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.workers.machineDeployments.template.bootstrap.ref.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.workers.machineDeployments.template.bootstrap.ref.withUid

withUid(uid)

"UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.workers.machineDeployments.template.infrastructure

"infrastructure contains the infrastructure template reference to be used\nfor the creation of worker Machines."

obj spec.workers.machineDeployments.template.infrastructure.ref

"ref is a required reference to a custom resource\noffered by a provider."

fn spec.workers.machineDeployments.template.infrastructure.ref.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.workers.machineDeployments.template.infrastructure.ref.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object."

fn spec.workers.machineDeployments.template.infrastructure.ref.withKind

withKind(kind)

"Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.workers.machineDeployments.template.infrastructure.ref.withName

withName(name)

"Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.workers.machineDeployments.template.infrastructure.ref.withNamespace

withNamespace(namespace)

"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.workers.machineDeployments.template.infrastructure.ref.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.workers.machineDeployments.template.infrastructure.ref.withUid

withUid(uid)

"UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.workers.machineDeployments.template.metadata

"metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment.\nAt runtime this metadata is merged with the corresponding metadata from the topology."

fn spec.workers.machineDeployments.template.metadata.withAnnotations

withAnnotations(annotations)

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

fn spec.workers.machineDeployments.template.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.workers.machineDeployments.template.metadata.withLabels

withLabels(labels)

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

fn spec.workers.machineDeployments.template.metadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values

obj spec.workers.machinePools

"machinePools is a list of machine pool classes that can be used to create\na set of worker nodes."

fn spec.workers.machinePools.withClass

withClass(class)

"class denotes a type of machine pool present in the cluster,\nthis name MUST be unique within a ClusterClass and can be referenced\nin the Cluster to create a managed MachinePool."

fn spec.workers.machinePools.withFailureDomains

withFailureDomains(failureDomains)

"failureDomains is the list of failure domains the MachinePool should be attached to.\nMust match a key in the FailureDomains map stored on the cluster object.\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass."

fn spec.workers.machinePools.withFailureDomainsMixin

withFailureDomainsMixin(failureDomains)

"failureDomains is the list of failure domains the MachinePool should be attached to.\nMust match a key in the FailureDomains map stored on the cluster object.\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass."

Note: This function appends passed data to existing values

fn spec.workers.machinePools.withMinReadySeconds

withMinReadySeconds(minReadySeconds)

"minReadySeconds is the minimum number of seconds for which a newly created machine pool should\nbe ready.\nDefaults to 0 (machine will be considered available as soon as it\nis ready)\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass."

fn spec.workers.machinePools.withNodeDeletionTimeout

withNodeDeletionTimeout(nodeDeletionTimeout)

"nodeDeletionTimeout defines how long the controller will attempt to delete the Node that the Machine\nhosts after the Machine Pool is marked for deletion. A duration of 0 will retry deletion indefinitely.\nDefaults to 10 seconds.\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass."

fn spec.workers.machinePools.withNodeDrainTimeout

withNodeDrainTimeout(nodeDrainTimeout)

"nodeDrainTimeout is the total amount of time that the controller will spend on draining a node.\nThe default value is 0, meaning that the node can be drained without any time limitations.\nNOTE: NodeDrainTimeout is different from kubectl drain --timeout\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass."

fn spec.workers.machinePools.withNodeVolumeDetachTimeout

withNodeVolumeDetachTimeout(nodeVolumeDetachTimeout)

"nodeVolumeDetachTimeout is the total amount of time that the controller will spend on waiting for all volumes\nto be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.\nNOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass."

fn spec.workers.machinePools.withTaints

withTaints(taints)

"taints are the node taints that Cluster API will manage.\nThis list is not necessarily complete: other Kubernetes components may add or remove other taints from nodes,\ne.g. the node controller might add the node.kubernetes.io/not-ready taint.\nOnly those taints defined in this list will be added or removed by core Cluster API controllers.\n\nThere can be at most 64 taints.\nA pod would have to tolerate all existing taints to run on the corresponding node.\n\nNOTE: This list is implemented as a \"map\" type, meaning that individual elements can be managed by different owners."

fn spec.workers.machinePools.withTaintsMixin

withTaintsMixin(taints)

"taints are the node taints that Cluster API will manage.\nThis list is not necessarily complete: other Kubernetes components may add or remove other taints from nodes,\ne.g. the node controller might add the node.kubernetes.io/not-ready taint.\nOnly those taints defined in this list will be added or removed by core Cluster API controllers.\n\nThere can be at most 64 taints.\nA pod would have to tolerate all existing taints to run on the corresponding node.\n\nNOTE: This list is implemented as a \"map\" type, meaning that individual elements can be managed by different owners."

Note: This function appends passed data to existing values

obj spec.workers.machinePools.namingStrategy

"namingStrategy allows changing the naming pattern used when creating the MachinePool."

fn spec.workers.machinePools.namingStrategy.withTemplate

withTemplate(template)

"template defines the template to use for generating the name of the MachinePool object.\nIf not defined, it will fallback to {{ .cluster.name }}-{{ .machinePool.topologyName }}-{{ .random }}.\nIf the templated string exceeds 63 characters, it will be trimmed to 58 characters and will\nget concatenated with a random suffix of length 5.\nThe templating mechanism provides the following arguments:\n .cluster.name: The name of the cluster object.\n .random: A random alphanumeric string, without vowels, of length 5.\n* .machinePool.topologyName: The name of the MachinePool topology (Cluster.spec.topology.workers.machinePools[].name)."

obj spec.workers.machinePools.taints

"taints are the node taints that Cluster API will manage.\nThis list is not necessarily complete: other Kubernetes components may add or remove other taints from nodes,\ne.g. the node controller might add the node.kubernetes.io/not-ready taint.\nOnly those taints defined in this list will be added or removed by core Cluster API controllers.\n\nThere can be at most 64 taints.\nA pod would have to tolerate all existing taints to run on the corresponding node.\n\nNOTE: This list is implemented as a \"map\" type, meaning that individual elements can be managed by different owners."

fn spec.workers.machinePools.taints.withEffect

withEffect(effect)

"effect is the effect for the taint. Valid values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.workers.machinePools.taints.withKey

withKey(key)

"key is the taint key to be applied to a node.\nMust be a valid qualified name of maximum size 63 characters\nwith an optional subdomain prefix of maximum size 253 characters,\nseparated by a /."

fn spec.workers.machinePools.taints.withPropagation

withPropagation(propagation)

"propagation defines how this taint should be propagated to nodes.\nValid values are 'Always' and 'OnInitialization'.\nAlways: The taint will be continuously reconciled. If it is not set for a node, it will be added during reconciliation.\nOnInitialization: The taint will be added during node initialization. If it gets removed from the node later on it will not get added again."

fn spec.workers.machinePools.taints.withValue

withValue(value)

"value is the taint value corresponding to the taint key.\nIt must be a valid label value of maximum size 63 characters."

obj spec.workers.machinePools.template

"template is a local struct containing a collection of templates for creation of\nMachinePools objects representing a pool of worker nodes."

obj spec.workers.machinePools.template.bootstrap

"bootstrap contains the bootstrap template reference to be used\nfor the creation of the Machines in the MachinePool."

obj spec.workers.machinePools.template.bootstrap.ref

"ref is a required reference to a custom resource\noffered by a provider."

fn spec.workers.machinePools.template.bootstrap.ref.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.workers.machinePools.template.bootstrap.ref.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object."

fn spec.workers.machinePools.template.bootstrap.ref.withKind

withKind(kind)

"Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.workers.machinePools.template.bootstrap.ref.withName

withName(name)

"Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.workers.machinePools.template.bootstrap.ref.withNamespace

withNamespace(namespace)

"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.workers.machinePools.template.bootstrap.ref.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.workers.machinePools.template.bootstrap.ref.withUid

withUid(uid)

"UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.workers.machinePools.template.infrastructure

"infrastructure contains the infrastructure template reference to be used\nfor the creation of the MachinePool."

obj spec.workers.machinePools.template.infrastructure.ref

"ref is a required reference to a custom resource\noffered by a provider."

fn spec.workers.machinePools.template.infrastructure.ref.withApiVersion

withApiVersion(apiVersion)

"API version of the referent."

fn spec.workers.machinePools.template.infrastructure.ref.withFieldPath

withFieldPath(fieldPath)

"If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object."

fn spec.workers.machinePools.template.infrastructure.ref.withKind

withKind(kind)

"Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

fn spec.workers.machinePools.template.infrastructure.ref.withName

withName(name)

"Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.workers.machinePools.template.infrastructure.ref.withNamespace

withNamespace(namespace)

"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

fn spec.workers.machinePools.template.infrastructure.ref.withResourceVersion

withResourceVersion(resourceVersion)

"Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn spec.workers.machinePools.template.infrastructure.ref.withUid

withUid(uid)

"UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids"

obj spec.workers.machinePools.template.metadata

"metadata is the metadata applied to the MachinePool.\nAt runtime this metadata is merged with the corresponding metadata from the topology."

fn spec.workers.machinePools.template.metadata.withAnnotations

withAnnotations(annotations)

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

fn spec.workers.machinePools.template.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

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

Note: This function appends passed data to existing values

fn spec.workers.machinePools.template.metadata.withLabels

withLabels(labels)

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

fn spec.workers.machinePools.template.metadata.withLabelsMixin

withLabelsMixin(labels)

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

Note: This function appends passed data to existing values