Rancher Turtles

https://turtles.docs.rancher.com/turtles/v0.27/en/
Admin
Rancher Turtles is a Kubernetes operator that integrates Rancher Manager with Cluster API (CAPI) to...
Tokens:46,040
Snippets:428
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example output of get-all

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Example output from 'kubectl get-all -n capi-clusters' showing all resources in the capi-clusters namespace.

```bash
NAME                                                                                      NAMESPACE      AGE
configmap/kube-root-ca.crt                                                                capi-clusters  23h
secret/cluster1-shim                                                                     capi-clusters  32s
serviceaccount/default                                                                    capi-clusters  23h
rke2config.bootstrap.cluster.x-k8s.io/cluster1-mp-0-dm59p                                capi-clusters  32s
rke2config.bootstrap.cluster.x-k8s.io/cluster1-mp-1-gv6kh                                capi-clusters  32s
rke2configtemplate.bootstrap.cluster.x-k8s.io/cluster1-pool0                             capi-clusters  33s
rke2configtemplate.bootstrap.cluster.x-k8s.io/cluster1-pool1                             capi-clusters  33s
clusterclass.cluster.x-k8s.io/clusterclass1                                               capi-clusters  33s
cluster.cluster.x-k8s.io/cluster1                                                        capi-clusters  32s
machinepool.cluster.x-k8s.io/cluster1-mp-0-d4fd0                                         capi-clusters  32s
machinepool.cluster.x-k8s.io/cluster1-mp-1-l86kv                                         capi-clusters  32s
clustergroup.fleet.cattle.io/clusterclass1                                                capi-clusters  33s
azureclusteridentity.infrastructure.cluster.x-k8s.io/cluster-identity                     capi-clusters  33s
azuremanagedcluster.infrastructure.cluster.x-k8s.io/cluster1-l2cs6                       capi-clusters  32s
azuremanagedclustertemplate.infrastructure.cluster.x-k8s.io/cluster                     capi-clusters  33s
azuremanagedcontrolplane.infrastructure.cluster.x-k8s.io/cluster1-rv8v4                  capi-clusters  32s
azuremanagedcontrolplanetemplate.infrastructure.cluster.x-k8s.io/cluster1-control-plane  capi-clusters  33s
azuremanagedmachinepool.infrastructure.cluster.x-k8s.io/cluster1-mp-0-78tck              capi-clusters  32s
azuremanagedmachinepool.infrastructure.cluster.x-k8s.io/cluster1-mp-1-zdscw              capi-clusters  32s
azuremanagedmachinepooltemplate.infrastructure.cluster.x-k8s.io/cluster1-pool0           capi-clusters  33s
azuremanagedmachinepooltemplate.infrastructure.cluster.x-k8s.io/cluster1-pool1           capi-clusters  33s
```

--------------------------------

### Clone the Turtles Integration Suite Example repository

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/operator/certificationsuite.html

Clones the Turtles Integration Suite Example repository to get started with provider testing. Recommended for first-time users to keep configuration simple.

```bash
git clone https://github.com/rancher/turtles-integration-suite-example.git
```

--------------------------------

### Install and verify crust-gather via Krew

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Install the crust-gather plugin using kubectl krew and verify the installation with the help command.

```bash
kubectl krew install crust-gather

kubectl crust-gather --help
```

--------------------------------

### Install and verify crust-gather via script

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Install crust-gather using the standalone install.sh script and verify the installation.

```bash
curl -sSfL https://github.com/crust-gather/crust-gather/raw/main/install.sh | sh

crust-gather --help
```

--------------------------------

### Apply vSphere Kubeadm ClusterClass via Examples Tool

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Apply the vSphere Kubeadm ClusterClass and associated applications using the examples tool.

```bash
go run github.com/rancher/turtles/examples@v0.27.1 -r vsphere-kubeadm | kubectl apply -f -
```

--------------------------------

