Skip to content

Commit 077c17a

Browse files
EricPonvelleEricPonvelle
authored
Merge pull request #68176 from EricPonvelle/OSDOCS-8359_machine-pool-describe
OSDOCS-8359: Added the rosa describe machine pool command
2 parents db26525 + 7820eb0 commit 077c17a

File tree

4 files changed

+63
-19
lines changed

4 files changed

+63
-19
lines changed

‎modules/creating-a-machine-pool-cli.adoc

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,9 @@ I: To view all machine pools, run 'rosa list machinepools -c mycluster'
114114
115115
.Verification
116116

117-
. List the available machine pools in your cluster:
117+
You can list all machine pools on your cluster or describe individual machine pools.
118+
119+
. List the available machine pools on your cluster:
118120
+
119121
[source,terminal]
120122
----
@@ -129,4 +131,28 @@ Default No 3 m5.xlarge
129131
mymachinepool Yes 3-6 m5.xlarge app=db, tier=backend us-east-1a, us-east-1b, us-east-1c No
130132
----
131133

134+
. Describe the information of a specific machine pool in your cluster:
135+
+
136+
[source,terminal]
137+
----
138+
$ rosa describe machinepool --cluster=<cluster_name> mymachinepool
139+
----
140+
+
141+
.Example output
142+
[source,terminal]
143+
----
144+
ID: mymachinepool
145+
Cluster ID: 27iimopsg1mge0m81l0sqivkne2qu6dr
146+
Autoscaling: Yes
147+
Replicas: 3-6
148+
Instance type: m5.xlarge
149+
Labels: app=db, tier=backend
150+
Taints:
151+
Availability zones: us-east-1a, us-east-1b, us-east-1c
152+
Subnets:
153+
Spot instances: No
154+
Disk size: 300 GiB
155+
Security Group IDs:
156+
----
157+
132158
. Verify that the machine pool is included in the output and the configuration is as expected.

‎modules/rosa-adding-node-labels.adoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,19 +99,28 @@ I: Updated machine pool 'db-nodes-mp' on cluster 'mycluster'
9999
100100
.Verification
101101

102-
. List the available machine pools in your cluster:
102+
. Describe the details of the machine pool with the new labels:
103103
+
104104
[source,terminal]
105105
----
106-
$ rosa list machinepools --cluster=<cluster_name>
106+
$ rosa describe machinepool --cluster=<cluster_name> <machine-pool-name>
107107
----
108108
+
109109
.Example output
110110
[source,terminal]
111111
----
112-
ID AUTOSCALING REPLICAS INSTANCE TYPE LABELS TAINTS AVAILABILITY ZONES SPOT INSTANCES DISK SIZE SG IDs
113-
Default No 2 m5.xlarge us-east-1a N/A 300 GiB sg-0e375ff0ec4a6cfa2
114-
db-nodes-mp No 2 m5.xlarge app=db, tier=backend us-east-1a No 300 GiB sg-0e375ff0ec4a6cfa2
112+
ID: db-nodes-mp
113+
Cluster ID: <ID_of_cluster>
114+
Autoscaling: No
115+
Replicas: 2
116+
Instance type: m5.xlarge
117+
Labels: app=db, tier=backend
118+
Taints:
119+
Availability zones: us-east-1a
120+
Subnets:
121+
Spot instances: No
122+
Disk size: 300 GiB
123+
Security Group IDs:
115124
----
116125

117126
. Verify that the labels are included for your machine pool in the output.

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

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,19 +100,28 @@ I: Updated machine pool 'db-nodes-mp' on cluster 'mycluster'
100100
101101
.Verification
102102

