Skip to content

Commit 4a6f72f

Browse files
Merge pull request #247 from furkatgofurov7/prepare-docs-for-018-version
Prepare next version of docs for v0.18 release
2 parents 3318ab8 + d52512c commit 4a6f72f

File tree

5 files changed

+68
-61
lines changed

5 files changed

+68
-61
lines changed

docs/next/modules/en/pages/operator/certificationsuite.adoc

+8-6
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,11 @@ In previous sections we introduced the main actions performed in the sample test
6464
* The main test suite, and the one used as an example, is based on a GitOps flow and uses https://github.com/rancher/fleet[Fleet] as a GitOps orchestrator tool. Based on the cluster templates provided (you can check the ones that come with the example integration https://github.com/rancher-sandbox/turtles-integration-suite-example/tree/main/suites/data/cluster-templates[here]), it will create the CAPI clusters defined in the YAML files. Once this/these cluster/s are available, they will be configured to be xref:../tutorials/first-cluster.adoc[imported into Rancher using Turtles] and it will verify that the downstream cluster/s is/are accessible via Rancher. It will also check that deletion can be performed on downstream clusters and that they are no longer available in Rancher.
6565

6666
== Other options
67+
:kubernetes-version: v1.31.4
6768

6869
You can take a look at the `config.yaml` https://github.com/rancher-sandbox/turtles-integration-suite-example/blob/main/config/config.yaml[file] in the `turtles-integration-suite-example` repository, which contains a list of environment variables used during test environment deployment and test execution. The following is a truncated version of the above mentioned YAML file:
6970

71+
[source,yaml,subs=attributes+]
7072
----
7173
...
7274
variables:
@@ -75,15 +77,15 @@ variables:
7577
SKIP_RESOURCE_CLEANUP: "false"
7678
ARTIFACTS_FOLDER: "_artifacts"
7779
MANAGEMENT_CLUSTER_ENVIRONMENT: "kind" # supported options are eks, isolated-kind, kind
78-
RANCHER_VERSION: "v2.8.1"
79-
KUBERNETES_VERSION: "v1.28.6"
80-
KUBERNETES_MANAGEMENT_VERSION: "v1.27.0"
80+
RANCHER_VERSION: "v2.10.2"
81+
KUBERNETES_VERSION: "{kubernetes-version}"
82+
KUBERNETES_MANAGEMENT_VERSION: "{kubernetes-version}"
8183
KUBERNETES_MANAGEMENT_AWS_REGION: "eu-west-2"
82-
RKE2_VERSION: "v1.28.1+rke2r1"
84+
RKE2_VERSION: "{kubernetes-version}+rke2r1"
8385
TURTLES_PATH: "turtles/rancher-turtles"
8486
TURTLES_REPO_NAME: "turtles"
8587
TURTLES_URL: https://rancher.github.io/turtles
86-
TURTLES_VERSION: "v0.10.0"
88+
TURTLES_VERSION: "v0.18.0"
8789
RANCHER_HOSTNAME: "localhost"
8890
RANCHER_FEATURES: ""
8991
RANCHER_PATH: "rancher-latest/rancher"
@@ -106,7 +108,7 @@ variables:
106108
GITEA_REPO_NAME: "gitea-charts"
107109
GITEA_REPO_URL: "https://dl.gitea.com/charts/"
108110
GITEA_CHART_NAME: "gitea"
109-
GITEA_CHART_VERSION: "9.4.0"
111+
GITEA_CHART_VERSION: "10.6.0"
110112
...
111113
----
112114

docs/next/modules/en/pages/tutorials/first-cluster.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ To generate the YAML for the cluster, do the following:
6464
export CLUSTER_NAME=cluster1
6565
export CONTROL_PLANE_MACHINE_COUNT=1
6666
export WORKER_MACHINE_COUNT=1
67-
export KUBERNETES_VERSION=v1.30.0
67+
export KUBERNETES_VERSION=v1.31.4
6868
export NAMESPACE=capi-clusters
6969
7070
curl -s https://raw.githubusercontent.com/rancher-sandbox/rancher-turtles-fleet-example/templates/docker-rke2.yaml | envsubst > cluster1.yaml