### Apply vSphere RKE2 ClusterClass with examples tool

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Applies a vSphere RKE2 ClusterClass and associated applications using the examples tool. Requires the CAAPF provider to be installed and enabled. The command pipes the generated examples to `kubectl apply`.

```bash
go run github.com/rancher/turtles/examples@v0.27.1 -r vsphere-rke2 | kubectl apply -f -
```

--------------------------------

### Apply Docker RKE2 ClusterClass via Examples Tool

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Uses the Turtles examples tool to apply the Docker RKE2 ClusterClass.

```bash
go run github.com/rancher/turtles/examples@v0.27.1 -r docker-rke2 | kubectl apply -f -
```

--------------------------------

### Apply Docker Kubeadm ClusterClass via Examples Tool

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Uses the Turtles examples tool to apply the Docker Kubeadm ClusterClass and associated applications.

```bash
go run github.com/rancher/turtles/examples@v0.27.1 -r docker-kubeadm | kubectl apply -f -
```

--------------------------------

### Install CAPRKE2 or Kubeadm Bootstrap and Control Plane Providers

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Install the bootstrap and control plane providers for either CAPRKE2 or Kubeadm. The first block creates the rke2-bootstrap and rke2-control-plane CAPIProviders; the second creates the kubeadm-bootstrap and kubeadm-control-plane providers. Both are required before further CAPIProvider setup.

```yaml
apiVersion: v1
kind: Namespace
metadata:
  name: rke2-bootstrap-system
---
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: rke2-bootstrap
  namespace: rke2-bootstrap-system
spec:
  name: rke2
  type: bootstrap
---
apiVersion: v1
kind: Namespace
metadata:
  name: rke2-control-plane-system
---
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: rke2-control-plane
  namespace: rke2-control-plane-system
spec:
  name: rke2
  type: controlPlane
```

```yaml
apiVersion: v1
kind: Namespace
metadata:
  name: capi-kubeadm-bootstrap-system
---
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: kubeadm-bootstrap
  namespace: capi-kubeadm-bootstrap-system
spec:
  name: kubeadm
  type: bootstrap
---
apiVersion: v1
kind: Namespace
metadata:
  name: capi-kubeadm-control-plane-system
---
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: kubeadm-control-plane
  namespace: capi-kubeadm-control-plane-system
spec:
  name: kubeadm
  type: controlPlane
```

--------------------------------

### Apply AWS EKS ClusterClass via Examples Tool

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Uses the examples tool to apply the AWS EKS ClusterClass and associated applications.

```bash
go run github.com/rancher/turtles/examples@main -r aws-eks | kubectl apply -f -
```

--------------------------------

### Start ngrok or inlets after tilt has started

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/developer/development.html

Commands to port-forward the Rancher service and start ngrok to expose it. Use this if you don't have ngrok credentials and haven't provided them in the earlier step.

```bash
kubectl port-forward --namespace cattle-system svc/rancher 10000:443
ngrok http https://localhost:10000
```

--------------------------------

### Install kubectl plugins lineage and get-all

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Installs the 'lineage' and 'get-all' kubectl plugins using krew. Note: third-party plugins may pose security risks in production; use primarily in development or testing.

```bash
kubectl krew install lineage
kubectl krew install get-all
```

--------------------------------

### Install Azure CCM with ClusterResourceSet

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/applications.html

This example demonstrates configuring a ConfigMap containing a HelmChart definition and a ClusterResourceSet to apply the Azure CCM to clusters matching the specified label.

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: cloud-provider-azure
  namespace: <namespace>
data:
  cloud-provider-azure.yaml: |-
    apiVersion: helm.cattle.io/v1
    kind: HelmChart
    metadata:
      name: azure-ccm
      namespace: kube-system
    spec:
      repo: https://raw.githubusercontent.com/kubernetes-sigs/cloud-provider-azure/master/helm/repo
      chart: cloud-provider-azure
      bootstrap: true
      version: "1.36.0"
      targetNamespace: kube-system
      valuesContent: |-
        infra:
          clusterName: test-cluster
        cloudControllerManager:
          clusterCIDR: 192.168.0.0/16
