Skip to main content
Version: 0.1

Rancher Setup

Installing Rancher​

If you're already running Rancher, you can skip this section and jump to Setting up Rancher for Rancher Turtles.

Helm is the recommended way to install Rancher in an existing or new Kubernetes cluster.

tip

Make sure to follow one of the official installation guides for Rancher.

Here's a minimal configuration example of a command to install Rancher:

helm install rancher rancher-stable/rancher
    --namespace cattle-system
    --create-namespace
    --set hostname=<rancher-hostname>
    --version <rancher-version>
    --wait

Replace <rancher-hostname> with the actual hostname of your Rancher server and use the --version option to specify the version of Rancher you want to install. In this case, use the recommended Rancher version for Rancher Turtles.

Setting up Rancher for Rancher Turtles​

Before installing Rancher Turtles in your Rancher environment, Rancher's embedded-cluster-api functionality must be disabled. This includes also cleaning up Rancher specific webhooks that otherwise would conflict with CAPI ones.

:::noteCaution! Follow these instructions in the order below. Altering the execution sequence may cause errors due to inconsistent resource configuration. :::

  1. Create a feature.yaml file, with embedded-cluster-api set to false:
feature.yaml
apiVersion: management.cattle.io/v3
kind: Feature
metadata:
  name: embedded-cluster-api
spec:
  value: false
  1. Use kubectl to apply the feature.yaml file to the cluster:
kubectl apply -f feature.yaml
  1. Delete the remaining Rancher webhooks to avoid conflicts with CAPI.
kubectl delete mutatingwebhookconfigurations.admissionregistration.k8s.io mutating-webhook-configuration
kubectl delete validatingwebhookconfigurations.admissionregistration.k8s.io validating-webhook-configuration

Your Rancher installation is now ready to install and use Rancher Turtles! 🎉