OSDOCS-11053 Removing incorrect name attribute for rosa edit machinepool command

laubai · laubai · commit ee76a6a1f94f · 2024-08-06T17:18:37.000+10:00
diff --git a/modules/creating-a-machine-pool-cli.adoc b/modules/creating-a-machine-pool-cli.adoc
@@ -178,7 +178,7 @@ mymachinepool  Yes          3-6       m5.xlarge      app=db, tier=backend
 +
 [source,terminal]
 ----
-$ rosa describe machinepool --cluster=<cluster_name> mymachinepool
+$ rosa describe machinepool --cluster=<cluster_name> --machinepool=mymachinepool
 ----
 +
 .Example output
diff --git a/modules/removing-custom-config-from-machinepool.adoc b/modules/removing-custom-config-from-machinepool.adoc
@@ -21,13 +21,13 @@ To remove all `KubeletConfig` objects from the machine pool, set an empty value
 +
 [source,terminal]
 ----
-$ rosa edit machinepool -c <cluster_name> --kubeletconfigs="" --name <machinepool_name>
+$ rosa edit machinepool -c <cluster_name> --kubeletconfigs="" <machinepool_name>
 ----
 
 .Verification steps
 * Confirm that the `KubeletConfig` object you removed is not visible in the machine pool description:
 +
 [source,terminal]
 ----
-$ rosa describe machinepool --cluster <cluster_name> --name <machinepool_name>
+$ rosa describe machinepool --cluster <cluster_name> --machinepool=<machinepool_name>
 ----
diff --git a/modules/rosa-adding-node-labels.adoc b/modules/rosa-adding-node-labels.adoc
@@ -103,7 +103,7 @@ I: Updated machine pool 'db-nodes-mp' on cluster 'mycluster'
 +
 [source,terminal]
 ----
-$ rosa describe machinepool --cluster=<cluster_name> <machine-pool-name>
+$ rosa describe machinepool --cluster=<cluster_name> --machinepool=<machine-pool-name>
 ----
 +
 .Example output
diff --git a/modules/rosa-adding-tags-cli.adoc b/modules/rosa-adding-tags-cli.adoc
@@ -49,7 +49,7 @@ I: To view all machine pools, run 'rosa list machinepools --cluster mycluster'
 +
 [source,terminal]
 ----
-$ rosa describe machinepool --cluster=<cluster_name> <machine_pool_name>
+$ rosa describe machinepool --cluster=<cluster_name> --machinepool=<machinepool_name>
 ----
 +
 .Example output
diff --git a/modules/rosa-adding-taints-cli.adoc b/modules/rosa-adding-taints-cli.adoc
@@ -104,7 +104,7 @@ I: Updated machine pool 'db-nodes-mp' on cluster 'mycluster'
 +
 [source,terminal]
 ----
-$ rosa describe machinepool --cluster=<cluster_name> <machine-pool-name>
+$ rosa describe machinepool --cluster=<cluster_name> --machinepool=<machinepool_name>
 ----
 +
 .Example output
diff --git a/modules/rosa-edit-objects.adoc b/modules/rosa-edit-objects.adoc
@@ -234,7 +234,7 @@ Allows edits to the machine pool in a cluster.
 .Syntax
 [source,terminal]
 ----
-$ rosa edit machinepool --cluster=<cluster_name_or_id> <machinepool_ID> [arguments]
+$ rosa edit machinepool --cluster=<cluster_name_or_id> <machinepool_name> [arguments]
 ----
 
 .Arguments
diff --git a/modules/rosa-list-objects.adoc b/modules/rosa-list-objects.adoc
@@ -743,7 +743,7 @@ Describes a specific machine pool configured on a cluster.
 .Syntax
 [source,terminal]
 ----
-$ rosa describe machinepool --cluster=<cluster_name> --machinepool=<machinepool_name>| <cluster_id> <machinepool_id> [arguments]
+$ rosa describe machinepool --cluster=[<cluster_name>|<cluster_id>] --machinepool=<machinepool_name> [arguments]
 ----
 
 .Arguments
