Skip to content

Commit d1c911b

Browse files
authored
Merge pull request #63059 from kelbrown20/OSDOCS-7227-reformat-multi-arch-docs
OSDOCS-7227: Reformatting multi-arch compute machines docs
2 parents 1988bc2 + accb957 commit d1c911b

12 files changed

+119
-72
lines changed

_topic_maps/_topic_map.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -521,8 +521,19 @@ Topics:
521521
- Name: Bare metal configuration
522522
File: bare-metal-configuration
523523
- Name: Configuring multi-architecture compute machines on an OpenShift cluster
524+
Dir: configuring-multi-arch-compute-machines
524525
Distros: openshift-enterprise
525-
File: multi-architecture-configuration
526+
Topics:
527+
- Name: About clusters with multi-architecture compute machines
528+
File: multi-architecture-configuration
529+
- Name: Creating a cluster with multi-architecture compute machines on Azure
530+
File: creating-multi-arch-compute-nodes-azure
531+
- Name: Creating a cluster with multi-architecture compute machines on AWS
532+
File: creating-multi-arch-compute-nodes-aws
533+
- Name: Creating a cluster with multi-architecture compute machines on bare metal
534+
File: creating-multi-arch-compute-nodes-bare-metal
535+
- Name: Managing your cluster with multi-architecture compute machines
536+
File: multi-architecture-compute-managing
526537
- Name: Enabling encryption on a vSphere cluster
527538
File: vsphere-post-installation-encryption
528539
- Name: Machine configuration tasks
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_attributes/
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_content-type: ASSEMBLY
2+
:context: creating-multi-arch-compute-nodes-aws
3+
[id="creating-multi-arch-compute-nodes-aws"]
4+
= Creating a cluster with multi-architecture compute machines on AWS
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
To create an AWS cluster with multi-architecture compute machines, you must first create a single-architecture AWS installer-provisioned cluster with the multi-architecture installer binary. For more information on AWS installations, refer to xref:../../installing/installing_aws/installing-aws-customizations.adoc[Installing a cluster on AWS with customizations]. You can then add a ARM64 compute machine set to your AWS cluster.
10+
11+
include::modules/multi-architecture-verifying-cluster-compatibility.adoc[leveloffset=+1]
12+
13+
include::modules/multi-architecture-modify-machine-set-aws.adoc[leveloffset=+1]
14+
15+
[role="_additional-resources"]
16+
.Additional resources
17+
* xref:../../installing/installing_aws/installing-aws-customizations.adoc#installation-aws-arm-tested-machine-types_installing-aws-customizations[Tested instance types for AWS 64-bit ARM]
18+
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_content-type: ASSEMBLY
2+
:context: creating-multi-arch-compute-nodes-azure
3+
[id="creating-multi-arch-compute-nodes-azure"]
4+
= Creating a cluster with multi-architecture compute machine on Azure
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
To deploy an Azure cluster with multi-architecture compute machines, you must first create a single-architecture Azure installer-provisioned cluster that uses the multi-architecture installer binary. For more information on Azure installations, see xref:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[Installing a cluster on Azure with customizations]. You can then add an ARM64 compute machine set to your cluster to create a cluster with multi-architecture compute machines.
10+
11+
The following procedures explain how to generate an ARM64 boot image and create an Azure compute machine set that uses the ARM64 boot image. This adds ARM64 compute nodes to your cluster and deploys the amount of ARM64 virtual machines (VM) that you need.
12+
13+
include::modules/multi-architecture-verifying-cluster-compatibility.adoc[leveloffset=+1]
14+
15+
include::modules/multi-architecture-creating-arm64-bootimage.adoc[leveloffset=+1]
16+
17+
include::modules/multi-architecture-modify-machine-set.adoc[leveloffset=+1]
18+
19+
[role="_additional-resources"]
20+
.Additional resources
21+
* xref:../../machine_management/creating_machinesets/creating-machineset-azure.adoc#creating-machineset-azure[Creating a compute machine set on Azure]
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:_content-type: ASSEMBLY
2+
:context: creating-multi-arch-compute-nodes-bare-metal
3+
[id="creating-multi-arch-compute-nodes-bare-metal"]
4+
= Creating a cluster with multi-architecture compute machine on bare metal (Technology Preview)
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
To create a cluster with multi-architecture compute machines on bare metal, you must have an existing single-architecture bare metal cluster. For more information on bare metal installations, see xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Installing a user provisioned cluster on bare metal]. You can then add 64-bit ARM compute machines to your {product-title} cluster on bare metal.
10+
11+
Before you can add 64-bit ARM nodes to your bare metal cluster, you must upgrade your cluster to one that uses the multi-architecture payload. For more information on migrating to the multi-architecture payload, see xref:../../updating/updating_a_cluster/migrating-to-multi-payload.adoc#migrating-to-multi-payload[Migrating to a cluster with multi-architecture compute machines].
12+
13+
The following procedures explain how to create a {op-system} compute machine using an ISO image or network PXE booting. This will allow you to add ARM64 nodes to your bare metal cluster and deploy a cluster with multi-architecture compute machines.
14+
15+
:Featurename: Clusters with multi-architecture compute machines on bare metal user-provisioned installations
16+
include::snippets/technology-preview.adoc[leveloffset=+1]
17+
18+
include::modules/multi-architecture-verifying-cluster-compatibility.adoc[leveloffset=+1]
19+
20+
include::modules/machine-user-infra-machines-iso.adoc[leveloffset=+1]
21+
22+
include::modules/machine-user-infra-machines-pxe.adoc[leveloffset=+1]
23+
24+
include::modules/installation-approve-csrs.adoc[leveloffset=+1]
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images/
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules/
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:_content-type: ASSEMBLY
2+
:context: multi-architecture-compute-managing
3+
[id="multi-architecture-compute-managing"]
4+
= Managing your cluster with multi-architecture compute machines
5+
6+
toc::[]
7+
8+
include::modules/multi-architecture-import-imagestreams.adoc[leveloffset=+1]
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
:_content-type: CONCEPT
2+
:context: multi-architecture-configuration
3+
[id="post-install-multi-architecture-configuration"]
4+
= About clusters with multi-architecture compute machines
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
An {product-title} cluster with multi-architecture compute machines is a cluster that supports compute machines with different architectures. Clusters with multi-architecture compute machines are available only on AWS or Azure installer-provisioned infrastructures and bare metal user-provisioned infrastructures with x86_64 control plane machines.
10+
11+
[NOTE]
12+
====
13+
When there are nodes with multiple architectures in your cluster, the architecture of your image must be consistent with the architecture of the node. You need to ensure that the pod is assigned to the node with the appropriate architecture and that it matches the image architecture. For more information on assigning pods to nodes, see link:https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/[Assigning pods to nodes].
14+
====
15+
16+
[IMPORTANT]
17+
====
18+
The Cluster Samples Operator is not supported on clusters with multi-architecture compute machines. Your cluster can be created without this capability. For more information, see xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc#enabling-cluster-capabilities[Enabling cluster capabilities]
19+
====
20+
21+
For information on migrating your single-architecture cluster to a cluster that supports multi-architecture compute machines, see xref:../../updating/updating_a_cluster/migrating-to-multi-payload.adoc#migrating-to-multi-payload[Migrating to a cluster with multi-architecture compute machines].
22+
23+
== Configuring your cluster with multi-architecture compute machines
24+
25+
To create a cluster with multi-architecture compute machines for various platforms, you can use the documentation in the following sections:
26+
27+
* xref:../../post_installation_configuration/configuring-multi-arch-compute-machines/creating-multi-arch-compute-nodes-azure.adoc#creating-multi-arch-compute-nodes-azure[Creating a cluster with multi-architecture compute machines on Azure]
28+
29+
* xref:../../post_installation_configuration/configuring-multi-arch-compute-machines/creating-multi-arch-compute-nodes-aws.adoc#creating-multi-arch-compute-nodes-aws[Creating a cluster with multi-architecture compute machines on AWS]
30+
31+
* xref:../../post_installation_configuration/configuring-multi-arch-compute-machines/creating-multi-arch-compute-nodes-bare-metal.adoc#creating-multi-arch-compute-nodes-bare-metal[Creating a cluster with multi-architecture compute machines on bare metal]
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../snippets/

0 commit comments

Comments
 (0)