103-
. List the available machine pools in your cluster by running the following command:
103+
. Describe the details of the machine pool with the new taints:
104104
+
105105
[source,terminal]
106106
----
107-
$ rosa list machinepools --cluster=<cluster_name>
107+
$ rosa describe machinepool --cluster=<cluster_name> <machine-pool-name>
108108
----
109109
+
110110
.Example output
111111
[source,terminal]
112112
----
113-
ID AUTOSCALING REPLICAS INSTANCE TYPE LABELS TAINTS AVAILABILITY ZONES SPOT INSTANCES DISK SIZE SG IDs
114-
Default No 2 m5.xlarge us-east-1a N/A 300GiB sg-0e375ff0ec4a6cfa2
115-
db-nodes-mp No 2 m5.xlarge key1=value1:NoSchedule, key2=value2:NoExecute us-east-1a No 300GiB sg-0e375ff0ec4a6cfa2
113+
ID: db-nodes-mp
114+
Cluster ID: <ID_of_cluster>
115+
Autoscaling: No
116+
Replicas: 2
117+
Instance type: m5.xlarge
118+
Labels:
119+
Taints: key1=value1:NoSchedule, key2=value2:NoExecute
120+
Availability zones: us-east-1a
121+
Subnets:
122+
Spot instances: No
123+
Disk size: 300 GiB
124+
Security Group IDs:
116125
----
117126

118127
. Verify that the taints are included for your machine pool in the output.

‎modules/rosa-adding-tuning.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ This feature is only supported on {hcp-title-first} clusters.
1616
.Prerequisites
1717

1818
* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation.
19-
* You logged in to your Red Hat account using the ROSA CLI.
19+
* You logged in to your Red Hat account by using the ROSA CLI.
2020
* You created a {hcp-title-first} cluster.
2121
* You have an existing machine pool.
2222
* You have an existing tuning configuration.
2323
2424
.Procedure
2525

26-
. List the machine pools in the cluster:
26+
. List all of the machine pools in the cluster:
2727
+
2828
[source,terminal]
2929
----
@@ -34,9 +34,9 @@ $ rosa list machinepools --cluster=<cluster_name>
3434
+
3535
[source,terminal]
3636
----
37-
ID AUTOSCALING REPLICAS INSTANCE TYPE LABELS TAINTS AVAILABILITY ZONES SUBNETS VERSION AUTOREPAIR TUNING CONFIGS MESSAGE
38-
Default No 2 m5.xlarge us-east-1a N/A 4.12.14 Yes
39-
db-nodes-mp No 2 m5.xlarge us-east-1a No 4.12.14 Yes
37+
ID AUTOSCALING REPLICAS INSTANCE TYPE [...] AVAILABILITY ZONES SUBNET VERSION AUTOREPAIR TUNING CONFIGS
38+
workers No 2 m5.xlarge [...] us-east-1a N/A 4.12.14 Yes
39+
db-nodes-mp No 2 m5.xlarge [...] us-east-1a No 4.12.14 Yes
4040
----
4141

4242
. You can add tuning configurations to an existing or new machine pool.
@@ -81,9 +81,9 @@ $ rosa list machinepools --cluster=<cluster_name>
8181
.Example output
8282
[source,terminal]
8383
----
84-
ID AUTOSCALING REPLICAS INSTANCE TYPE LABELS TAINTS AVAILABILITY ZONES SUBNET VERSION AUTOREPAIR TUNING CONFIGS MESSAGE
85-
Default No 2 m5.xlarge us-east-1a N/A 4.12.14 Yes
86-
db-nodes-mp No 2 m5.xlarge us-east-1a No 4.12.14 Yes sample-tuning
84+
ID AUTOSCALING REPLICAS INSTANCE TYPE [...] AVAILABILITY ZONES SUBNET VERSION AUTOREPAIR TUNING CONFIGS
85+
workers No 2 m5.xlarge [...] us-east-1a N/A 4.12.14 Yes
86+
db-nodes-mp No 2 m5.xlarge [...] us-east-1a No 4.12.14 Yes sample-tuning
8787
----
8888

8989
. Verify that the tuning config is included for your machine pool in the output.

0 commit comments

Comments
 (0)