Skip to content

Commit

Permalink
Update dependency versions in book
Browse files Browse the repository at this point in the history 
Signed-off-by: Furkat Gofurov <furkat.gofurov@suse.com>
  • Loading branch information
@furkatgofurov7
furkatgofurov7 committed Aug 15, 2024
1 parent eaac22a commit 4e1c206
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 22 deletions.
14 changes: 7 additions & 7 deletions docs/developer-guide/install_capi_operator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This section describes how to install `Cluster API Operator` in the Kubernetes c
`CAPI` and desired `CAPI` providers could be installed using the helm-based installation for [`Cluster API Operator`](https://github.com/kubernetes-sigs/cluster-api-operator) or as a helm dependency for the `Rancher Turtles`.

### Install manually with Helm (alternative)
To install `Cluster API Operator` with version `1.4.6` of the `CAPI` + `Docker` provider using helm, follow these steps:
To install `Cluster API Operator` with version `1.7.3` of the `CAPI` + `Docker` provider using helm, follow these steps:

1. Add the Helm repository for the `Cluster API Operator`:
```bash
Expand All @@ -35,8 +35,8 @@ helm install cert-manager jetstack/cert-manager --namespace cert-manager --creat
```bash
helm install capi-operator capi-operator/cluster-api-operator
--create-namespace -n capi-operator-system
--set infrastructure=docker:v1.4.6
--set core=cluster-api:v1.4.6
--set infrastructure=docker:v1.7.3
--set core=cluster-api:v1.7.3
--timeout 90s --wait # Core Cluster API with kubeadm bootstrap and control plane providers will also be installed
```

Expand All @@ -49,8 +49,8 @@ To provide additional environment variables, enable feature gates, or supply clo
```bash
helm install capi-operator capi-operator/cluster-api-operator
--create-namespace -n capi-operator-system
--set infrastructure=docker:v1.4.6
--set core=cluster-api:v1.4.6
--set infrastructure=docker:v1.7.3
--set core=cluster-api:v1.7.3
--timeout 90s
--secret-name <secret_name>
--wait
Expand All @@ -72,10 +72,10 @@ stringData:
To select more than one desired provider to be installed together with the `Cluster API Operator`, the `--infrastructure` flag can be specified with multiple provider names separated by a comma. For example:

```bash
helm install ... --set infrastructure="docker:v1.4.6;aws:v2.3.5"
helm install ... --set infrastructure="docker:v1.7.3;aws:v2.6.1"
```

The `infrastructure` flag is set to `docker:v1.4.6;aws:v2.3.5`, representing the desired provider names. This means that the `Cluster API Operator` will install and manage multiple providers, `Docker` and `AWS`, with versions `v1.4.6` and `v2.3.5` respectively.
The `infrastructure` flag is set to `docker:v1.7.3;aws:v2.6.1`, representing the desired provider names. This means that the `Cluster API Operator` will install and manage multiple providers, `Docker` and `AWS`, with versions `v1.7.3` and `v2.6.1` respectively.

The cluster is now ready to install Rancher Turtles. The default behavior when installing the chart is to install Cluster API Operator as a Helm dependency. Since we decided to install it manually before installing Rancher Turtles, the feature `cluster-api-operator.enabled` must be explicitly disabled as otherwise it would conflict with the existing installation. You can refer to [Install Rancher Turtles without Cluster API Operator](../developer-guide/install_capi_operator.md#install-rancher-turtles-without-cluster-api-operator-as-a-helm-dependency) to see next steps.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/create-first-cluster/using_fleet.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To generate the YAML for the cluster do the following (assuming the Docker infra
```bash
export CONTROL_PLANE_MACHINE_COUNT=1
export WORKER_MACHINE_COUNT=1
export KUBERNETES_VERSION=v1.26.4
export KUBERNETES_VERSION=v1.30.0

clusterctl generate cluster cluster1 \
--from https://raw.githubusercontent.com/rancher-sandbox/rancher-turtles-fleet-example/templates/docker-rke2.yaml \
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/create-first-cluster/using_kubectl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To generate the YAML for the cluster, do the following (assuming the Docker infr
```bash
export CONTROL_PLANE_MACHINE_COUNT=1
export WORKER_MACHINE_COUNT=1
export KUBERNETES_VERSION=v1.26.4
export KUBERNETES_VERSION=v1.30.0

clusterctl generate cluster cluster1 \
--from https://raw.githubusercontent.com/rancher-sandbox/rancher-turtles-fleet-example/templates/docker-rke2.yaml \
Expand Down
12 changes: 6 additions & 6 deletions docs/getting-started/intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ This demo shows how to use the Rancher UI to install Rancher Turtles, create/imp

| Name | Version | Details |
| ------------------------ | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Kubernetes cluster | `>=1.26.0` | |
| Kubernetes cluster | `>=1.30.0` | |
| Helm | `>=3.12.0` | |
| Rancher | `>=2.8.1 | Using [helm based](https://ranchermanager.docs.rancher.com/pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster#install-the-rancher-helm-chart) installation on any kubernetes cluster directly or on a newly created [Amazon](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks), [Azure](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks) or [Google](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke) service based options. Additional feature gate [modifications](./rancher.md#installing-rancher) are required. |
| Cert-manager | `>=v1.12.0` | Using [helm](https://cert-manager.io/docs/installation/helm/#installing-with-helm) based installation or via [kubectl apply](https://cert-manager.io/docs/installation/#default-static-install). |
| Cluster API Operator | `>=v0.9.1` | Using [Rancher UI](./install-rancher-turtles/using_rancher_dashboard.md) (recommended) or [Helm install](https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/docs/README.md#method-2-use-helm-charts) (for development use cases) |
| Cluster API | `v1.4.6` | |
| Rancher Turtles | `v0.10.0` | Using [Rancher UI](./install-rancher-turtles/using_rancher_dashboard.md) (recommended) or [Helm install](./install-rancher-turtles/using_helm.md) (for advanced use cases) |
| Rancher | `>=2.9.0 | Using [helm based](https://ranchermanager.docs.rancher.com/pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster#install-the-rancher-helm-chart) installation on any kubernetes cluster directly or on a newly created [Amazon](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks), [Azure](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks) or [Google](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke) service based options. Additional feature gate [modifications](./rancher.md#installing-rancher) are required. |
| Cert-manager | `>=v1.15.2` | Using [helm](https://cert-manager.io/docs/installation/helm/#installing-with-helm) based installation or via [kubectl apply](https://cert-manager.io/docs/installation/#default-static-install). |
| Cluster API Operator | `>=v0.12.0` | Using [Rancher UI](./install-rancher-turtles/using_rancher_dashboard.md) (recommended) or [Helm install](https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/docs/README.md#method-2-use-helm-charts) (for development use cases) |
| Cluster API | `v1.7.3` | |
| Rancher Turtles | `>v0.10.0` | Using [Rancher UI](./install-rancher-turtles/using_rancher_dashboard.md) (recommended) or [Helm install](./install-rancher-turtles/using_helm.md) (for advanced use cases) |

## Reference Guides

Expand Down
6 changes: 3 additions & 3 deletions docs/reference-guides/providers/howto.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ To generate the YAML for the cluster, do the following:
```bash
export CONTROL_PLANE_MACHINE_COUNT=3
export WORKER_MACHINE_COUNT=3
export RKE2_VERSION=v1.26.0+rke2r1
export RKE2_VERSION=v1.30.3+rke2r1
export AWS_NODE_MACHINE_TYPE=t3a.large
export AWS_CONTROL_PLANE_MACHINE_TYPE=t3a.large
export AWS_SSH_KEY_NAME="aws-ssh-key"
Expand All @@ -83,7 +83,7 @@ To generate the YAML for the cluster, do the following:
1. Open a terminal and run the following:

```bash
export KUBERNETES_VERSION=v1.28
export KUBERNETES_VERSION=v1.30
export AWS_REGION=eu-west-2
export AWS_INSTANCE_TYPE=t3.medium

Expand All @@ -109,7 +109,7 @@ To generate the YAML for the cluster, do the following:
```bash
export CONTROL_PLANE_MACHINE_COUNT=1
export WORKER_MACHINE_COUNT=1
export KUBERNETES_VERSION=v1.26.4
export KUBERNETES_VERSION=v1.30.0

clusterctl generate cluster cluster1 \
--from https://raw.githubusercontent.com/rancher-sandbox/rancher-turtles-fleet-example/templates/docker-kubeadm.yaml \
Expand Down
4 changes: 2 additions & 2 deletions docs/reference-guides/rancher-turtles-chart/values.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ rancherTurtles:
features:
cluster-api-operator:
cleanup: true # indicates that rancher turtles resources are cleaned up after uninstalling (default: true)
kubectlImage: registry.k8s.io/kubernetes/kubectl:v1.28.0 # indicates the image to use for post-delete cleanup (default: Kubernetes container image registry)
kubectlImage: registry.k8s.io/kubernetes/kubectl:v1.30.0 # indicates the image to use for post-delete cleanup (default: Kubernetes container image registry)
embedded-capi: # this is a rancher functionality that is not compatible with rancher-turtles
disabled: true # indicates that embedded-capi must be disabled during installation (default: true)
rancher-webhook: # an existing rancher installation keeps rancher webhooks after disabling embedded-capi
cleanup: true # indicates that the remaining rancher webhooks be removed (default: true)
kubectlImage: registry.k8s.io/kubernetes/kubectl:v1.28.0 # indicates the image to use for pre-install cleanup (default: Kubernetes container image registry)
kubectlImage: registry.k8s.io/kubernetes/kubectl:v1.30.0 # indicates the image to use for pre-install cleanup (default: Kubernetes container image registry)
rancher-kubeconfigs: # with capi 1.5.0 and greater, secrets for kubeconfigs must contain a specific label. See https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/developer/providers/migrations/v1.4-to-v1.5.md#other
label: true # indicates that the label will be added (default: true)
managementv3-cluster: # rancher will use `clusters.management.cattle.io` to represent an imported capi cluster
Expand Down
2 changes: 1 addition & 1 deletion docs/tasks/capi-operator/add_infrastructure_provider.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ metadata:
spec:
name: aws
type: infrastructure # required
version: v2.3.5
version: v2.6.1
configSecret:
name: aws-variables # This will additionally populate the default set of feature gates for the provider inside the secret
variables:
Expand Down
2 changes: 1 addition & 1 deletion docs/tasks/capi-operator/installing_core_provider.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ metadata:
name: cluster-api
namespace: capi-system
spec:
version: v1.4.6
version: v1.7.3
type: core # required
```

0 comments on commit 4e1c206

Please sign in to comment.