---
apiVersion: addons.cluster.x-k8s.io/v1beta2
kind: ClusterResourceSet
metadata:
  name: cloud-provider-azure
  namespace: <namespace>
spec:
  strategy: Reconcile
  clusterSelector:
    matchLabels:
      cloud-provider: azure
  resources:
    - name: cloud-provider-azure
      kind: ConfigMap
```

--------------------------------

### Apply Azure RKE2 ClusterClass via examples tool

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Use the Rancher Turtles examples tool to apply the Azure RKE2 ClusterClass configuration.

```bash
go run github.com/rancher/turtles/examples@v0.27.1 -r azure-rke2 | kubectl apply -f -
```

--------------------------------

### Install stern plugin via Krew

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Install the stern plugin using the Krew package manager to enable advanced log tailing capabilities.

```bash
kubectl krew install stern
```

--------------------------------

### Apply AWS RKE2 ClusterClass using examples tool

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Applies the AWS RKE2 ClusterClass and associated applications using the examples tool. This is the CLI method for creating the ClusterClass.

```bash
go run github.com/rancher/turtles/examples@v0.27.1 -r aws-rke2 | kubectl apply -f -

```

--------------------------------

### Apply Azure AKS ClusterClass via examples tool

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Use the Rancher Turtles examples tool to apply the Azure AKS ClusterClass configuration.

```bash
go run github.com/rancher/turtles/examples@v0.27.1 -r azure-aks | kubectl apply -f -
```

--------------------------------

### Apply GCP GKE ClusterClass using examples tool

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Applies a GCP GKE ClusterClass and associated applications using the examples tool. The output is piped to kubectl apply.

```bash
go run github.com/rancher/turtles/examples@main -r gcp-gke | kubectl apply -f -
```

--------------------------------

### Install vSphere Cloud Provider and Calico CNI

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Install the vSphere Cloud Provider and Calico CNI using HelmOps for automatic application at cluster creation.

```bash
kubectl apply -f https://raw.githubusercontent.com/rancher/turtles/refs/tags/v0.27.1/examples/applications/ccm/vsphere/helm-chart.yaml
kubectl apply -f https://raw.githubusercontent.com/rancher/turtles/refs/tags/v0.27.1/examples/applications/cni/calico/helm-chart.yaml
```

--------------------------------

### Install Rancher with Helm

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/tutorials/rancher.html

A minimal Helm command to install Rancher. Replace <rancher-hostname> with your server's hostname and ensure the version is v2.13.0 or later.

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

--------------------------------

### Explain clusterclass resource

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Shows how to get a full explanation of the clusterclass resource, including its configuration options.

```bash
kubectl api-resources | grep clusterclass
kubectl explain clusterclass.cluster.x-k8s.io
```

--------------------------------

### Install Cluster API Provider Azure (CAPIProvider)

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Installs the Cluster API Provider Azure by creating the capz-system namespace and a CAPIProvider resource. The provider is pinned to the default version unless spec.version is set; automatic updates can be disabled with spec.enableAutomaticUpdate: false.

```yaml
apiVersion: v1
kind: Namespace
metadata:
  name: capz-system
---
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: azure
  namespace: capz-system
spec:
  type: infrastructure
  name: azure

```

--------------------------------

### Install Cluster API Provider AWS (CAPIProvider)

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Installs the Cluster API Provider AWS with empty global credentials because AWSClusterStaticIdentity will be used instead. The provider is pinned to the default version unless spec.version is set; automatic updates can be disabled with spec.enableAutomaticUpdate: false.

```yaml
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: aws
  namespace: capa-system
spec:
  type: infrastructure
  variables:
    AWS_B64ENCODED_CREDENTIALS: ""

