Use antora custom attribute to parameterize vars

furkatgofurov7 · furkatgofurov7 · commit d52512cb6558 · 2025-03-31T14:56:02.000+03:00
Signed-off-by: Furkat Gofurov &lt;furkat.gofurov@suse.com&gt;
diff --git a/docs/next/modules/en/pages/operator/certificationsuite.adoc b/docs/next/modules/en/pages/operator/certificationsuite.adoc
@@ -64,9 +64,11 @@ In previous sections we introduced the main actions performed in the sample test
 * 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.
 
 == Other options
+:kubernetes-version: v1.31.4
 
 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:
 
+[source,yaml,subs=attributes+]
 ----
 ...
 variables:
@@ -76,10 +78,10 @@ variables:
   ARTIFACTS_FOLDER: "_artifacts"
   MANAGEMENT_CLUSTER_ENVIRONMENT: "kind" # supported options are eks, isolated-kind, kind
   RANCHER_VERSION: "v2.10.2"
-  KUBERNETES_VERSION: "v1.31.4"
-  KUBERNETES_MANAGEMENT_VERSION: "v1.31.4"
+  KUBERNETES_VERSION: "{kubernetes-version}"
+  KUBERNETES_MANAGEMENT_VERSION: "{kubernetes-version}"
   KUBERNETES_MANAGEMENT_AWS_REGION: "eu-west-2"
-  RKE2_VERSION: "v1.31.4+rke2r1"
+  RKE2_VERSION: "{kubernetes-version}+rke2r1"
   TURTLES_PATH: "turtles/rancher-turtles"
   TURTLES_REPO_NAME: "turtles"
   TURTLES_URL: https://rancher.github.io/turtles
diff --git a/docs/next/modules/en/pages/tutorials/quickstart.adoc b/docs/next/modules/en/pages/tutorials/quickstart.adoc
@@ -44,7 +44,7 @@ If you're customizing the installation parameters, please make sure that you are
 | Name | Version 
 
 | Cluster API Operator
-| `v0.18.0`
+| `v0.17.1`
 
 | Cluster API
 | `v1.9.6`
diff --git a/docs/next/modules/en/pages/user/clusters.adoc b/docs/next/modules/en/pages/user/clusters.adoc
@@ -246,6 +246,11 @@ spec:
 ======
 
 == Create Your Cluster Definition
+:kubernetes-version: v1.31.4
+:cluster-name: cluster1
+:namespace: capi-clusters
+:worker-machine-count: 1
+:control-plane-machine-count: 1 
 
 [tabs]
 ======
@@ -261,13 +266,13 @@ To generate the YAML for the cluster, do the following:
 +
 . Open a terminal and run the following: 
 +
-[source,bash]
+[source,bash,subs=attributes+]
 ----
-export CLUSTER_NAME=cluster1
-export NAMESPACE=capi-clusters
-export CONTROL_PLANE_MACHINE_COUNT=1
-export WORKER_MACHINE_COUNT=1
-export RKE2_VERSION=v1.31.4+rke2r1 
+export CLUSTER_NAME={cluster-name}
+export NAMESPACE={namespace}
+export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
+export WORKER_MACHINE_COUNT={worker-machine-count}
+export RKE2_VERSION={kubernetes-version}+rke2r1
 export AWS_NODE_MACHINE_TYPE=t3a.large 
 export AWS_CONTROL_PLANE_MACHINE_TYPE=t3a.large 
 export AWS_SSH_KEY_NAME="aws-ssh-key" 
@@ -295,17 +300,17 @@ To generate the YAML for the cluster, do the following:
 +
 . Open a terminal and run the following:
 +
-[source,bash]
+[source,bash,subs=attributes+]
 ----
-export CLUSTER_NAME=cluster1
-export NAMESPACE=capi-clusters
+export CLUSTER_NAME={cluster-name}
+export NAMESPACE={namespace}
 export AWS_CONTROL_PLANE_MACHINE_TYPE=t3.large
 export AWS_NODE_MACHINE_TYPE=t3.large
 export AWS_SSH_KEY_NAME="aws-ssh-key" 
 export AWS_REGION="aws-region"
-export KUBERNETES_VERSION=v1.31.4
-export CONTROL_PLANE_MACHINE_COUNT=1
-export WORKER_MACHINE_COUNT=1
+export KUBERNETES_VERSION={kubernetes-version}
+export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
+export WORKER_MACHINE_COUNT={worker-machine-count}
 
 curl -s https://raw.githubusercontent.com/kubernetes-sigs/cluster-api-provider-aws/refs/heads/main/templates/cluster-template.yaml | envsubst > cluster1.yaml
 ----
@@ -332,15 +337,15 @@ To generate the YAML for the cluster, do the following:
 +
 . Open a terminal and run the following:
 +
-[source,bash]
+[source,bash,subs=attributes+]
 ----
-export CLUSTER_NAME=cluster1
-export NAMESPACE=capi-clusters
-export CONTROL_PLANE_MACHINE_COUNT=1
-export WORKER_MACHINE_COUNT=1
-export RKE2_VERSION=v1.31.4+rke2r1
+export CLUSTER_NAME={cluster-name}
+export NAMESPACE={namespace}
+export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
+export WORKER_MACHINE_COUNT={worker-machine-count}
+export RKE2_VERSION={kubernetes-version}+rke2r1
 export RKE2_CNI=calico
