From 783fb7fb60564a0e3a1fd332f964e70a7691d5d6 Mon Sep 17 00:00:00 2001 From: NickSample <93723054+NickSample@users.noreply.github.com> Date: Thu, 24 Oct 2024 15:32:18 +0000 Subject: [PATCH 1/2] Editorial review --- .../kubearchinspect/_index.md | 7 ++----- .../kubearchinspect/_next-steps.md | 2 +- .../kubearchinspect/_review.md | 4 ++-- .../kubearchinspect/analyse-results.md | 16 +++++++++------- .../kubearchinspect/before-you-begin.md | 5 +++++ .../kubearchinspect/run-kubearchinspect.md | 8 -------- 6 files changed, 19 insertions(+), 23 deletions(-) diff --git a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_index.md b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_index.md index ff83f6bff4..de2a37aecb 100644 --- a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_index.md +++ b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_index.md @@ -1,15 +1,12 @@ --- title: Migrate containers to Arm using KubeArchInspect -draft: true -cascade: - draft: true minutes_to_complete: 15 -who_is_this_for: This is an introductory topic for software developers who want to know if the containers running in a Kubernetes cluster are available for the Arm architecture. +who_is_this_for: This is an introductory topic for software developers who want to ensure containers running in a Kubernetes cluster support the Arm architecture. learning_objectives: - - Run KubeArchInspect to get a quick report of the containers running in a Kubernetes cluster. + - Run KubeArchInspect to generate a report on the containers running in a Kubernetes cluster. - Discover which images support the Arm architecture. - Understand common reasons for an image not supporting Arm. - Make configuration changes to upgrade images with Arm support. diff --git a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_next-steps.md b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_next-steps.md index 3174193d80..8e40a1f93b 100644 --- a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_next-steps.md +++ b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_next-steps.md @@ -1,5 +1,5 @@ --- -next_step_guidance: Now you know how to use the KubeArchInspect tool to understand the Arm support of your Kubernetes cluster images. +next_step_guidance: You now know how to use the KubeArchInspect tool to ensure containers running in a Kubernetes cluster support the Arm architecture. To learn more about related topics, please explore the resources below. recommended_path: /learning-paths/servers-and-cloud-computing/eks-multi-arch/ diff --git a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_review.md b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_review.md index 378a647733..fdc1d2d118 100644 --- a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_review.md +++ b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/_review.md @@ -2,7 +2,7 @@ review: - questions: question: > - Which of the following statements is true about kubearchinspect? + Which of the following statements is true about KubeArchInspect? answers: - KubeArchInspect displays a report of the images running in a Kubernetes cluster, but it does not identify which images support arm64. - KubeArchInspect displays a report of the images running in a Kubernetes cluster and identifies which images support arm64. @@ -25,7 +25,7 @@ review: question: > Which of the following is NOT a way to improve your cluster's Arm compatibility? answers: - - Upgrade images to a newer version -- if they support arm64. + - Upgrade images to a newer version that supports arm64. - Find an alternative image that supports arm64. - Request that the developers of an image build and publish an arm64 version. - Contact the Kubernetes community to upgrade your cluster. diff --git a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/analyse-results.md b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/analyse-results.md index a3bdc0efec..3635d50cb7 100644 --- a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/analyse-results.md +++ b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/analyse-results.md @@ -8,7 +8,12 @@ layout: learningpathall ## Identifying issues and opportunities -After running KubeArchInspect, you can examine the output to determine if the cluster image architectures are suitable for your needs. +After running KubeArchInspect, you can examine the output to determine if the cluster image architectures are suitable for your needs. Each image running in the cluster appears on a separate line, including name, tag (version), and test result: + +* A green tick (✅) indicates the image already supports arm64. +* A red cross (❌) indicates that arm64 support is not available. +* An upward arrow (⬆) shows that arm64 support is included in a newer version. +* A red exclamation mark (❗) is shown when an error occurs checking the image. This may indicate an error connecting to the image registry. If you want to run an all Arm cluster, you need to use images which include arm64 support. @@ -25,17 +30,14 @@ Legends: ... sergrua/kube-tagger:release-0.1.1 ❌ ``` - These images are identified as not supporting arm64 (`❌`). ## Addressing issues The KubeArchInspect report provides valuable information for improving the cluster's performance and compatibility with the Arm architecture. -Several approaches can be taken to address the issues identified: +There are several approaches you can take to address issues identified in the report: -* **Upgrade images:** If an image with an available arm64 version (`⬆`) is detected, consider upgrading to that version. This can be done by modifying the deployment configuration and restarting the containers using the new image tag. -* **Find alternative images:** For images with no available arm64 version, look for alternative images that offer arm64 support. For example, instead of a specific image from the registry, try using a more general image like `busybox`, which supports multiple architectures, including arm64. +* **Upgrade images:** If an image with an available arm64 version (`⬆`) is detected, consider upgrading to that version. You can do this by modifying the deployment configuration and restarting the containers using the new image tag. +* **Find alternative images:** For images with no available arm64 version (`❌`), look for alternative images that offer arm64 support. For example, instead of a specific image from the registry, try using a more general image like `busybox`, which supports multiple architectures, including arm64. * **Request Arm support:** If there is no suitable alternative image available, you can contact the image developers or the Kubernetes community and request them to build and publish an arm64 version of the image. - -KubeArchInspect provides an efficient way to understand and improve the Arm architecture support within your Kubernetes cluster, ensuring your cluster runs efficiently and effectively. \ No newline at end of file diff --git a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/before-you-begin.md b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/before-you-begin.md index d59fe366bb..bcbe690dae 100644 --- a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/before-you-begin.md +++ b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/before-you-begin.md @@ -5,6 +5,11 @@ weight: 2 ### FIXED, DO NOT MODIFY layout: learningpathall --- +## How does KubeArchInspect help? + +KubeArchInspect provides an efficient way to understand and improve the Arm architecture support within your Kubernetes cluster, ensuring your cluster runs efficiently and effectively. + +KubeArchInspect identifies images in a Kubernetes cluster which support the Arm architecture. It does this by checking each image against the source registry for the image and identifying which architectures are available. You can use the results to identify potential issues or opportunities for optimizing the cluster to run on Arm. {{% notice Note %}} KubeArchInspect is a command-line tool which requires a running Kubernetes cluster. diff --git a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/run-kubearchinspect.md b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/run-kubearchinspect.md index 61d3f4830d..18daf3fb29 100644 --- a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/run-kubearchinspect.md +++ b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/run-kubearchinspect.md @@ -6,8 +6,6 @@ weight: 3 layout: learningpathall --- -KubeArchInspect identifies images in a Kubernetes cluster which have support for the Arm architecture. It checks each image against the image registry, checking the available architectures for each image tag. The results can be used to identify potential issues or opportunities for optimizing the cluster for Arm. - ## How do I run KubeArchInspect? To run KubeArchInspect, you need to have `kubearchinspect` installed and ensure that the `kubectl` command is configured to connect to your cluster. If not already configured, you should set up `kubectcl` to connect to your cluster. @@ -65,9 +63,3 @@ quay.io/prometheus/alertmanager:v0.25.0 ✅ 602401143452.dkr.ecr.eu-west-1.amazonaws.com/amazon-k8s-cni-init:v1.15.4-eksbuild.1 ❗ 602401143452.dkr.ecr.eu-west-1.amazonaws.com/amazon-k8s-cni:v1.15.4-eksbuild.1 ❗ ``` - -Each image running in the cluster appears on a separate line, including name, tag (version), and test result. - -A green tick indicates the image already supports arm64, a red cross that arm64 support is not available, an upward arrow shows that arm64 support is included in a newer version. - -A red exclamation mark is shown when an error occurs checking the image. This may indicate an error connecting to the image registry. \ No newline at end of file From e750a1b219b80534b0cd2344d30ce3af8acd2d8c Mon Sep 17 00:00:00 2001 From: NickSample <93723054+NickSample@users.noreply.github.com> Date: Thu, 24 Oct 2024 16:29:11 +0000 Subject: [PATCH 2/2] Further edit from KB --- .../kubearchinspect/before-you-begin.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/before-you-begin.md b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/before-you-begin.md index bcbe690dae..9d909ef123 100644 --- a/content/learning-paths/servers-and-cloud-computing/kubearchinspect/before-you-begin.md +++ b/content/learning-paths/servers-and-cloud-computing/kubearchinspect/before-you-begin.md @@ -7,7 +7,7 @@ layout: learningpathall --- ## How does KubeArchInspect help? -KubeArchInspect provides an efficient way to understand and improve the Arm architecture support within your Kubernetes cluster, ensuring your cluster runs efficiently and effectively. +KubeArchInspect is a tool developed by Arm. It provides an efficient way to understand and improve the Arm architecture support within your Kubernetes cluster, ensuring your cluster runs efficiently and effectively. KubeArchInspect identifies images in a Kubernetes cluster which support the Arm architecture. It does this by checking each image against the source registry for the image and identifying which architectures are available. You can use the results to identify potential issues or opportunities for optimizing the cluster to run on Arm.