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.

Run the Providers migration script

If you are using SUSE® Rancher Prime Cluster API with Rancher v2.12 or earlier and want to install the Providers chart in Rancher v2.13 or later, follow the steps in this section to ensure a smooth migration for any CAPI providers previously installed by default. For new installations, skip to the next section.

Follow the migration guide to update your cluster to Rancher v2.13. After the cluster has been upgraded, download and run the Providers migration script against your management cluster. By default, the script will update the namespaces and CAPIProvider resources for CAPRKE2 and CAAPF so that they are adopted by (or become part of) the new Providers Helm chart, when this is installed. The script will also delete the legacy CAAPF provider, if running on the rancher-turtles-system namespace.

./migrate-providers-ownership.sh
Adopting existing turtles resources into Helm ownership
Release: rancher-turtles-providers Namespace: cattle-turtles-system
Found legacy Fleet CAPIProvider in rancher-turtles-system, deleting before providers install
capiprovider.turtles-capi.cattle.io "fleet" deleted from rancher-turtles-system namespace
configmap "fleet-addon-config" deleted from rancher-turtles-system namespace
Adopting namespace rancher-turtles-system
namespace/rancher-turtles-system patched
CAPIProvider fleet in rancher-turtles-system not found, skipping
Adopting namespace rke2-bootstrap-system
namespace/rke2-bootstrap-system patched
Adopting CAPIProvider rke2-bootstrap in rke2-bootstrap-system
capiprovider.turtles-capi.cattle.io/rke2-bootstrap patched
Adopting namespace rke2-control-plane-system
namespace/rke2-control-plane-system patched
Adopting CAPIProvider rke2-control-plane in rke2-control-plane-system
capiprovider.turtles-capi.cattle.io/rke2-control-plane patched
Migration completed

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.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 the CAPRKE2 and Fleet Addon providers are enabled by default and will be installed unless explicitly disabled.

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=${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