From 370cb6a200c5c6bdd95cbec90e6f1b8059b4cff8 Mon Sep 17 00:00:00 2001 From: Laura Hinson Date: Wed, 23 Oct 2024 09:29:37 -0400 Subject: [PATCH] Update example OCP version in HCP docs --- modules/hcp-aws-hc-ext-dns.adoc | 2 +- modules/hcp-bm-hc-mirror.adoc | 2 +- modules/hcp-bm-hc.adoc | 2 +- modules/hcp-bm-ingress.adoc | 2 +- modules/hcp-create-hc-arm64-aws.adoc | 2 +- modules/hcp-ibmz-scale-np.adoc | 4 ++-- modules/hcp-managed-aws-hc-separate.adoc | 2 +- modules/hcp-non-bm-hc-mirror.adoc | 2 +- modules/hcp-non-bm-hc.adoc | 4 ++-- modules/hcp-virt-map-storage.adoc | 2 +- 10 files changed, 12 insertions(+), 12 deletions(-) diff --git a/modules/hcp-aws-hc-ext-dns.adoc b/modules/hcp-aws-hc-ext-dns.adoc index 3683dea2cffe..99d5e977ed90 100644 --- a/modules/hcp-aws-hc-ext-dns.adoc +++ b/modules/hcp-aws-hc-ext-dns.adoc @@ -64,7 +64,7 @@ $ hcp create cluster aws \ <5> Specify the public hosted zone that the service consumer owns, for example, `service-consumer-domain.com`. <6> Specify the node replica count, for example, `2`. <7> Specify the path to your pull secret file. -<8> Specify the supported {ocp-short} version that you want to use, for example, `4.14.0-x86_64`. +<8> Specify the supported {product-title} version that you want to use, for example, `4.17.0-multi`. <9> Specify the public hosted zone that the service provider owns, for example, `service-provider-domain.com`. <10> Set as `PublicAndPrivate`. You can use external DNS with `Public` or `PublicAndPrivate` configurations only. <11> Specify the path to your {aws-short} STS credentials file, for example, `/home/user/sts-creds/sts-creds.json`. diff --git a/modules/hcp-bm-hc-mirror.adoc b/modules/hcp-bm-hc-mirror.adoc index 8772deca88bb..6c5b1515e425 100644 --- a/modules/hcp-bm-hc-mirror.adoc +++ b/modules/hcp-bm-hc-mirror.adoc @@ -52,4 +52,4 @@ $ hcp create cluster agent \ <6> Specify the `icsp.yaml` file that defines ICSP and your mirror registries. <7> Specify the path to your SSH public key. The default file path is `~/.ssh/id_rsa.pub`. <8> Specify your hosted cluster namespace. -<9> Specify the supported {product-title} version that you want to use, for example, `4.14.0-x86_64`. If you are using a disconnected environment, replace `` with the digest image. To extract the {product-title} release image digest, see _Extracting the {product-title} release image digest_. \ No newline at end of file +<9> 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 `` with the digest image. To extract the {product-title} release image digest, see _Extracting the {product-title} release image digest_. \ No newline at end of file diff --git a/modules/hcp-bm-hc.adoc b/modules/hcp-bm-hc.adoc index 3d6d0336184f..c3b2dcf837f4 100644 --- a/modules/hcp-bm-hc.adoc +++ b/modules/hcp-bm-hc.adoc @@ -55,7 +55,7 @@ $ hcp create cluster agent \ <7> Specify the path to your SSH public key. The default file path is `~/.ssh/id_rsa.pub`. <8> Specify your hosted cluster namespace. <9> The default value for the control plane availability policy is `HighlyAvailable`. -<10> Specify the supported {product-title} version that you want to use, for example, `4.14.0-x86_64`. If you are using a disconnected environment, replace `` with the digest image. To extract the {product-title} release image digest, see _Extracting the {product-title} release image digest_. +<10> 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 `` with the digest image. To extract the {product-title} release image digest, see _Extracting the {product-title} release image digest_. + . After a few moments, verify that your hosted control plane pods are up and running by entering the following command: diff --git a/modules/hcp-bm-ingress.adoc b/modules/hcp-bm-ingress.adoc index 6f8b30a229c5..aaa9b39b2af7 100644 --- a/modules/hcp-bm-ingress.adoc +++ b/modules/hcp-bm-ingress.adoc @@ -186,4 +186,4 @@ clusteroperator.config.openshift.io/console clusteroperator.config.openshift.io/ingress 4.x.y True False False 53m ---- + -Replace `<4.x.y>` with the supported {product-title} version that you want to use, for example, `4.14.0-x86_64`. +Replace `<4.x.y>` with the supported {product-title} version that you want to use, for example, `4.17.0-multi`. diff --git a/modules/hcp-create-hc-arm64-aws.adoc b/modules/hcp-create-hc-arm64-aws.adoc index b58d0ecd4ff8..55102b9432dd 100644 --- a/modules/hcp-create-hc-arm64-aws.adoc +++ b/modules/hcp-create-hc-arm64-aws.adoc @@ -36,7 +36,7 @@ $ hcp create cluster aws \ <4> Specify the path to your pull secret, for example, `/user/name/pullsecret`. <5> Specify the path to your AWS STS credentials file, for example, `/home/user/sts-creds/sts-creds.json`. <6> Specify the AWS region name, for example, `us-east-1`. -<7> Specify the supported {product-title} version that you want to use, for example, `4.14.0-x86_64`. If you are using a disconnected environment, replace `` with the digest image. To extract the {product-title} release image digest, see "Extracting the {product-title} release image digest". +<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 `` with the digest image. To extract the {product-title} release image digest, see "Extracting the {product-title} release image digest". <8> Specify the Amazon Resource Name (ARN), for example, `arn:aws:iam::820196288204:role/myrole`. <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. diff --git a/modules/hcp-ibmz-scale-np.adoc b/modules/hcp-ibmz-scale-np.adoc index 06b1b2b59b09..e52447e4a425 100644 --- a/modules/hcp-ibmz-scale-np.adoc +++ b/modules/hcp-ibmz-scale-np.adoc @@ -21,7 +21,7 @@ When you scale down a node pool, Agents are unbound from the corresponding clust $ oc -n scale nodepool --replicas 2 ---- + -The Cluster API agent provider randomly picks two agents that are then assigned to the hosted cluster. Those agents go through different states and finally join the hosted cluster as {ocp-short} nodes. The agents pass through the transition phases in the following order: +The Cluster API agent provider randomly picks two agents that are then assigned to the hosted cluster. Those agents go through different states and finally join the hosted cluster as {product-title} nodes. The agents pass through the transition phases in the following order: * `binding` * `discovering` @@ -69,7 +69,7 @@ da503cf1-a347-44f2-875c-4960ddb04091 hosted-forwarder true auto-ass $ hcp create kubeconfig --namespace --name > .kubeconfig ---- -. After the agents reach the `added-to-existing-cluster` state, verify that you can see the {ocp-short} nodes by entering the following command: +. After the agents reach the `added-to-existing-cluster` state, verify that you can see the {product-title} nodes by entering the following command: + [source,terminal] ---- diff --git a/modules/hcp-managed-aws-hc-separate.adoc b/modules/hcp-managed-aws-hc-separate.adoc index bd76f9e13c49..7945df96149d 100644 --- a/modules/hcp-managed-aws-hc-separate.adoc +++ b/modules/hcp-managed-aws-hc-separate.adoc @@ -25,7 +25,7 @@ $ hcp create cluster aws \ <1> Replace `` with the same ID that you specified in the `create infra aws` command. This value identifies the IAM resources that are associated with the hosted cluster. <2> Replace `` with the name of your hosted cluster. <3> Replace `` with the same name that you specified in the `create infra aws` command. -<4> Replace `` with the name of the file that contains a valid {ocp-short} pull secret. +<4> Replace `` with the name of the file that contains a valid {product-title} pull secret. <5> The `--generate-ssh` flag is optional, but is good to include in case you need to SSH to your workers. An SSH key is generated for you and is stored as a secret in the same namespace as the hosted cluster. <6> Replace `` with the Amazon Resource Name (ARN), for example, `arn:aws:iam::820196288204:role/myrole`. Specify the Amazon Resource Name (ARN), for example, `arn:aws:iam::820196288204:role/myrole`. For more information about ARN roles, see "Identity and Access Management (IAM) permissions". diff --git a/modules/hcp-non-bm-hc-mirror.adoc b/modules/hcp-non-bm-hc-mirror.adoc index 30c12ab454d1..c9b857f8fb4c 100644 --- a/modules/hcp-non-bm-hc-mirror.adoc +++ b/modules/hcp-non-bm-hc-mirror.adoc @@ -52,4 +52,4 @@ $ hcp create cluster agent \ <6> Specify the `icsp.yaml` file that defines ICSP and your mirror registries. <7> Specify the path to your SSH public key. The default file path is `~/.ssh/id_rsa.pub`. <8> Specify your hosted cluster namespace. -<9> Specify the supported {product-title} version that you want to use, for example, `4.14.0-x86_64`. If you are using a disconnected environment, replace `` with the digest image. To extract the {product-title} release image digest, see _Extracting the {product-title} release image digest_. +<9> 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 `` with the digest image. To extract the {product-title} release image digest, see _Extracting the {product-title} release image digest_. diff --git a/modules/hcp-non-bm-hc.adoc b/modules/hcp-non-bm-hc.adoc index f29a481ce563..124019802c31 100644 --- a/modules/hcp-non-bm-hc.adoc +++ b/modules/hcp-non-bm-hc.adoc @@ -53,7 +53,7 @@ $ hcp create cluster agent \ <7> Specify the path to your SSH public key. The default file path is `~/.ssh/id_rsa.pub`. <8> Specify your hosted cluster namespace. <9> The default value for the control plane availability policy is `HighlyAvailable`. -<10> Specify the supported {ocp-short} version that you want to use, for example, `4.14.0-x86_64`. +<10> Specify the supported {product-title} version that you want to use, for example, `4.17.0-multi`. .Verification @@ -70,4 +70,4 @@ $ oc -n get pods NAME READY STATUS RESTARTS AGE catalog-operator-6cd867cc7-phb2q 2/2 Running 0 2m50s control-plane-operator-f6b4c8465-4k5dh 1/1 Running 0 4m32s ----- +---- \ No newline at end of file diff --git a/modules/hcp-virt-map-storage.adoc b/modules/hcp-virt-map-storage.adoc index cc279542feec..d5a13962fd01 100644 --- a/modules/hcp-virt-map-storage.adoc +++ b/modules/hcp-virt-map-storage.adoc @@ -46,7 +46,7 @@ The following table shows how volume and access mode capabilities map to KubeVir | RWX: `Block` or `Filesystem` | `ReadWriteOnce` (RWO) `Block` or `Filesystem` RWX `Block` only | Supported -| Use `Block` mode because `Filesystem` volume mode results in degraded hosted `Block` mode performance. RWX `Block` volume mode is supported only when the hosted cluster is {ocp-short} 4.16 or later. +| Use `Block` mode because `Filesystem` volume mode results in degraded hosted `Block` mode performance. RWX `Block` volume mode is supported only when the hosted cluster is {product-title} 4.16 or later. | RWO `Block` storage | RWO `Block` storage or `Filesystem`