```

--------------------------------

### Example ConfigMap manifest

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/operator/airgapped.html

Shows the structure of the ConfigMap created by the previous commands, with labels and data fields for components and metadata.

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
  labels:
    provider-components: vsphere
  name: v1.12.0
  namespace: capv-system
data:
  components: |
    # Components for v1.12.0 YAML go here
  metadata: |
    # Metadata information goes here
```

--------------------------------

### Run make dev-env for Rancher Turtles

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/developer/development.html

Command to start the development environment. Optionally, you can set NGROK_API_KEY, NGROK_AUTHTOKEN, and RANCHER_HOSTNAME to use a custom hostname for Rancher.

```bash
make dev-env

# Or if you want to use a custom hostname for Rancher and your ngrok credentials
NGROK_API_KEY=`key` NGROK_AUTHTOKEN=`token` RANCHER_HOSTNAME=my.customhost.dev make dev-env
```

--------------------------------

### Install Cluster API Provider GCP (CAPIProvider)

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Installs the Cluster API Provider GCP with the base64-encoded Service Account key set in the GCP_B64ENCODED_CREDENTIALS variable. The Service Account requires Editor permissions; the key must be base64-encoded. The provider is pinned to the default version unless spec.version is set; automatic updates can be disabled with spec.enableAutomaticUpdate: false.

```yaml
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: gcp
  namespace: capg-system
spec:
  type: infrastructure
  variables:
    GCP_B64ENCODED_CREDENTIALS: xxx

```

--------------------------------

### Configure CAPIProvider with CLUSTER_TOPOLOGY

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/operator/clusterclass.html

Example of a CAPIProvider resource configuration that enables CLUSTER_TOPOLOGY and other experimental features for the Azure provider.

```yaml
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: azure
  namespace: capz-system
spec:
  type: infrastructure
  name: azure
  configSecret:
    name: azure-variables
  variables:
    CLUSTER_TOPOLOGY: "true"
    EXP_CLUSTER_RESOURCE_SET: "true"
    EXP_MACHINE_POOL: "true"
    EXP_AKS_RESOURCE_HEALTH: "true"
```

--------------------------------

### Create Azure Kubeadm Cluster Manifest

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Defines a Cluster manifest using the azure-kubeadm-example ClusterClass with labels for automatic add-on installation.

```yaml
apiVersion: cluster.x-k8s.io/v1beta2
kind: Cluster
metadata:
  labels:
    cluster-api.cattle.io/rancher-auto-import: "true"
    cloud-provider: azure
    cni: calico
  name: azure-kubeadm-quickstart
spec:
  clusterNetwork:
    pods:
      cidrBlocks:
      - 192.168.0.0/16
  topology:
    classRef:
      name: azure-kubeadm-example
    controlPlane:
      replicas: 1
    variables:
    - name: subscriptionID
      value: <AZURE_SUBSCRIPTION_ID>
    - name: location
      value: <AZURE_LOCATION>
    - name: resourceGroup
      value: <AZURE_RESOURCE_GROUP>
    - name: azureClusterIdentityName
      value: cluster-identity
    version: v1.36.1
    workers:
      machineDeployments:
      - class: kubeadm-default-worker
        name: md-0
        replicas: 1
```

--------------------------------

### Create namespace and apply CAPIProvider configuration

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/operator/airgapped.html

Creates the capnz-system namespace and applies the CAPIProvider YAML file to deploy the provider from the private registry.

```bash
kubectl create namespace capz-system
kubectl apply -f capz-provider-oci.yaml
```

--------------------------------

### Install Azure Cloud Provider and Calico CNI HelmOps

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Apply the HelmOps configurations for the Azure Cloud Provider and Calico CNI to enable automatic installation on downstream clusters.

```bash
kubectl apply -f https://raw.githubusercontent.com/rancher/turtles/refs/tags/v0.27.1/examples/applications/ccm/azure/helm-chart.yaml
kubectl apply -f https://raw.githubusercontent.com/rancher/turtles/refs/tags/v0.27.1/examples/applications/cni/calico/helm-chart.yaml
```