docs/next/modules/en/pages/tutorials/quickstart.adoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Before you can install {product_name}, you need to have the following components
1515
| Name | Version | Details
1616

1717
| Kubernetes cluster
18-
| `v1.31.0`
18+
| `v1.31.4`
1919
|
2020

2121
| Helm
22-
| `v3.17.0`
22+
| `v3.17.1`
2323
| Follow the official https://helm.sh/docs/intro/install[installation docs]
2424

2525
| Rancher
@@ -33,7 +33,7 @@ Before you can install {product_name}, you need to have the following components
3333

3434
== Components Versions
3535

36-
This table lists the version of the components installed with the latest version `v0.17.0` of {product_name}:
36+
This table lists the version of the components installed with the latest version `v0.18.0` of {product_name}:
3737

3838
[TIP]
3939
====
@@ -44,13 +44,13 @@ If you're customizing the installation parameters, please make sure that you are
4444
| Name | Version
4545

4646
| Cluster API Operator
47-
| `v0.17.0`
47+
| `v0.17.1`
4848

4949
| Cluster API
50-
| `v1.9.5`
50+
| `v1.9.6`
5151

5252
| Cluster API Provider RKE2
53-
| `v0.12.0`
53+
| `v0.13.0`
5454
|===
5555

5656
== Install {product_name} using Rancher Dashboard

docs/next/modules/en/pages/user/clusters.adoc

+52-47
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,11 @@ spec:
246246
======
247247

248248
== Create Your Cluster Definition
249+
:kubernetes-version: v1.31.4
250+
:cluster-name: cluster1
251+
:namespace: capi-clusters
252+
:worker-machine-count: 1
253+
:control-plane-machine-count: 1
249254

