build: Use k8s v1.29.4 as default Kubernetes version (#640)

jimmidyson · jimmidyson · commit 3eae779dd7a7 · 2024-05-14T17:12:28.000+01:00
Update documentation to specify the version when creating the cluster.
diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ For example, the following command will create a Docker cluster with Cilium CNI
 ```shell
 export CLUSTER_NAME=docker-cluster-cilium-helm-addon
 export CLUSTER_FILE=examples/capi-quick-start/docker-cluster-cilium-helm-addon.yaml
-export KUBERNETES_VERSION=v1.28.7
+export KUBERNETES_VERSION=v1.29.4
 ```
 
 ```shell
diff --git a/devbox.json b/devbox.json
@@ -41,10 +41,10 @@
   "shell": {
     "scripts": {
       "preview-docs": [
-        "cd docs && hugo server --buildFuture --buildDrafts"
+        "make preview-docs"
       ],
       "build-docs": [
-        "cd docs && hugo --minify --baseURL \"${BASE_URL}\""
+        "make build-docs"
       ]
     }
   }
diff --git a/docs/content/getting-started/create-cluster/aws.md b/docs/content/getting-started/create-cluster/aws.md
@@ -32,14 +32,18 @@ And create your cluster:
 
 ```shell
 clusterctl generate cluster my-cluster \
-  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/aws-cluster-cilium-helm-addon.yaml | kubectl apply --server-side -f -
+  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/aws-cluster-cilium-helm-addon.yaml \
+  --kubernetes-version={{< param "defaultKubernetesVersion" >}} \
+  --worker-machine-count=1 \
+  | kubectl apply --server-side -f -
 ```
 
 To customize your cluster configuration prior to creation, generate the cluster definition to a file and edit it before applying:
 
 ```shell
 clusterctl generate cluster my-cluster \
-  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/aws-cluster-cilium-helm-addon.yaml >mycluster.yaml
+  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/aws-cluster-cilium-helm-addon.yaml \
+  --kubernetes-version={{< param "defaultKubernetesVersion" >}} >mycluster.yaml
 
 # EDIT mycluster.yaml
 
diff --git a/docs/content/getting-started/create-cluster/docker.md b/docs/content/getting-started/create-cluster/docker.md
@@ -24,14 +24,18 @@ Export the required variables and any optional variables that you may want to se
 
 ```shell
 clusterctl generate cluster my-cluster \
-  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/docker-cluster-cilium-helm-addon.yaml | kubectl apply --server-side -f -
+  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/docker-cluster-cilium-helm-addon.yaml \
+  --kubernetes-version={{< param "defaultKubernetesVersion" >}} \
+  --worker-machine-count=1 \
+  | kubectl apply --server-side -f -
 ```
 
 To customize your cluster configuration prior to creation, generate the cluster definition to a file and edit it before applying:
 
 ```shell
 clusterctl generate cluster my-cluster \
-  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/docker-cluster-cilium-helm-addon.yaml >mycluster.yaml
+  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/docker-cluster-cilium-helm-addon.yaml \
+  --kubernetes-version={{< param "defaultKubernetesVersion" >}} >mycluster.yaml
 
 # EDIT mycluster.yaml
 
diff --git a/docs/content/getting-started/create-cluster/nutanix.md b/docs/content/getting-started/create-cluster/nutanix.md
@@ -42,14 +42,18 @@ And create your cluster:
 
 ```shell
 clusterctl generate cluster my-cluster \
-  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/nutanix-cluster-cilium-helm-addon.yaml | kubectl apply --server-side -f -
+  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/nutanix-cluster-cilium-helm-addon.yaml \
+  --kubernetes-version={{< param "defaultKubernetesVersion" >}} \
+  --worker-machine-count=1 \
+  | kubectl apply --server-side -f -
 ```
 
 To customize your cluster configuration prior to creation, generate the cluster definition to a file and edit it before applying:
 
 ```shell
 clusterctl generate cluster my-cluster \
-  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/nutanix-cluster-cilium-helm-addon.yaml >mycluster.yaml
+  --from https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/releases/download/v{{< param "version" >}}/nutanix-cluster-cilium-helm-addon.yaml \
+  --kubernetes-version={{< param "defaultKubernetesVersion" >}} >mycluster.yaml
 
 # EDIT mycluster.yaml
 
diff --git a/docs/hugo.toml b/docs/hugo.toml
@@ -147,7 +147,7 @@ enable = false
   name = "GitHub"
   url = "https://github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix"
   icon = "fab fa-github"
-        desc = "Development takes place here!"
+  desc = "Development takes place here!"
 
 [[menu.main]]
 name = "GitHub"
diff --git a/make/all.mk b/make/all.mk
@@ -18,3 +18,4 @@ include $(INCLUDE_DIR)dev.mk
 include $(INCLUDE_DIR)helm.mk
 include $(INCLUDE_DIR)examples.mk
 include $(INCLUDE_DIR)apis.mk
+include $(INCLUDE_DIR)docs.mk
diff --git a/make/docs.mk b/make/docs.mk
@@ -0,0 +1,17 @@
+# Copyright 2024 Nutanix. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+.PHONY: preview-docs
+preview-docs: ## Runs hugo server to locally preview docs
+preview-docs: export HUGO_PARAMS_defaultKubernetesVersion ?= $(E2E_DEFAULT_KUBERNETES_VERSION)
+preview-docs: ; $(info $(M) running hugo server to locally preview docs)
+	cd docs && hugo server --buildFuture --buildDrafts
+
+.PHONY: build-docs
+build-docs: ## Builds the docs
+build-docs: export HUGO_PARAMS_defaultKubernetesVersion ?= $(E2E_DEFAULT_KUBERNETES_VERSION)
+build-docs: ; $(info $(M) building docs with hugo)
+ifndef BASE_URL
+	$(error BASE_URL is not set)
+endif
+	cd docs && hugo --minify --baseURL "$(BASE_URL)"
diff --git a/make/go.mk b/make/go.mk
@@ -78,7 +78,7 @@ E2E_PARALLEL_NODES ?= $(shell nproc --ignore=1)
 E2E_FLAKE_ATTEMPTS ?= 1
 E2E_CONF_FILE ?= $(REPO_ROOT)/test/e2e/config/caren.yaml
 E2E_CONF_FILE_ENVSUBST ?= $(basename $(E2E_CONF_FILE))-envsubst.yaml
-export E2E_DEFAULT_KUBERNETES_VERSION ?= v1.28.7
+export E2E_DEFAULT_KUBERNETES_VERSION ?= v1.29.4
 ARTIFACTS ?= ${REPO_ROOT}/_artifacts
 
 .PHONY: e2e-test
diff --git a/test/e2e/config/caren.yaml b/test/e2e/config/caren.yaml
@@ -166,7 +166,7 @@ variables:
   # Override Kubernetes version for test workload clusters for specific providers by setting the env variables
   # `KUBERNETES_VERSION_<PROVIDER>`, where `<PROVIDER>` is the uppercase provider name, e.g.
   # `KUBERNETES_VERSION_DOCKER: v1.29.4`.
-  KUBERNETES_VERSION_DOCKER: "${KINDEST_IMAGE_TAG}"
+  # KUBERNETES_VERSION_DOCKER: "${KINDEST_IMAGE_TAG}"
   SERVICE_CIDR: "10.128.0.0/12"
   POD_CIDR: "192.168.0.0/16"
   NODE_DRAIN_TIMEOUT: "60s"

Original file line number	Diff line number	Diff line change
`@@ -41,10 +41,10 @@`
`41`	`41`	`"shell": {`
`42`	`42`	`"scripts": {`
`43`	`43`	`"preview-docs": [`
`44`		`- "cd docs && hugo server --buildFuture --buildDrafts"`
	`44`	`+ "make preview-docs"`
`45`	`45`	`],`
`46`	`46`	`"build-docs": [`
`47`		`- "cd docs && hugo --minify --baseURL \"${BASE_URL}\""`
	`47`	`+ "make build-docs"`
`48`	`48`	`]`
`49`	`49`	`}`
`50`	`50`	`}`