Install certified providers
This section describes how to install the SUSE® Rancher Prime Cluster API Providers chart, which installs the certified providers.
Prerequisites
-
Ensure SUSE® Rancher Prime Cluster API has been installed. Starting with Rancher v2.13, it is installed automatically with Rancher. For more information, refer to Rancher Setup.
-
Install Helm and configure
kubectlto access the Rancher management cluster.
Before you begin
The helm install commands on this page use the following placeholders:
<prime-registry-url>-
The hostname of the SUSE Rancher Prime registry that you use to install Rancher Prime.
<version>-
The version of the SUSE® Rancher Prime Cluster API Providers chart. Use the same chart version as the
rancher-turtleschart that Rancher installed. To find it, run:helm list --namespace cattle-turtles-system --filter rancher-turtlesThe
CHARTcolumn shows the name and version of the chart, for examplerancher-turtles-110.0.4+up0.27.4. In this example, use--version 110.0.4+up0.27.4.
Install the SUSE® Rancher Prime Cluster API Providers chart
To install all certified providers, run the following command:
helm install rancher-turtles-providers oci://<prime-registry-url>/rancher/charts/rancher-turtles-providers \
--version <version> \
--namespace cattle-turtles-system \
--set providers.bootstrapKubeadm.enabled=true \
--set providers.controlplaneKubeadm.enabled=true \
--set providers.infrastructureDocker.enabled=true \
--set providers.infrastructureAWS.enabled=true \
--set providers.infrastructureAWS.variables.AWS_B64ENCODED_CREDENTIALS="" \
--set providers.infrastructureAzure.enabled=true \
--set providers.infrastructureGCP.enabled=true \
--set providers.infrastructureGCP.variables.GCP_B64ENCODED_CREDENTIALS="" \
--set providers.infrastructureVSphere.enabled=true \
--set providers.bootstrapRKE2.enabled=true \
--set providers.controlplaneRKE2.enabled=true \
--set providers.addonFleet.enabled=true \
--wait
The command above is used to install all certified providers. You may customize which providers are installed by setting the relevant flags to true. Note that only the CAPRKE2 provider is enabled by default and will be installed unless explicitly disabled.
The commands above leave the provider credentials empty. You configure the credentials for each cluster as described in Provider credentials.
For example, to be able to provision RKE2 clusters on AWS you just need to install the AWS provider as following:
helm install rancher-turtles-providers oci://<prime-registry-url>/rancher/charts/rancher-turtles-providers \
--version <version> \
--namespace cattle-turtles-system \
--set providers.infrastructureAWS.enabled=true \
--set providers.infrastructureAWS.variables.AWS_B64ENCODED_CREDENTIALS="" \
--wait
To be able to provision RKE2 clusters on Azure, just install the Azure provider as following:
helm install rancher-turtles-providers oci://<prime-registry-url>/rancher/charts/rancher-turtles-providers \
--version <version> \
--namespace cattle-turtles-system \
--set providers.infrastructureAzure.enabled=true \
--wait
Provider credentials
Infrastructure providers need credentials to create resources in your cloud or virtualization platform. The recommended approach is to install the providers with empty global credentials and to define a cluster identity resource for each cluster. For examples, refer to Provision a CAPI cluster with ClusterClass.
- AWS (CAPA)
-
Leave
AWS_B64ENCODED_CREDENTIALSempty and create anAWSClusterStaticIdentitythat references a Secret with your AWS access key. For more information, refer to Provision a CAPI cluster with ClusterClass and the CAPA multi-tenancy documentation.If you want the provider to use a single set of global credentials instead, generate the value of
AWS_B64ENCODED_CREDENTIALSwith clusterawsadm:export AWS_REGION=<aws-region> export AWS_ACCESS_KEY_ID=<aws-access-key-id> export AWS_SECRET_ACCESS_KEY=<aws-secret-access-key> export AWS_B64ENCODED_CREDENTIALS=$(clusterawsadm bootstrap credentials encode-as-profile)Then pass it to the chart:
--set providers.infrastructureAWS.variables.AWS_B64ENCODED_CREDENTIALS=${AWS_B64ENCODED_CREDENTIALS} - Azure (CAPZ)
-
The Azure provider does not use global credentials. Create an
AzureClusterIdentitythat references a Secret with the Service Principal credentials. For managed AKS clusters, create a Secret with the Service Principal credentials instead. For more information, refer to Provision a CAPI cluster with ClusterClass. - GCP (CAPG)
-
Set
GCP_B64ENCODED_CREDENTIALSto the base64-encoded key of a GCP Service Account. To create the Service Account, refer to the CAPG book. To encode the key, run:export GCP_B64ENCODED_CREDENTIALS=$(base64 < /path/to/service-account-key.json | tr -d '\n')Then pass it to the chart:
--set providers.infrastructureGCP.variables.GCP_B64ENCODED_CREDENTIALS=${GCP_B64ENCODED_CREDENTIALS} - vSphere (CAPV)
-
The chart sets
VSPHERE_USERNAMEandVSPHERE_PASSWORDto empty values. Create aVSphereClusterIdentitythat references a Secret with your vSphere credentials. For more information, refer to Provision a CAPI cluster with ClusterClass and the CAPV identity management documentation.