Overview

The core CAPI controller manifest is embedded in a ConfigMap, which simplifies operation in air-gapped environments.

SUSE® Rancher Prime: Cluster API is automatically deployed as a system component in the cattle-turtles-system namespace. This includes:

  • The rancher-turtles-controller-manager pod, which handles all CAPI-related resources.

  • Core CAPI CRDs and the core CAPI controller.

  • The CAPIProvider custom resource, which allows declarative definition of CAPI providers.

Security

As defined by Supply-chain Levels for Software Artifacts (SLSA), SLSA is a set of incrementally adoptable guidelines for supply chain security, established by industry consensus. The specification set by SLSA is useful for both software producers and consumers: producers can follow SLSA’s guidelines to make their software supply chain more secure, and consumers can use SLSA to make decisions about whether to trust a software package.

SUSE® Rancher Prime: Cluster API meets SLSA Level 3 requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. For more information, visit the SUSE® Rancher Prime: Cluster API Security document.

Installing CAPI Providers

With SUSE® Rancher Prime: Cluster API embedded in Rancher, CAPI providers are no longer bundled by default. Providers are managed declaratively using the CAPIProvider custom resource.

A separate providers chart for Prime users is available for installing certified providers. For more information, refer to Install certified providers.

For example, to define a provider:

apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: aws
  namespace: cattle-turtles-system
spec:
  type: infrastructure
  name: aws

Refer to the CAPIProvider reference for the full list of configuration options.

Uninstalling

When installing SUSE® Rancher Prime: Cluster API in your Rancher environment, the CAPI Operator cleanup is enabled by default. This includes cleaning up CAPI Operator specific webhooks and deployments that otherwise cause issues with Rancher provisioning.

To simplify uninstalling SUSE® Rancher Prime: Cluster API (via Rancher or Helm command), the official SUSE® Rancher Prime: Cluster API Helm chart includes a post-delete hook that removes the following:

  • Deletes the mutating-webhook-configuration and validating-webhook-configuration webhooks that are no longer needed.

  • Deletes the CAPI deployments that are no longer needed.

To uninstall SUSE® Rancher Prime: Cluster API:

helm uninstall -n cattle-turtles-system rancher-turtles --cascade foreground --wait

This may take a few minutes to complete.

Remember that, if you use a different name for the installation or a different namespace, you may need to customize the command for your specific configuration.

After SUSE® Rancher Prime: Cluster API is uninstalled, Rancher’s embedded-cluster-api feature must be re-enabled:

  1. Create a feature.yaml file, with embedded-cluster-api set to true:

    feature.yaml
    apiVersion: management.cattle.io/v3
kind: Feature
metadata:
  name: embedded-cluster-api
spec:
  value: true

  2. Use kubectl to apply the feature.yaml file to the cluster:

    kubectl apply -f feature.yaml