Cluster customizations

The cluster configuration handlers wrap all the other mutation handlers in a convenient single patch for inclusion in your ClusterClasses, allowing for a single configuration variable with nested values. This provides the most flexibility with the least configuration.

To enable the handler, add the provider-specific clusterconfigvars and clusterconfigpatch external patches on ClusterClass. This will enable all of the generic cluster customizations, along with the relevant provider-specific variables.

Regardless of provider, a single variable called clusterConfig will be available for use on the ClusterClass. The schema (and therefore the configuration options) will be customized for each provider. To use the exposed configuration options, specify the desired values on the Cluster resource:

apiVersion: cluster.x-k8s.io/v1beta1
kind: Cluster
metadata:
  name: <NAME>
spec:
  topology:
    variables:
      - name: clusterConfig
        value:
          kubernetesImageRepository: "my-registry.io/my-org/my-repo"
          etcd:
            image:
              repository: my-registry.io/my-org/my-repo
              tag: "v3.5.99_custom.0"
          extraAPIServerCertSANs:
            - a.b.c.example.com
            - d.e.f.example.com
          proxy:
            http: http://example.com
            https: https://example.com
            additionalNo:
              - no-proxy-1.example.com
              - no-proxy-2.example.com
          imageRegistries:
            credentials:
              - url: https://my-registry.io
                secretRef:
                  name: my-registry-credentials
          cni:
            provider: calico

AWS

See AWS customizations for the AWS specific customizations.

apiVersion: cluster.x-k8s.io/v1beta1
kind: ClusterClass
metadata:
  name: <NAME>
spec:
  patches:
    - name: cluster-config
      external:
        generateExtension: "awsclusterconfigpatch.cluster-api-runtime-extensions-nutanix"
        discoverVariablesExtension: "awsclusterconfigvars.cluster-api-runtime-extensions-nutanix"

Docker

See generic customizations for the Docker specific customizations.

apiVersion: cluster.x-k8s.io/v1beta1
kind: ClusterClass
metadata:
  name: <NAME>
spec:
  patches:
    - name: cluster-config
      external:
        generateExtension: "dockerclusterconfigpatch.cluster-api-runtime-extensions-nutanix"
        discoverVariablesExtension: "dockerclusterconfigvars.cluster-api-runtime-extensions-nutanix"
Generic

AWS

Docker

Nutanix


Last modified September 12, 2024: fix: Do not use digests for Cilium images (#901) (10ea179)