From b09921cd8347290db08ab9a4f0a0b0f689dec181 Mon Sep 17 00:00:00 2001 From: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Date: Thu, 21 Nov 2024 13:13:05 -0800 Subject: [PATCH] docs: update k8s version config for EdgeForge (#4766) * docs: update k8s version config * docs: add pre 4.4.12 info back --------- Co-authored-by: Lenny Chen --- .../palette-canvos/build-provider-images.md | 5 +++-- .../palette-canvos/palette-canvos.md | 16 ++++++---------- .../tutorials/edge/deploy-cluster.md | 14 ++++++++++---- 3 files changed, 19 insertions(+), 16 deletions(-) diff --git a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md index 45aa4a3c98..b7b3a9744d 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/build-provider-images.md @@ -115,8 +115,9 @@ artifacts at the same time. the JSON object corresponding to your Kubernetes distribution. If you are using a tag that is earlier than v4.4.12, the **k8s_versions.json** file does not exist in those tags. - Instead, open the **Earthfile** in the CanvOS directory. Under `build-provider-images`, remove the lines containing - Kubernetes versions that you do not need. + Instead, open the **Earthfile** in the CanvOS directory. In the file, find the block that starts with + `build-provider-images-fips:` and delete the Kubernetes versions that you do not want. This will speed up the build + process and save storage space. 10. Issue the command below to create an **.arg** file. The **.arg** file uses the default values for the remaining arguments. diff --git a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md index 407ee6bbae..ef9e042b66 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md @@ -223,17 +223,13 @@ customization. cat user-data ``` -10. The CanvOS utility uses [Earthly](https://earthly.dev/)(https://earthly.dev/) to build the target artifacts. By - default, images are created for all the Palette-supported Kubernetes versions. Comment out the versions you do not - need in the file **Earthfile** to speed up the build process and save disk space. +10. Open the **k8s_versions.json** file in the CanvOS directory. Remove the Kubernetes versions that you don't need from + the JSON object corresponding to your Kubernetes distribution. - ``` - build-provider-images: - # BUILD +provider-image --K8S_VERSION=1.24.6 - BUILD +provider-image --K8S_VERSION=1.25.2 - BUILD +provider-image --K8S_VERSION=1.26.4 - BUILD +provider-image --K8S_VERSION=1.27.2 - ``` + If you are using a tag that is earlier than v4.4.12, the **k8s_versions.json** file does not exist in those tags. + Instead, open the **Earthfile** in the CanvOS directory. In the file, find the block that starts with + `build-provider-images-fips:` and delete the Kubernetes versions that you do not want. This will speed up the build + process and save storage space. 11. Issue the following command to start the build process. diff --git a/docs/docs-content/tutorials/edge/deploy-cluster.md b/docs/docs-content/tutorials/edge/deploy-cluster.md index f1cffe0da8..4ca5dc2f93 100644 --- a/docs/docs-content/tutorials/edge/deploy-cluster.md +++ b/docs/docs-content/tutorials/edge/deploy-cluster.md @@ -266,10 +266,16 @@ images are created for all the Palette-supported Kubernetes versions by default. used in this tutorial, the script builds 14 images. If your machine does not have enough disk space, the build process will fail silently. -You can exclude image versions you do not need from the build process by commenting out the lines in the -`build-provider-images` parameter in the file **Earthfile** in the **CanvOS** repository. This speeds up build process -and reduces the amount of space required for the build process. For an example of excluding a version from build, refer -to [Build Edge Artifacts guide](../../clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md). +If you are using a Git tag earlier than v4.4.12, you can exclude image versions you do not need from the build process +by commenting out the lines in the `build-provider-images` parameter in the file **Earthfile** in the **CanvOS** +repository. + +If you are using a Git tag later than v4.4.12, open the **k8s_versions.json** file in the CanvOS directory. Remove the +Kubernetes versions that you don't need from the JSON object corresponding to your Kubernetes distribution. + +This speeds up build process and reduces the amount of space required for the build process. For an example of excluding +a version from build, refer to +[Build Edge Artifacts guide](../../clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md). :::