Skip to content

Commit 5377dac

Browse files
authored
Merge pull request #1353 from NickSample/KubeArchInspect_LP
KubeArchInspect_LP_KB to review
2 parents c3173a8 + e750a1b commit 5377dac

File tree

6 files changed

+19
-23
lines changed

6 files changed

+19
-23
lines changed

content/learning-paths/servers-and-cloud-computing/kubearchinspect/_index.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
---
22
title: Migrate containers to Arm using KubeArchInspect
3-
draft: true
4-
cascade:
5-
draft: true
63

74
minutes_to_complete: 15
85

9-
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.
6+
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.
107

118
learning_objectives:
12-
- Run KubeArchInspect to get a quick report of the containers running in a Kubernetes cluster.
9+
- Run KubeArchInspect to generate a report on the containers running in a Kubernetes cluster.
1310
- Discover which images support the Arm architecture.
1411
- Understand common reasons for an image not supporting Arm.
1512
- Make configuration changes to upgrade images with Arm support.

content/learning-paths/servers-and-cloud-computing/kubearchinspect/_next-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
next_step_guidance: Now you know how to use the KubeArchInspect tool to understand the Arm support of your Kubernetes cluster images.
2+
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.
33

44
recommended_path: /learning-paths/servers-and-cloud-computing/eks-multi-arch/
55

content/learning-paths/servers-and-cloud-computing/kubearchinspect/_review.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
review:
33
- questions:
44
question: >
5-
Which of the following statements is true about kubearchinspect?
5+
Which of the following statements is true about KubeArchInspect?
66
answers:
77
- KubeArchInspect displays a report of the images running in a Kubernetes cluster, but it does not identify which images support arm64.
88
- KubeArchInspect displays a report of the images running in a Kubernetes cluster and identifies which images support arm64.
@@ -25,7 +25,7 @@ review:
2525
question: >
2626
Which of the following is NOT a way to improve your cluster's Arm compatibility?
2727
answers:
28-
- Upgrade images to a newer version -- if they support arm64.
28+
- Upgrade images to a newer version that supports arm64.
2929
- Find an alternative image that supports arm64.
3030
- Request that the developers of an image build and publish an arm64 version.
3131
- Contact the Kubernetes community to upgrade your cluster.

content/learning-paths/servers-and-cloud-computing/kubearchinspect/analyse-results.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ layout: learningpathall
88

99
## Identifying issues and opportunities
1010

11-
After running KubeArchInspect, you can examine the output to determine if the cluster image architectures are suitable for your needs.
11+
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:
12+
13+
* A green tick (✅) indicates the image already supports arm64.
14+
* A red cross (❌) indicates that arm64 support is not available.
15+
* An upward arrow (⬆) shows that arm64 support is included in a newer version.
16+
* A red exclamation mark (❗) is shown when an error occurs checking the image. This may indicate an error connecting to the image registry.
1217

1318
If you want to run an all Arm cluster, you need to use images which include arm64 support.
1419

@@ -25,17 +30,14 @@ Legends:
2530
...
2631
sergrua/kube-tagger:release-0.1.1 ❌
2732
```
28-
2933
These images are identified as not supporting arm64 (``).
3034

3135
## Addressing issues
3236

3337
The KubeArchInspect report provides valuable information for improving the cluster's performance and compatibility with the Arm architecture.
3438

35-
Several approaches can be taken to address the issues identified:
39+
There are several approaches you can take to address issues identified in the report:
3640

37-
* **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.
38-
* **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.
41+
* **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.
42+
* **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.
3943
* **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.
40-
41-
KubeArchInspect provides an efficient way to understand and improve the Arm architecture support within your Kubernetes cluster, ensuring your cluster runs efficiently and effectively.

content/learning-paths/servers-and-cloud-computing/kubearchinspect/before-you-begin.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ weight: 2
55
### FIXED, DO NOT MODIFY
66
layout: learningpathall
77
---
8+
## How does KubeArchInspect help?
9+
10+
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.
11+
12+
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.
813

914
{{% notice Note %}}
1015
KubeArchInspect is a command-line tool which requires a running Kubernetes cluster.

content/learning-paths/servers-and-cloud-computing/kubearchinspect/run-kubearchinspect.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ weight: 3
66
layout: learningpathall
77
---
88

9-
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.
10-
119
## How do I run KubeArchInspect?
1210

1311
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 ✅
6563
602401143452.dkr.ecr.eu-west-1.amazonaws.com/amazon-k8s-cni-init:v1.15.4-eksbuild.1 ❗
6664
602401143452.dkr.ecr.eu-west-1.amazonaws.com/amazon-k8s-cni:v1.15.4-eksbuild.1 ❗
6765
```
68-
69-
Each image running in the cluster appears on a separate line, including name, tag (version), and test result.
70-
71-
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.
72-
73-
A red exclamation mark is shown when an error occurs checking the image. This may indicate an error connecting to the image registry.

0 commit comments

Comments
 (0)