Skip to content

Commit 7a78822

Browse files
committed
[OSDOCS-12035]: Adding tenancy docs to HCP on AWS
1 parent f60d818 commit 7a78822

File tree

2 files changed

+36
-15
lines changed

2 files changed

+36
-15
lines changed

modules/hcp-aws-deploy-hc.adoc

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="hcp-aws-deploy-hc_{context}"]
7-
= Deploying a hosted cluster on {aws-short}
7+
= Creating a hosted cluster on {aws-short}
88

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

1111
.Prerequisites
1212

@@ -18,21 +18,22 @@ You can deploy a hosted cluster on {aws-first} by using the `hcp` command-line i
1818
1919
.Procedure
2020

21-
* To create the hosted cluster on {aws-short}, run the following command:
21+
. To create a hosted cluster on {aws-short}, run the following command:
2222
+
2323
[source,terminal]
2424
----
2525
$ hcp create cluster aws \
26-
--name <hosted_cluster_name> \ <1>
27-
--infra-id <infra_id> \ <2>
28-
--base-domain <basedomain> \ <3>
29-
--sts-creds <path_to_sts_credential_file> \ <4>
30-
--pull-secret <path_to_pull_secret> \ <5>
31-
--region <region> \ <6>
26+
--name <hosted_cluster_name> \// <1>
27+
--infra-id <infra_id> \// <2>
28+
--base-domain <basedomain> \// <3>
29+
--sts-creds <path_to_sts_credential_file> \// <4>
30+
--pull-secret <path_to_pull_secret> \// <5>
31+
--region <region> \// <6>
3232
--generate-ssh \
33-
--node-pool-replicas <node_pool_replica_count> \ <7>
34-
--namespace <hosted_cluster_namespace> \ <8>
35-
--role-arn <role_name> <9>
33+
--node-pool-replicas <node_pool_replica_count> \// <7>
34+
--namespace <hosted_cluster_namespace> \// <8>
35+
--role-arn <role_name> \// <9>
36+
--render-into <file_name>.yaml <10>
3637
----
3738
<1> Specify the name of your hosted cluster, for instance, `example`.
3839
<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.
@@ -43,6 +44,26 @@ $ hcp create cluster aws \
4344
<7> Specify the node pool replica count, for example, `3`.
4445
<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.
4546
<9> Specify the Amazon Resource Name (ARN), for example, `arn:aws:iam::820196288204:role/myrole`.
47+
<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.
48+
49+
. 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:
50+
+
51+
.Example YAML file
52+
[source,yaml]
53+
----
54+
apiVersion: hypershift.openshift.io/v1beta1
55+
kind: NodePool
56+
metadata:
57+
name: <nodepool_name> <1>
58+
spec:
59+
platform:
60+
aws:
61+
placement:
62+
tenancy: "default" <2>
63+
----
64+
+
65+
<1> Specify the name of the `NodePool` resource.
66+
<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.
4667

4768
.Verification
4869

@@ -58,4 +79,4 @@ $ oc get hostedclusters -n <hosted_cluster_namespace>
5879
[source,terminal]
5980
----
6081
$ oc get nodepools --namespace <hosted_cluster_namespace>
61-
----
82+
----

modules/hcp-aws-hc-ext-dns.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: PROCEDURE
66
[id="hcp-aws-hc-ext-dns_{context}"]
7-
= Deploying a hosted cluster by using the external DNS on {aws-short}
7+
= Creating a hosted cluster by using the external DNS on {aws-short}
88

99
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:
1010

@@ -67,4 +67,4 @@ $ hcp create cluster aws \
6767
<8> Specify the supported {ocp-short} version that you want to use, for example, `4.14.0-x86_64`.
6868
<9> Specify the public hosted zone that the service provider owns, for example, `service-provider-domain.com`.
6969
<10> Set as `PublicAndPrivate`. You can use external DNS with `Public` or `PublicAndPrivate` configurations only.
70-
<11> Specify the path to your {aws-short} STS credentials file, for example, `/home/user/sts-creds/sts-creds.json`.
70+
<11> Specify the path to your {aws-short} STS credentials file, for example, `/home/user/sts-creds/sts-creds.json`.

0 commit comments

Comments
 (0)