diff --git a/modules/rosa-node-drain-grace-period.adoc b/modules/rosa-node-drain-grace-period.adoc
@@ -37,7 +37,7 @@ db-nodes-mp  No           2         m5.xlarge    [...] us-east-1a          No
 +
 [source,terminal]
 ----
-$ rosa describe machinepool --cluster <cluster_name> <machinepool_name>
+$ rosa describe machinepool --cluster <cluster_name> --machinepool=<machinepool_name>
 ----
 +
 .Example output
diff --git a/modules/setting-higher-pid-limit-on-machinepool.adoc b/modules/setting-higher-pid-limit-on-machinepool.adoc
@@ -25,7 +25,7 @@ Changing the `podPidsLimit` on an existing machine pool triggers nodes in the ma
 +
 [source,terminal]
 ----
-$ rosa create kubeletconfig -c <cluster_name> --name=<kubeletconfig_name>  --pod-pids-limit=<value>
+$ rosa create kubeletconfig -c <cluster_name> --name=<kubeletconfig_name> --pod-pids-limit=<value>
 ----
 +
 For example, the following command creates a `set-high-pids` `KubeletConfig` object for the `my-cluster` cluster that sets a maximum of 16,384 PIDs per pod:
@@ -42,28 +42,28 @@ $ rosa create kubeletconfig -c my-cluster --name=set-high-pids --pod-pids-limit=
 +
 [source,terminal]
 ----
-$ rosa create machinepool -c <cluster_name> --kubelet-configs=<kubeletconfig_name> --name <machinepool_name>
+$ rosa create machinepool -c <cluster_name> --name <machinepool_name> --kubelet-configs=<kubeletconfig_name>
 ----
 ** For an existing machine pool:
 +
 [source,terminal]
 ----
-$ rosa edit machinepool -c <cluster_name> --kubelet-configs=<kubeletconfig_name> --name <machinepool_name>
+$ rosa edit machinepool -c <cluster_name> --kubelet-configs=<kubeletconfig_name> <machinepool_name>
 ----
 --
 +
 For example, the following command associates the `set-high-pids` `KubeletConfig` object with the `high-pid-pool` machine pool in the `my-cluster` cluster:
 +
 [source,terminal]
 ----
-$ rosa edit machinepool -c my-cluster --kubelet-configs=set-high-pids --name=high-pid-pool
+$ rosa edit machinepool -c my-cluster --kubelet-configs=set-high-pids high-pid-pool
 ----
 +
 A rolling reboot of worker nodes is triggered when a new `KubeletConfig` object is attached to an existing machine pool. You can check the progress of the rollout in the machine pool description:
 +
 [source,terminal]
 ----
-$ rosa describe machinepool --cluster <cluster_name> --name <machinepool_name>
+$ rosa describe machinepool --cluster <cluster_name> --machinepool <machinepool_name>
 ----
 
 .Verification

Original file line number	Diff line number	Diff line change
`@@ -178,7 +178,7 @@ mymachinepool Yes 3-6 m5.xlarge app=db, tier=backend`
`178`	`178`	`+`
`179`	`179`	`[source,terminal]`
`180`	`180`	`----`
`181`		`-$ rosa describe machinepool --cluster=<cluster_name> mymachinepool`
	`181`	`+$ rosa describe machinepool --cluster=<cluster_name> --machinepool=mymachinepool`
`182`	`182`	`----`
`183`	`183`	`+`
`184`	`184`	`.Example output`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ I: Updated machine pool 'db-nodes-mp' on cluster 'mycluster'`
`103`	`103`	`+`
`104`	`104`	`[source,terminal]`
`105`	`105`	`----`
`106`		`-$ rosa describe machinepool --cluster=<cluster_name> <machine-pool-name>`
	`106`	`+$ rosa describe machinepool --cluster=<cluster_name> --machinepool=<machine-pool-name>`
`107`	`107`	`----`
`108`	`108`	`+`
`109`	`109`	`.Example output`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ I: To view all machine pools, run 'rosa list machinepools --cluster mycluster'`
`49`	`49`	`+`
`50`	`50`	`[source,terminal]`
`51`	`51`	`----`
`52`		`-$ rosa describe machinepool --cluster=<cluster_name> <machine_pool_name>`
	`52`	`+$ rosa describe machinepool --cluster=<cluster_name> --machinepool=<machinepool_name>`
