Skip to content

Commit c552e5c

Browse files
skopacz1skopacz1
authored
Merge pull request #74172 from EricPonvelle/OSDOCS-9751_machine-pool-graphics-HCP
OSDOCS-9751: Added and described machine pool graphics
2 parents 6252fe6 + e8854df commit c552e5c

File tree

7 files changed

+117
-0
lines changed

7 files changed

+117
-0
lines changed

‎images/hcp-rosa-machine-pools.png

154 KB
Loading

‎modules/machine-pools-hcp.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="machine-pools-hcp_{context}"]
7+
= Machine pools in {hcp-title} clusters
8+
9+
In {hcp-title} clusters, the hosted control plane spans three availability zones (AZ) in the installed cloud region. Each machine pool in a {hcp-title} cluster deploys in a single subnet within a single AZ. Each of these AZs can have only one machine pool.
10+
11+
Each machine pool in an {hcp-title} cluster upgrades independently. Because the machine pools upgrade independently, they must remain within 2 minor (Y-stream) versions of the hosted control plane. For example, if your hosted control plane is 4.16.z, your machine pools must be at least 4.14.z.
12+
13+
The following image depicts how machine pools work within ROSA and {hcp-title} clusters:
14+
15+
image::hcp-rosa-machine-pools.png[Machine pools on ROSA classic and ROSA with HCP clusters]
16+
17+
[NOTE]
18+
====
19+
Machine pools in {hcp-title} clusters each upgrade independently and the machine pool versions must remain within two minor (Y-stream) versions of the control plane.
20+
====

‎modules/rosa-adding-tags-cli.adoc

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="rosa-adding-tags-cli{context}"]
7+
= Adding tags to a machine pool using the ROSA CLI
8+
9+
You can add tags to a machine pool for your {product-title} cluster by using the ROSA command line interface (CLI).
10+
11+
[IMPORTANT]
12+
====
13+
You must ensure that your tag keys are not `aws`, `red-hat-managed`, `red-hat-clustertype`, or `Name`. In addition, you must not set a tag key that begins with `kubernetes.io/cluster/`. Your tag's key cannot be longer than 128 characters, while your tag's value cannot be longer than 256 characters. Red{nbsp}Hat reserves the right to add additional reserved tags in the future.
14+
====
15+
16+
.Prerequisites
17+
18+
* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation.
19+
* You logged in to your Red{nbsp}Hat account by using the `rosa` CLI.
20+
* You created a {product-title} (ROSA) cluster.
21+
22+
.Procedure
23+
24+
* Create a machine pool with a custom tag by running the following command:
25+
+
26+
--
27+
[source,terminal]
28+
----
29+
$ rosa create machinepools --cluster=<name> --replicas=<replica_count> \
30+
--name <mp_name> --tags='<key> <value>,<key> <value>' \ <1>
31+
----
32+
<1> Replace `<key> <value>,<key> <value>` with a key and value for each tag.
33+
--
34+
+
35+
.Example output
36+
[source,terminal]
37+
----
38+
$ rosa create machinepools --cluster=mycluster --replicas 2 --tags='tagkey1 tagvalue1,tagkey2 tagvaluev2'
39+
40+
I: Checking available instance types for machine pool 'mp-1'
41+
I: Machine pool 'mp-1' created successfully on cluster 'mycluster'
42+
I: To view the machine pool details, run 'rosa describe machinepool --cluster mycluster --machinepool mp-1'
43+
I: To view all machine pools, run 'rosa list machinepools --cluster mycluster'
44+
----
45+
46+
.Verification
47+
48+
* Use the `describe` command to see the details of the machine pool with the tags, and verify that the tags are included for your machine pool in the output:
49+
+
50+
[source,terminal]
51+
----
52+
$ rosa describe machinepool --cluster=<cluster_name> <machine_pool_name>
53+
----
54+
+
55+
.Example output
56+
[source,terminal]
57+
----
58+
$ rosa describe machinepool --cluster classic-rosa --machinepool mp-1
59+
60+
ID: mp-1
61+
Cluster ID: 2baiirqa2141oreotoivp4sipq84vp5g
62+
Autoscaling: No
63+
Replicas: 2
64+
Instance type: m5.xlarge
65+
Labels:
66+
Taints:
67+
Availability zones: us-east-1a
68+
Subnets:
69+
Spot instances: No
70+
Disk size: 300 GiB
71+
Additional Security Group IDs:
72+
Tags: red-hat-clustertype=rosa, red-hat-managed=true, tagkey1=tagvalue1, tagkey2=tagvaluev2
73+
----

‎modules/rosa-adding-tags.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="rosa-adding-tags_{context}"]
7+
= Adding tags to a machine pool
8+
9+
You can add tags for compute nodes, also known as worker nodes, in a machine pool to introduce custom user tags for AWS resources that are generated when you provision your machine pool.

‎modules/rosa-create-objects.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -717,6 +717,9 @@ a|--cluster <cluster_name>\|<cluster_id>
717717
|--replicas
718718
|Required when autoscaling is not configured. The number (integer) of machines for this machine pool.
719719

720+
|--tags
721+
|Apply user defined tags to all resources created by ROSA in AWS. Tags are comma separated, for example: `'key value, foo bar'`.
722+
720723
|--taints
721724
|Taints for the machine pool. This string value should be formatted as a comma-separated list of `key=value:ScheduleType`. This list will overwrite any modifications made to Node taints on an ongoing basis.
722725
|===
@@ -768,6 +771,13 @@ Add a machine pool with labels to a cluster.
768771
$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz --name=mp-1
769772
----
770773

774+
Add a machine pool with tags to a cluster.
775+
776+
[source,terminal]
777+
----
778+
$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --tags='foo bar,bar baz' --name=mp-1
779+
----
780+
771781
[id="rosa-create-ocm-role_{context}"]
772782
== create ocm-role
773783

‎rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ include::modules/rosa-adding-node-labels.adoc[leveloffset=+2]
5353

5454
// include::modules/rosa-imds-machine-pools-ui.adoc[leveloffset=+2]
5555
// include::modules/rosa-imds-machine-pools-cli.adoc[leveloffset=+2]
56+
include::modules/rosa-adding-tags.adoc[leveloffset=+1]
57+
include::modules/rosa-adding-tags-cli.adoc[leveloffset=+2]
5658
include::modules/rosa-adding-taints.adoc[leveloffset=+1]
5759
include::modules/rosa-adding-taints-ocm.adoc[leveloffset=+2]
5860
include::modules/rosa-adding-taints-cli.adoc[leveloffset=+2]

‎rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ You can override this default setting and create a machine pool in a Single-AZ o
5757
Similarly, deleting a machine pool will delete it from all zones.
5858
Due to this multiplicative effect, using machine pools in Multi-AZ cluster can consume more of your project's quota for a specific region when creating machine pools.
5959

60+
// ROSA HCP content applies to the following subsection
61+
include::modules/machine-pools-hcp.adoc[leveloffset=+1]
62+
6063
== Additional resources
6164
ifdef::openshift-rosa[]
6265
* xref:../../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing compute nodes]

0 commit comments

Comments
 (0)