-export KUBERNETES_VERSION=v1.31.4 # needed for the CAPI Docker provider to use proper image
+export KUBERNETES_VERSION={kubernetes-version} # needed for the CAPI Docker provider to use proper image
 
 curl -s https://raw.githubusercontent.com/rancher/turtles/refs/heads/main/test/e2e/data/cluster-templates/docker-rke2.yaml -o docker-rke2.yaml
 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:
 +
 . Open a terminal and run the following:
 +
-[source,bash]
+[source,bash,subs=attributes+]
 ----
-export CLUSTER_NAME=cluster1
-export NAMESPACE=capi-clusters
-export CONTROL_PLANE_MACHINE_COUNT=1
-export WORKER_MACHINE_COUNT=1
-export KUBERNETES_VERSION=v1.31.4
+export CLUSTER_NAME={cluster-name}
+export NAMESPACE={namespace}
+export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
+export WORKER_MACHINE_COUNT={worker-machine-count}
+export KUBERNETES_VERSION={kubernetes-version}
 
 curl -s https://raw.githubusercontent.com/rancher/turtles/refs/heads/main/test/e2e/data/cluster-templates/docker-kubeadm.yaml | envsubst > cluster1.yaml
 ----
@@ -397,12 +402,12 @@ Before creating a vSphere+RKE2 workload cluster, it is required to have a VM tem
 +
 To generate the YAML for the cluster, do the following:
 +
-[source,bash]
+[source,bash,subs=attributes+]
 ----
-export CLUSTER_NAME=cluster1
-export NAMESPACE=capi-clusters
-export CONTROL_PLANE_MACHINE_COUNT=1
-export WORKER_MACHINE_COUNT=1
+export CLUSTER_NAME={cluster-name}
+export NAMESPACE={namespace}
+export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
+export WORKER_MACHINE_COUNT={worker-machine-count}
 export VSPHERE_USERNAME: "<username>"
 export VSPHERE_PASSWORD: "<password>"
 export VSPHERE_SERVER: "10.0.0.1"
@@ -417,7 +422,7 @@ export VSPHERE_TLS_THUMBPRINT: "..."
 export EXP_CLUSTER_RESOURCE_SET: "true"
 export VSPHERE_SSH_AUTHORIZED_KEY: "ssh-rsa AAAAB3N..."
 export CPI_IMAGE_K8S_VERSION: "v1.31.0"
-export KUBERNETES_VERSION=v1.31.4
+export KUBERNETES_VERSION={kubernetes-version}
 ----
 +
 . Open a terminal and run the following:
@@ -447,12 +452,12 @@ A list of published machine images (OVAs) is available https://github.com/kubern
 +
 To generate the YAML for the cluster, do the following:
 +
-[source,bash]
+[source,bash,subs=attributes+]
 ----
-export CLUSTER_NAME=cluster1
-export NAMESPACE=capi-clusters
-export CONTROL_PLANE_MACHINE_COUNT=1
-export WORKER_MACHINE_COUNT=1
+export CLUSTER_NAME={cluster-name}
+export NAMESPACE={namespace}
+export CONTROL_PLANE_MACHINE_COUNT={control-plane-machine-count}
+export WORKER_MACHINE_COUNT={worker-machine-count}
 export VSPHERE_USERNAME: "<username>"
 export VSPHERE_PASSWORD: "<password>"
 export VSPHERE_SERVER: "10.0.0.1"
@@ -467,7 +472,7 @@ export VSPHERE_TLS_THUMBPRINT: "..."
 export EXP_CLUSTER_RESOURCE_SET: "true"
 export VSPHERE_SSH_AUTHORIZED_KEY: "ssh-rsa AAAAB3N..."
 export CPI_IMAGE_K8S_VERSION: "v1.31.0"
-export KUBERNETES_VERSION=v1.31.4
+export KUBERNETES_VERSION={kubernetes-version}
 ----
 +
 . Open a terminal and run the following:
@@ -493,12 +498,12 @@ AWS EKS::
 +
 To generate the YAML for the cluster, do the following:
 +
-[source,bash]
+[source,bash,subs=attributes+]
 ----
-export CLUSTER_NAME=cluster1
-export NAMESPACE=capi-clusters
-export WORKER_MACHINE_COUNT=1
-export KUBERNETES_VERSION=v1.31.4
+export CLUSTER_NAME={cluster-name}
+export NAMESPACE={namespace}
+export WORKER_MACHINE_COUNT={worker-machine-count}
+export KUBERNETES_VERSION={kubernetes-version}
 ----
 +
 . Open a terminal and run the following:
@@ -526,12 +531,12 @@ To generate the YAML for the cluster, do the following:
 +
 [source,bash]
 ----
-export CLUSTER_NAME=cluster1
-export NAMESPACE=capi-clusters
+export CLUSTER_NAME={cluster-name}
+export NAMESPACE={namespace}
 export GCP_PROJECT=cluster-api-gcp-project
 export GCP_REGION=us-east4
 export GCP_NETWORK_NAME=default
-export WORKER_MACHINE_COUNT=1
+export WORKER_MACHINE_COUNT={worker-machine-count}
 ----
 +
 . Open a terminal and run the following:
diff --git a/docs/v0.17/modules/en/pages/user/clusters.adoc b/docs/v0.17/modules/en/pages/user/clusters.adoc
@@ -650,4 +650,4 @@ Labeling an individual cluster definition:
 [source,bash]
 ----
 kubectl label cluster.cluster.x-k8s.io -n default cluster1 cluster-api.cattle.io/rancher-auto-import=true
-----
+----
