ClusterctlConfig Resource
The ClusterctlConfig resource allows managing overrides for clusterctl (CAPI Operator) configurations in a declarative way. It is used to configure clusterctl providers and their urls, as well as version restrictions.
ClusterctlConfig follows a GitOps model - the spec fields are declarative user inputs. Turtles does not create or update the resource, it is up to user to specify provider url overrides and maintain its state. It takes precedence over embedded defaults or clusterctl default set of provider definitions.
Usage
To use the ClusterctlConfig resource:
-
Create a
ClusterctlConfigresource with theclusterctl-configname in theturtlesnamespace. -
The
ClusterctlConfigcontroller will handle updates for theConfigMapmounted to thecluster-api-operatorwith the required clusterctl configuration based on theClusterctlConfigspec. -
Manage the
ClusterctlConfigobject declaratively to apply changes to the generated provider configurations. It may require some time for changes to take effect, askubelettakes care of updating mounted point based onConfigMapstate.
Here is an example ClusterctlConfig manifest:
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: ClusterctlConfig
metadata:
name: clusterctl-config
namespace: rancher-turtles-system
spec:
providers:
- name: metal3
url: https://github.com/metal3-io/cluster-api-provider-metal3/releases/v1.7.1/infrastructure-components.yaml
type: InfrastructureProviderThis example will generate a clusterctl configuration for the metal3 provider with the specified URL and type.
Specification
The key fields in the ClusterctlConfig spec are:
-
providers[].name- Name of the provider (e.g. metal3) -
providers[].url- URL of the provider configuration (e.g. https://github.com/metal3-io/cluster-api-provider-metal3/releases/v1.7.1/infrastructure-components.yaml). This can uselatestrelease, if supported, or pin the maximum version tov1.7.1for example. -
providers[].type- Type of the provider (e.g. InfrastructureProvider)