--------------------------------

### Fetch provider manifests and create ConfigMap

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/operator/airgapped.html

Commands to download the vSphere provider components and metadata from GitHub releases and create a ConfigMap in the capv-system namespace. Adapt the URLs and version for your provider.

```bash
# Get the file contents from the GitHub release
curl -L https://github.com/rancher-sandbox/cluster-api-provider-vsphere/releases/download/v1.12.0/infrastructure-components.yaml -o components.yaml
curl -L https://github.com/rancher-sandbox/cluster-api-provider-vsphere/releases/download/v1.12.0/metadata.yaml -o metadata.yaml

# Create the configmap from the files
kubectl create configmap v1.12.0 --namespace=capv-system --from-file=components=components.yaml --from-file=metadata=metadata.yaml --dry-run=client -o yaml > configmap.yaml
```

--------------------------------

### Create vSphere Cluster from ClusterClass with Fleet Bundles

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

These YAML manifests configure the vSphere Cloud Provider and CSI driver via Fleet Bundles and create a vSphere Cluster from the example ClusterClass. The Bundles target the downstream Cluster by name `vsphere-kubeadm-quickstart`; change the target labels if you use a different Cluster name. The Cluster uses kube-vip as a Control Plane load balancer; set `KUBE_VIP_INTERFACE` (e.g., `eth0`) according to your network device.

```yaml
kind: Bundle
apiVersion: fleet.cattle.io/v1alpha1
metadata:
  name: vsphere-csi-config
spec:
  resources:
  - content: |-
      apiVersion: v1
      kind: Secret
      type: Opaque
      metadata:
        name: vsphere-config-secret
        namespace: vmware-system-csi
      stringData:
        csi-vsphere.conf: |+
          [Global]
          thumbprint = "<VSPHERE_THUMBPRINT>"
          [VirtualCenter "<VSPHERE_SERVER>"]
          user = "<VSPHERE_USER>"
          password = "<VSPHERE_PASSWORD>"
          datacenters = "<VSPHERE_DATACENTED>"
          [Network]
          public-network = "<VSPHERE_NETWORK>"
          [Labels]
          zone = ""
          region = ""
  targets:
  - clusterSelector:
      matchLabels:
        csi: vsphere
        cluster.x-k8s.io/cluster-name: 'vsphere-kubeadm-quickstart'
---
kind: Bundle
apiVersion: fleet.cattle.io/v1alpha1
metadata:
  name: vsphere-cloud-credentials
spec:
  resources:
  - content: |-
      apiVersion: v1
      kind: Secret
      type: Opaque
      metadata:
        name: vsphere-cloud-secret
        namespace: kube-system
      stringData:
        <VSPHERE_SERVER>.password: "<VSPHERE_PASSWORD>"
        <VSPHERE_SERVER>.username: "<VSPHERE_USER>"
  targets:
  - clusterSelector:
      matchLabels:
        cloud-provider: vsphere
        cluster.x-k8s.io/cluster-name: 'vsphere-kubeadm-quickstart'
```