250255
[tabs]
251256
======
@@ -261,13 +266,13 @@ To generate the YAML for the cluster, do the following:
261266
+
262267
. Open a terminal and run the following:
263268
+
264-
[source,bash]
269+
[source,bash,subs=attributes+]
265270
----
266-
export CLUSTER_NAME=cluster1
267-
export NAMESPACE=capi-clusters
268-
export CONTROL_PLANE_MACHINE_COUNT=1
269-
export WORKER_MACHINE_COUNT=1
270-
export RKE2_VERSION=v1.30.3+rke2r1
271+
export CLUSTER_NAME={cluster-name}
272+
export NAMESPACE={namespace}
273+
export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
274+
export WORKER_MACHINE_COUNT={worker-machine-count}
275+
export RKE2_VERSION={kubernetes-version}+rke2r1
271276
export AWS_NODE_MACHINE_TYPE=t3a.large
272277
export AWS_CONTROL_PLANE_MACHINE_TYPE=t3a.large
273278
export AWS_SSH_KEY_NAME="aws-ssh-key"
@@ -295,17 +300,17 @@ To generate the YAML for the cluster, do the following:
295300
+
296301
. Open a terminal and run the following:
297302
+
298-
[source,bash]
303+
[source,bash,subs=attributes+]
299304
----
300-
export CLUSTER_NAME=cluster1
301-
export NAMESPACE=capi-clusters
305+
export CLUSTER_NAME={cluster-name}
306+
export NAMESPACE={namespace}
302307
export AWS_CONTROL_PLANE_MACHINE_TYPE=t3.large
303308
export AWS_NODE_MACHINE_TYPE=t3.large
304309
export AWS_SSH_KEY_NAME="aws-ssh-key"
305310
export AWS_REGION="aws-region"
306-
export KUBERNETES_VERSION=v1.29.9
307-
export CONTROL_PLANE_MACHINE_COUNT=1
308-
export WORKER_MACHINE_COUNT=1
311+
export KUBERNETES_VERSION={kubernetes-version}
312+
export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
313+
export WORKER_MACHINE_COUNT={worker-machine-count}
309314
310315
curl -s https://raw.githubusercontent.com/kubernetes-sigs/cluster-api-provider-aws/refs/heads/main/templates/cluster-template.yaml | envsubst > cluster1.yaml
311316
----
@@ -332,15 +337,15 @@ To generate the YAML for the cluster, do the following:
332337
+
333338
. Open a terminal and run the following:
334339
+
335-
[source,bash]
340+
[source,bash,subs=attributes+]
336341
----
337-
export CLUSTER_NAME=cluster1
338-
export NAMESPACE=capi-clusters
339-
export CONTROL_PLANE_MACHINE_COUNT=1
340-
export WORKER_MACHINE_COUNT=1
341-
export RKE2_VERSION=v1.30.2+rke2r1
342+
export CLUSTER_NAME={cluster-name}
343+
export NAMESPACE={namespace}
344+
export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
345+
export WORKER_MACHINE_COUNT={worker-machine-count}
346+
export RKE2_VERSION={kubernetes-version}+rke2r1
342347
export RKE2_CNI=calico
343-
export KUBERNETES_VERSION=v1.30.4 # needed for the CAPI Docker provider to use proper image
348+
export KUBERNETES_VERSION={kubernetes-version} # needed for the CAPI Docker provider to use proper image
344349
345350
curl -s https://raw.githubusercontent.com/rancher/turtles/refs/heads/main/test/e2e/data/cluster-templates/docker-rke2.yaml -o docker-rke2.yaml
346351
envsubst '${NAMESPACE} ${CLUSTER_NAME} ${WORKER_MACHINE_COUNT} ${RKE2_VERSION} ${RKE2_CNI} ${CONTROL_PLANE_MACHINE_COUNT} ${KUBERNETES_VERSION}' < template-docker-rke2.yaml > cluster1.yaml
@@ -364,13 +369,13 @@ To generate the YAML for the cluster, do the following:
364369
+
365370
. Open a terminal and run the following:
366371
+
367-
[source,bash]
372+
[source,bash,subs=attributes+]
368373
----
369-
export CLUSTER_NAME=cluster1
370-
export NAMESPACE=capi-clusters
371-
export CONTROL_PLANE_MACHINE_COUNT=1
372-
export WORKER_MACHINE_COUNT=1
373-
export KUBERNETES_VERSION=v1.30.4
374+
export CLUSTER_NAME={cluster-name}
375+
export NAMESPACE={namespace}
376+
export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
377+
export WORKER_MACHINE_COUNT={worker-machine-count}
378+
export KUBERNETES_VERSION={kubernetes-version}
374379
375380
curl -s https://raw.githubusercontent.com/rancher/turtles/refs/heads/main/test/e2e/data/cluster-templates/docker-kubeadm.yaml | envsubst > cluster1.yaml
376381
----
@@ -397,12 +402,12 @@ Before creating a vSphere+RKE2 workload cluster, it is required to have a VM tem
397402
+
398403
To generate the YAML for the cluster, do the following:
399404
+
400-
[source,bash]
405+
[source,bash,subs=attributes+]
401406
----
402-
export CLUSTER_NAME=cluster1
403-
export NAMESPACE=capi-clusters
404-
export CONTROL_PLANE_MACHINE_COUNT=1
405-
export WORKER_MACHINE_COUNT=1
407+
export CLUSTER_NAME={cluster-name}
408+
export NAMESPACE={namespace}
409+
export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
410+
export WORKER_MACHINE_COUNT={worker-machine-count}
406411
export VSPHERE_USERNAME: "<username>"
407412
export VSPHERE_PASSWORD: "<password>"
408413
export VSPHERE_SERVER: "10.0.0.1"
@@ -416,8 +421,8 @@ export CONTROL_PLANE_ENDPOINT_IP: "192.168.9.230"
416421
export VSPHERE_TLS_THUMBPRINT: "..."
417422
export EXP_CLUSTER_RESOURCE_SET: "true"
418423
export VSPHERE_SSH_AUTHORIZED_KEY: "ssh-rsa AAAAB3N..."
419-
export CPI_IMAGE_K8S_VERSION: "v1.30.0"
420-
export KUBERNETES_VERSION=v1.30.0
424+
export CPI_IMAGE_K8S_VERSION: "v1.31.0"
425+
export KUBERNETES_VERSION={kubernetes-version}
421426
----
422427
+
423428
. Open a terminal and run the following:
@@ -447,12 +452,12 @@ A list of published machine images (OVAs) is available https://github.com/kubern
447452
+
448453
To generate the YAML for the cluster, do the following:
449454
+
450-
[source,bash]
455+
[source,bash,subs=attributes+]
451456
----
452-
export CLUSTER_NAME=cluster1
453-
export NAMESPACE=capi-clusters
454-
export CONTROL_PLANE_MACHINE_COUNT=1
455-
export WORKER_MACHINE_COUNT=1
457+
export CLUSTER_NAME={cluster-name}
458+
export NAMESPACE={namespace}
459+
export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
460+
export WORKER_MACHINE_COUNT={worker-machine-count}
456461
export VSPHERE_USERNAME: "<username>"
457462
export VSPHERE_PASSWORD: "<password>"
458463
export VSPHERE_SERVER: "10.0.0.1"
@@ -466,8 +471,8 @@ export CONTROL_PLANE_ENDPOINT_IP: "192.168.9.230"
466471
export VSPHERE_TLS_THUMBPRINT: "..."
467472
export EXP_CLUSTER_RESOURCE_SET: "true"
468473
export VSPHERE_SSH_AUTHORIZED_KEY: "ssh-rsa AAAAB3N..."
469-
export CPI_IMAGE_K8S_VERSION: "v1.30.0"
470-
export KUBERNETES_VERSION=v1.30.0
474+
export CPI_IMAGE_K8S_VERSION: "v1.31.0"
475+
export KUBERNETES_VERSION={kubernetes-version}
471476
----
472477
+
473478
. Open a terminal and run the following:
@@ -493,12 +498,12 @@ AWS EKS::
493498
+
494499
To generate the YAML for the cluster, do the following:
495500
+
496-
[source,bash]
501+
[source,bash,subs=attributes+]
497502
----
498-
export CLUSTER_NAME=cluster1
499-
export NAMESPACE=capi-clusters
500-
export WORKER_MACHINE_COUNT=1
501-
export KUBERNETES_VERSION=v1.30.4
503+
export CLUSTER_NAME={cluster-name}
504+
export NAMESPACE={namespace}
505+
export WORKER_MACHINE_COUNT={worker-machine-count}
506+
export KUBERNETES_VERSION={kubernetes-version}
502507
----
503508
+
504509
. Open a terminal and run the following:
@@ -526,12 +531,12 @@ To generate the YAML for the cluster, do the following:
526531
+
527532
[source,bash]
528533
----
529-
export CLUSTER_NAME=cluster1
530-
export NAMESPACE=capi-clusters
534+
export CLUSTER_NAME={cluster-name}
535+
export NAMESPACE={namespace}
531536
export GCP_PROJECT=cluster-api-gcp-project
532537
export GCP_REGION=us-east4
533538
export GCP_NETWORK_NAME=default
534-
export WORKER_MACHINE_COUNT=1
539+
export WORKER_MACHINE_COUNT={worker-machine-count}
535540
----
536541
+
537542
. Open a terminal and run the following:

docs/v0.17/modules/en/pages/user/clusters.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -650,4 +650,4 @@ Labeling an individual cluster definition:
650650
[source,bash]
651651
----
652652
kubectl label cluster.cluster.x-k8s.io -n default cluster1 cluster-api.cattle.io/rancher-auto-import=true
653-
----
653+
----

0 commit comments

Comments
 (0)