`53`	`53`	`----`
`54`	`54`	`+`
`55`	`55`	`.Example output`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ I: Updated machine pool 'db-nodes-mp' on cluster 'mycluster'`
`104`	`104`	`+`
`105`	`105`	`[source,terminal]`
`106`	`106`	`----`
`107`		`-$ rosa describe machinepool --cluster=<cluster_name> <machine-pool-name>`
	`107`	`+$ rosa describe machinepool --cluster=<cluster_name> --machinepool=<machinepool_name>`
`108`	`108`	`----`
`109`	`109`	`+`
`110`	`110`	`.Example output`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ db-nodes-mp No 2 m5.xlarge [...] us-east-1a No`
`37`	`37`	`+`
`38`	`38`	`[source,terminal]`
`39`	`39`	`----`
`40`		`-$ rosa describe machinepool --cluster <cluster_name> <machinepool_name>`
	`40`	`+$ rosa describe machinepool --cluster <cluster_name> --machinepool=<machinepool_name>`
`41`	`41`	`----`
`42`	`42`	`+`
`43`	`43`	`.Example output`
Original file line number	Diff line number	Diff line change
@@ -25,7 +25,7 @@ Changing the `podPidsLimit` on an existing machine pool triggers nodes in the ma
`25`	`25`	`+`
`26`	`26`	`[source,terminal]`
`27`	`27`	`----`
`28`		`-$ rosa create kubeletconfig -c <cluster_name> --name=<kubeletconfig_name> --pod-pids-limit=<value>`
	`28`	`+$ rosa create kubeletconfig -c <cluster_name> --name=<kubeletconfig_name> --pod-pids-limit=<value>`
`29`	`29`	`----`
`30`	`30`	`+`
`31`	`31`	For example, the following command creates a `set-high-pids` `KubeletConfig` object for the `my-cluster` cluster that sets a maximum of 16,384 PIDs per pod:
`@@ -42,28 +42,28 @@ $ rosa create kubeletconfig -c my-cluster --name=set-high-pids --pod-pids-limit=`
`42`	`42`	`+`
`43`	`43`	`[source,terminal]`
`44`	`44`	`----`
`45`		`-$ rosa create machinepool -c <cluster_name> --kubelet-configs=<kubeletconfig_name> --name <machinepool_name>`
	`45`	`+$ rosa create machinepool -c <cluster_name> --name <machinepool_name> --kubelet-configs=<kubeletconfig_name>`
`46`	`46`	`----`
`47`	`47`	`** For an existing machine pool:`
`48`	`48`	`+`
`49`	`49`	`[source,terminal]`
`50`	`50`	`----`
`51`		`-$ rosa edit machinepool -c <cluster_name> --kubelet-configs=<kubeletconfig_name> --name <machinepool_name>`
	`51`	`+$ rosa edit machinepool -c <cluster_name> --kubelet-configs=<kubeletconfig_name> <machinepool_name>`
`52`	`52`	`----`
`53`	`53`	`--`
`54`	`54`	`+`
`55`	`55`	For example, the following command associates the `set-high-pids` `KubeletConfig` object with the `high-pid-pool` machine pool in the `my-cluster` cluster:
`56`	`56`	`+`
`57`	`57`	`[source,terminal]`
`58`	`58`	`----`
`59`		`-$ rosa edit machinepool -c my-cluster --kubelet-configs=set-high-pids --name=high-pid-pool`
	`59`	`+$ rosa edit machinepool -c my-cluster --kubelet-configs=set-high-pids high-pid-pool`
`60`	`60`	`----`
`61`	`61`	`+`
`62`	`62`	A rolling reboot of worker nodes is triggered when a new `KubeletConfig` object is attached to an existing machine pool. You can check the progress of the rollout in the machine pool description:
`63`	`63`	`+`
`64`	`64`	`[source,terminal]`
`65`	`65`	`----`
`66`		`-$ rosa describe machinepool --cluster <cluster_name> --name <machinepool_name>`
	`66`	`+$ rosa describe machinepool --cluster <cluster_name> --machinepool <machinepool_name>`
`67`	`67`	`----`
`68`	`68`
`69`	`69`	`.Verification`