```yaml
apiVersion: cluster.x-k8s.io/v1beta2
kind: Cluster
metadata:
  labels:
    cni: calico
    cloud-provider: vsphere
    csi: vsphere
    cluster-api.cattle.io/rancher-auto-import: "true"
  name: 'vsphere-kubeadm-quickstart'
spec:
  clusterNetwork:
    pods:
      cidrBlocks:
      - 192.168.0.0/16
  topology:
    classRef:
      name: vsphere-kubeadm-example
    version: v1.36.1
    controlPlane:
      replicas: 3
    workers:
      machineDeployments:
      - class: vsphere-kubeadm-example-worker
        name: md-0
        replicas: 1
    variables:
    - name: vSphereClusterIdentityName
      value: cluster-identity
    - name: vSphereTLSThumbprint
      value: <VSPHERE_THUMBPRINT>
    - name: vSphereDataCenter
      value: <VSPHERE_DATACENTER>
    - name: vSphereDataStore
      value: <VSPHERE_DATASTORE>
    - name: vSphereFolder
      value: <VSPHERE_FOLDER>
    - name: vSphereNetwork
      value: <VSPHERE_NETWORK>
    - name: vSphereResourcePool
      value: <VSPHERE_RESOURCE_POOL>
    - name: vSphereServer
      value: <VSPHERE_SERVER>
    - name: vSphereTemplate
      value: <VSPHERE_TEMPLATE>
    - name: controlPlaneIpAddr
      value: <CONTROL_PLANE_IP>
    - name: controlPlanePort
      value: 6443
    - name: sshKey
      value: <SSH_KEY>
    - name: kubeVIPInterface
      value: <KUBE_VIP_INTERFACE>
```

--------------------------------

### CAPIProvider resource for OCI artifact installation

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/operator/airgapped.html

YAML configuration for a CAPIProvider named azure in the capz-system namespace, referencing a private registry OCI artifact. Applies to both installation and mirroring workflows.

```yaml
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: azure
  namespace: capz-system
spec:
  type: infrastructure
  name: azure
  version: ${RELEASE_TAG}
  fetchConfig:
    oci: ${REGISTRY}:${RELEASE_TAG}
```

--------------------------------

### CAPIProvider manifest example for AWS infrastructure provider

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/reference/capiprovider.html

Example manifest for creating an AWS infrastructure provider. It references a Rancher cloud credential secret and a config secret, enables automatic updates, and enables the clusterResourceSet feature. The controller owns generated resources, allowing garbage collection by deleting the CAPIProvider object.

```yaml
apiVersion: turtles-capi.cattle.io/v1alpha1
kind: CAPIProvider
metadata:
  name: aws-infra
  namespace: capi-providers
spec:
  name: aws
  type: infrastructure
  enableAutomaticUpdate: true
  credentials:
    rancherCloudCredential: aws-creds # Rancher credentials secret for AWS
  configSecret:
    name: aws-config
  features:
    clusterResourceSet: true

```

--------------------------------

### Collect data using a configuration file

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Run the collection process using a specified YAML configuration file.

```bash
kubectl crust-gather collect-from-config -c config.yaml
```

--------------------------------

### Rancher cluster filter configuration

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Example YAML filter configuration for the rancher-crust-gather.yaml file.

```yaml
filters:
  - include_group:
    - .*cluster.x-k8s.io/.*
    - turtles-capi.cattle.io/.*
  - include_kind:
    - CustomResourceDefinition
    - Node
    - Namespace
  - include_group:
    - management.cattle.io/.*
    - provisioning.cattle.io/.*
  - include_namespace:
    - cattle-turtles-system
    - capi-.*
    - cattle.*
    - fleet.*
    - c-.*
    - rke2.*
    - cert-manager
    - kube-system
settings:
  insecure_skip_tls_verify: true
  secrets_file: secrets.txt
```

--------------------------------

### Collect data using command-line flags

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Run the collection process by specifying namespaces and kubeconfig via flags.

```bash
kubectl crust-gather collect --include-namespace cattle-turtles-system --include-namespace capi-* --include-namespace cattle* --include-namespace c-* --include-namespace=<any-capi-cluster-namespace> --kubeconfig=<KUBECONFIG>
```

--------------------------------

### Child cluster filter configuration

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Example YAML filter configuration for the child-crust-gather.yaml file.

```yaml
filters:
  - include_kind:
    - Node
    - Namespace
    - CustomResourceDefinition
  - include_group:
    - management.cattle.io/.*
    - provisioning.cattle.io/.*
  - include_namespace:
    - cattle.*
    - fleet.*
    - kube-system
settings:
  insecure_skip_tls_verify: true
  secrets_file: secrets.txt
```

