Skip to content

Commit 965ccea

Browse files
authored
Merge pull request #83248 from lahinson/osdocs-11101-arm-hcp
[OSDOCS-11101]: Updating multiarch docs for HCP
2 parents 2a50766 + 928ed90 commit 965ccea

File tree

4 files changed

+23
-6
lines changed

4 files changed

+23
-6
lines changed

hosted_control_planes/hcp-deploy/hcp-deploy-aws.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ include::modules/hcp-aws-enable-private-link.adoc[leveloffset=+1]
4848

4949
include::modules/hcp-aws-deploy-hc.adoc[leveloffset=+1]
5050

51+
[role="_additional-resources"]
52+
.Additional resources
53+
54+
* xref:../../hosted_control_planes/hcp-deploy/hcp-deploy-aws.adoc#hcp-enable-arm-amd_hcp-deploy-aws[Running hosted clusters on an ARM64 architecture]
55+
5156
include::modules/hcp-access-pub-hc-aws.adoc[leveloffset=+2]
5257

5358
include::modules/hcp-access-pub-hc-aws-cli.adoc[leveloffset=+2]

modules/hcp-aws-deploy-hc.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@
88

99
You can deploy a hosted cluster on {aws-first} by using the `hcp` command-line interface (CLI).
1010

11+
By default for {hcp} on {aws-first}, you use an AMD64 hosted cluster. However, you can enable {hcp} to run on an ARM64 hosted cluster. For more information, see "Running hosted clusters on an ARM64 architecture".
12+
13+
For compatible combinations of node pools and hosted clusters, see the following table:
14+
15+
.Compatible architectures for node pools and hosted clusters
16+
[cols="2,2",options="header"]
17+
|===
18+
| Hosted cluster | Node pools
19+
| AMD64 | AMD64 or ARM64
20+
| ARM64 | ARM64 or AMD64
21+
|===
22+
1123
.Prerequisites
1224

1325
* You have set up the hosted control plane CLI, `hcp`.

modules/hcp-create-hc-arm64-aws.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
You can run a hosted cluster on an ARM64 {product-title} cluster for {aws-first} by overriding the default release image with a multi-architecture release image.
1010

11+
If you do not use a multi-architecture release image, the compute nodes in the node pool are not created and reconciliation of the node pool stops until you either use a multi-architecture release image in the hosted cluster or update the `NodePool` custom resource based on the release image.
12+
1113
.Prerequisites
1214

1315
* You must have an {product-title} cluster with a 64-bit ARM infrastructure that is installed on {aws-short}. For more information, see link:https://console.redhat.com/openshift/install/aws/arm[Create an {product-title} Cluster: {aws-short} (ARM)].
@@ -27,8 +29,7 @@ $ hcp create cluster aws \
2729
--sts-creds <path_to_sts_credential_file> \// <5>
2830
--region <region> \// <6>
2931
--release-image quay.io/openshift-release-dev/ocp-release:<ocp_release_image> \// <7>
30-
--role-arn <role_name> \// <8>
31-
--multi-arch <9>
32+
--role-arn <role_name> <8>
3233
----
3334
<1> Specify the name of your hosted cluster, for instance, `example`.
3435
<2> Specify the node pool replica count, for example, `3`.
@@ -38,7 +39,6 @@ $ hcp create cluster aws \
3839
<6> Specify the AWS region name, for example, `us-east-1`.
3940
<7> Specify the supported {product-title} version that you want to use, for example, `4.17.0-multi`. If you are using a disconnected environment, replace `<ocp_release_image>` with the digest image. To extract the {product-title} release image digest, see "Extracting the {product-title} release image digest".
4041
<8> Specify the Amazon Resource Name (ARN), for example, `arn:aws:iam::820196288204:role/myrole`.
41-
<9> The `multi-arch` flag indicates that the hosted cluster supports both `amd64` and `arm64` node pools. When you set the flag and supply a release image, the release image must be a multi-architecture release image. When you set the flag and supply a release stream, the release stream must be a multi-architecture release stream. If you do not set the `multi-arch` flag, the management cluster and node pool CPU architectures must match. Otherwise, a warning is displayed. A node pool supports only one CPU architecture within the same node pool.
4242

4343
. Add a `NodePool` object to the hosted cluster by running the following command:
4444
+
@@ -51,4 +51,4 @@ $ hcp create nodepool aws \
5151
----
5252
<1> Specify the name of your hosted cluster, for instance, `example`.
5353
<2> Specify the node pool name.
54-
<3> Specify the node pool replica count, for example, `3`.
54+
<3> Specify the node pool replica count, for example, `3`.

modules/hcp-enable-arm-amd.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="hcp-enable-arm-amd_{context}"]
7-
= Running hosted clusters on AMD64 and AMD64 architectures
7+
= Running hosted clusters on an ARM64 architecture
88

99
By default for {hcp} on {aws-first}, you use an AMD64 hosted cluster. However, you can enable {hcp} to run on an ARM64 hosted cluster.
1010

@@ -16,4 +16,4 @@ For compatible combinations of node pools and hosted clusters, see the following
1616
| Hosted cluster | Node pools
1717
| AMD64 | AMD64 or ARM64
1818
| ARM64 | ARM64 or AMD64
19-
|===
19+
|===

0 commit comments

Comments
 (0)