Merge pull request #83719 from lahinson/osdocs-12035-hcp-tenancy

[OSDOCS-12035]: Adding tenancy docs to HCP on AWS

Author: lahinson

modules/hcp-aws-deploy-hc.adoc

@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="hcp-aws-deploy-hc_{context}"]
-= Deploying a hosted cluster on {aws-short}
+= Creating a hosted cluster on {aws-short}
 
-You can deploy a hosted cluster on {aws-first} by using the `hcp` command-line interface (CLI).
+You can create a hosted cluster on {aws-first} by using the `hcp` command-line interface (CLI).
 
 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".
 
@@ -30,21 +30,22 @@ For compatible combinations of node pools and hosted clusters, see the following
 
 .Procedure
 
-* To create the hosted cluster on {aws-short}, run the following command:
+. To create a hosted cluster on {aws-short}, run the following command:
 +
 [source,terminal]
 ----
 $ hcp create cluster aws \
-    --name <hosted_cluster_name> \ <1>
-    --infra-id <infra_id> \ <2>
-    --base-domain <basedomain> \ <3>
-    --sts-creds <path_to_sts_credential_file> \ <4>
-    --pull-secret <path_to_pull_secret> \ <5>
-    --region <region> \ <6>
+    --name <hosted_cluster_name> \// <1>
+    --infra-id <infra_id> \// <2>
+    --base-domain <basedomain> \// <3>
+    --sts-creds <path_to_sts_credential_file> \// <4>
+    --pull-secret <path_to_pull_secret> \// <5>
+    --region <region> \// <6>
     --generate-ssh \
-    --node-pool-replicas <node_pool_replica_count> \ <7>
-    --namespace <hosted_cluster_namespace> \ <8>
-    --role-arn <role_name> <9>
+    --node-pool-replicas <node_pool_replica_count> \// <7>
+    --namespace <hosted_cluster_namespace> \// <8>
+    --role-arn <role_name> \// <9>
+    --render-into <file_name>.yaml <10>
 ----
 <1> Specify the name of your hosted cluster, for instance, `example`.
 <2> Specify your infrastructure name. You must provide the same value for `<hosted_cluster_name>` and `<infra_id>`. Otherwise the cluster might not appear correctly in the {mce} console.
@@ -55,6 +56,26 @@ $ hcp create cluster aws \
 <7> Specify the node pool replica count, for example, `3`.
 <8> By default, all `HostedCluster` and `NodePool` custom resources are created in the `clusters` namespace. You can use the `--namespace <namespace>` parameter, to create the `HostedCluster` and `NodePool` custom resources in a specific namespace.
 <9> Specify the Amazon Resource Name (ARN), for example, `arn:aws:iam::820196288204:role/myrole`.
+<10> If you want to indicate whether the EC2 instance runs on shared or single tenant hardware, include this field. The `--render-into` flag renders Kubernetes resources into the YAML file that you specify in this field. Then, continue to the next step to edit the YAML file.
+
+. If you included the `--render-into` flag in the previous command, edit the specified YAML file. Edit the `NodePool` specification in the YAML file to indicate whether the EC2 instance should run on shared or single-tenant hardware, similar to the following example:
++
+.Example YAML file
+[source,yaml]
+----
+apiVersion: hypershift.openshift.io/v1beta1
+kind: NodePool
+metadata:
+  name: <nodepool_name> <1>
+spec:
+  platform:
+    aws:
+      placement:
+        tenancy: "default" <2>
+----
++
+<1> Specify the name of the `NodePool` resource.
+<2> Specify a valid value for tenancy: `"default"`, `"dedicated"`, or `"host"`. Use `"default"` when node pool instances run on shared hardware. Use `"dedicated"` when each node pool instance runs on single-tenant hardware. Use `"host"` when node pool instances run on your pre-allocated dedicated hosts.
 
 .Verification
 
@@ -70,4 +91,4 @@ $ oc get hostedclusters -n <hosted_cluster_namespace>
 [source,terminal]
 ----
 $ oc get nodepools --namespace <hosted_cluster_namespace>
-----
+----

modules/hcp-aws-hc-ext-dns.adoc

@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="hcp-aws-hc-ext-dns_{context}"]
-= Deploying a hosted cluster by using the external DNS on {aws-short}
+= Creating a hosted cluster by using the external DNS on {aws-short}
 
 To create a hosted cluster by using the `PublicAndPrivate` or `Public` publishing strategy on {aws-first}, you must have the following artifacts configured in your management cluster:
 
@@ -67,4 +67,4 @@ $ hcp create cluster aws \
 <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`.
+<11> Specify the path to your {aws-short} STS credentials file, for example, `/home/user/sts-creds/sts-creds.json`.