--------------------------------

### Define Docker Kubeadm Cluster Resource

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Example Cluster manifest for a Docker Kubeadm deployment.

```yaml
apiVersion: cluster.x-k8s.io/v1beta2
kind: Cluster
metadata:
  name: docker-kubeadm-quickstart
  labels:
    cni: calico
spec:
  clusterNetwork:
    pods:
      cidrBlocks:
        - 192.168.0.0/16
    serviceDomain: cluster.local
    services:
      cidrBlocks:
        - 10.96.0.0/24
  topology:
    classRef:
      name: docker-kubeadm-example
    controlPlane:
      replicas: 1
    version: v1.36.1
    workers:
      machineDeployments:
        - class: default-worker
          name: md-0
          replicas: 1
```

--------------------------------

### Switch kubectl namespace

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/troubleshooting/troubleshooting.html

Shows how to view the current KUBECONFIG and switch the default namespace for kubectl commands.

```bash
kubectl config view
kubectl config set-context --current --namespace <NAMESPACE>
```

--------------------------------

### Define a CAPIProvider

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/tutorials/rancher.html

Example YAML configuration for a CAPIProvider custom resource to manage infrastructure providers.

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

--------------------------------

### Recommended repository folder structure

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/gitops.html

Shows the recommended folder layout for a Fleet-based GitOps repository, separating providers, clusters, addons, templates, and overlays by environment.

```plaintext
repo-root/
│── fleet/
│   ├── providers/         # CAPIProvider files to use with templates
│   │   ├── core/          # Core provider configuration
│   │   ├── infra-docker/  # Docker provider configuration
│   │   ├── infra-aws/     # AWS provider configuration
│   ├── clusters/          # Cluster-specific configurations
│   │   ├── prod/          # Production clusters
│   │   ├── staging/       # Staging clusters
│   │   ├── dev/           # Development clusters
│   ├── addons/            # Application-specific manifests focused on cluster bootstrapping, like CNI, CCM, CPI configurations.
│   │   ├── cni/           # Group applications based on purpose. Provide fleet.yaml per each sub-directory to maintain bundle separation.
│   │   ├── ccm/
│   ├── templates/         # CAPI ClusterClass templates for cluster provisioning
│   ├── fleet.yaml         # Fleet bundle configuration
│── overlays/              # Kustomize overlays for different environments
│   ├── prod/.             # Kustomize overlays for production environments
│   ├── staging/.          # Kustomize overlays for staging environments
│   ├── dev/.              # Kustomize overlays for development environments
```

--------------------------------

### Watch cluster resources become ready

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/tutorials/first-cluster.html

Watch the cluster resources until they become ready using kubectl. This is the fourth step in the manual provisioning method.

```bash
kubectl get clusters -w
```

--------------------------------

### Define Docker RKE2 Cluster Resource

Source: https://turtles.docs.rancher.com/turtles/v0.27/en/user/clusterclass.html

Create the Docker RKE2 Cluster using the example ClusterClass definition.

```yaml
apiVersion: cluster.x-k8s.io/v1beta2
kind: Cluster
metadata:
  name: docker-rke2-example
  labels:
    cni: calico
  annotations:
    cluster-api.cattle.io/upstream-system-agent: "true"
spec:
  clusterNetwork:
    pods:
      cidrBlocks:
      - 192.168.0.0/16
    services:
      cidrBlocks:
      - 10.96.0.0/24
    serviceDomain: cluster.local
  topology:
    classRef:
      name: docker-rke2-example
    controlPlane:
      replicas: 1
    variables:
    - name: rke2CNI
      value: none
    - name: dockerImage
      value: kindest/node:v1.35.0
    version: v1.36.0+rke2r1
    workers:
      machineDeployments:
      - class: default-worker
        name: md-0
        replicas: 1
```
Tokens:
Raw