Merge pull request #68703 from jneczypor/OSDOCS-8381

OSDOCS-8381: Migrate "Getting Started with Rosa - Managing your Worker Nodes"

Author: EricPonvelle

_topic_maps/_topic_map_rosa.yml

@@ -147,7 +147,9 @@ Topics:
     File: cloud-experts-getting-started-admin-rights
   - Name: Accessing your cluster
     File: cloud-experts-getting-started-accessing
-- Name: Deploying an Application
+  - Name: Managing worker nodes
+    File: cloud-experts-getting-started-managing-worker-nodes
+- Name: Deploying an application
   Dir: cloud-experts-deploying-application
   Distros: openshift-rosa
   Topics:

cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-managing-worker-nodes.adoc

@@ -0,0 +1,233 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="cloud-experts-getting-started-managing-worker-nodes"]
+= Tutorial: Managing worker nodes
+include::_attributes/attributes-openshift-dedicated.adoc[]
+:context: cloud-experts-getting-started-managing-worker-nodes
+
+toc::[]
+
+//rosaworkshop.io content metadata
+//Brought into ROSA product docs 2023-11-30
+
+In {product-title} (ROSA), changing aspects of your worker nodes is performed through the use of machine pools. A machine pool allows users to manage many machines as a single entity. Every ROSA cluster has a default machine pool that is created when the cluster is created. For more information, see the xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc#rosa-nodes-machinepools-about[machine pool] documentation.
+
+
+== Creating a machine pool
+You can create a machine pool with either the command line interface (CLI) or the user interface (UI). 
+
+=== Creating a machine pool with the CLI
+. Run the following command:
++
+[source,terminal]
+----
+rosa create machinepool --cluster=<cluster-name> --name=<machinepool-name> --replicas=<number-nodes>
+----
++
+.Example input
++
+[source,terminal]
+----
+ $ rosa create machinepool --cluster=my-rosa-cluster --name=new-mp
+ --replicas=2
+----
++
+.Example output
++
+[source,terminal]
+----
+I: Machine pool 'new-mp' created successfully on cluster 'my-rosa-cluster'
+I: To view all machine pools, run 'rosa list machinepools -c my-rosa-cluster'
+----
+
+. *Optional:* Add node labels or taints to specific nodes in a new machine pool by running the following command:
++
+[source,terminal]
+---- 
+rosa create machinepool --cluster=<cluster-name> --name=<machinepool-name> --replicas=<number-nodes> --labels=`<key=pair>`
+----
++
+.Example input
++
+[source,terminal]
+----
+$ rosa create machinepool --cluster=my-rosa-cluster --name=db-nodes-mp --replicas=2 --labels='app=db','tier=backend'
+----
++
+.Example output
++
+[source,terminal]
+----
+I: Machine pool 'db-nodes-mp' created successfully on cluster 'my-rosa-cluster'
+----
++
+This creates an additional 2 nodes that can be managed as a unit and also assigns them the labels shown.  
+
+. Run the following command to confirm machine pool creation and the assigned labels:
++
+[source,terminal]
+----
+rosa list machinepools --cluster=<cluster-name>
+----
++
+.Example output
++
+[source,terminal]
+----
+ID          AUTOSCALING  REPLICAS  INSTANCE TYPE  LABELS            TAINTS    AVAILABILITY ZONES
+Default     No           2         m5.xlarge                                  us-east-1a
+----
+
+=== Creating a machine pool with the UI
+. Log in to the link:https://console.redhat.com/openshift[Red Hat console] and click your cluster.
++
+image::cloud-experts-getting-started-managing-ocm-cluster.png[]
+
+. Click *Machine pools*.
++
+image:cloud-experts-getting-started-managing-mp-ocm.png[]
+
+. Click *Add machine pool*.
+
+. Enter the desired configuration.
++
+[TIP]
+====
+You can also and expand the *Edit node labels and taints* section to add node labels and taints to the nodes in the machine pool.
+====
++
+image::cloud-experts-getting-started-managing-mp-nlt.png[]
+
+. You will see the new machine pool you created.
++
+image::cloud-experts-getting-started-managing-mp-fromui.png[]
+
+== Scaling worker nodes
+
+Edit a machine pool to scale the number of worker nodes in that specific machine pool. You can use either the CLI or the UI to scale worker nodes.
+
+=== Scaling worker nodes using the CLI
+
+. Run the following command to see the default machine pool that is created with each cluster:
++
+[source,terminal]
+----
+rosa list machinepools --cluster=<cluster-name>
+----
++
+.Example output
++
+[source,terminal]
+----
+ID          AUTOSCALING  REPLICAS  INSTANCE TYPE  LABELS            TAINTS    AVAILABILITY ZONES
+Default     No           2         m5.xlarge                                  us-east-1a
+----
+
+. To scale the default machine pool out to a different number of nodes, run the following command:
++
+[source,terminal]
+----
+rosa edit machinepool --cluster=<cluster-name> --replicas=<number-nodes> <machinepool-name>
+----
++
+.Example input
++
+[source,terminal]
+----
+rosa edit machinepool --cluster=my-rosa-cluster --replicas 3 Default
+----
+
+. Run the following command to confirm that the machine pool has scaled:
++
+[source,terminal]
+----
+rosa describe cluster --cluster=<cluster-name> | grep Compute
+----
++
+.Example input
++
+[source,terminal]
+----
+$ rosa describe cluster --cluster=my-rosa-cluster | grep Compute
+----
++
+.Example output
++
+[source,terminal]
+----
+- Compute:                 3 (m5.xlarge)
+----
+
+=== Scaling worker nodes using the UI
+
+. Click the three dots to the right of the machine pool you want to edit.
+. Click *Edit*.
+. Enter the desired number of nodes, and click *Save*.
+. Confirm that the cluster has scaled by selecting the cluster, clicking the *Overview* tab, and scrolling to *Compute listing*. The compute listing should equal the scaled nodes. For example, 3/3.
++
+image::cloud-experts-getting-started-managing-ocm-nodes.png[]
+
+=== Adding node labels
+
+. Use the following command to add node labels:
++
+[source,terminal]
+----
+rosa edit machinepool --cluster=<cluster-name> --replicas=<number-nodes> --labels='key=value' <machinepool-name>
+----
++
+.Example input
++
+[source,terminal]
+----
+rosa edit machinepool --cluster=my-rosa-cluster --replicas=2 --labels 'foo=bar','baz=one' new-mp
+----
++
+This adds 2 labels to the new machine pool.
+
+[IMPORTANT]
+====
+This command replaces all machine pool configurations with the newly defined configuration. If you want to add another label *and* keep the old label, you must state both the new and preexisting the label. Otherwise the command will replace all preexisting labels with the one you wanted to add. Similarly, if you want to delete a label, run the command and state the ones you want, excluding the one you want to delete.
+====
+
+== Mixing node types
+
+You can also mix different worker node machine types in the same cluster by using new machine pools. You cannot change the node type of a machine pool once it is created, but you can create a new machine pool with different nodes by adding the `--instance-type` flag.
+
+. For example, to change the database nodes to a different node type, run the following command:
++
+[source,terminal]
+----
+rosa create machinepool --cluster=<cluster-name> --name=<mp-name> --replicas=<number-nodes> --labels='<key=pair>' --instance-type=<type>
+----
++
+.Example input
++
+[source,terminal]
+----
+rosa create machinepool --cluster=my-rosa-cluster --name=db-nodes-large-mp --replicas=2 --labels='app=db','tier=backend' --instance-type=m5.2xlarge
+----
+
+. To see all the xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-aws-instance-types_rosa-service-definition[instance types available], run the following command:
++
+[source,terminal]
+----
+rosa list instance-types
+----
+
+. To make step-by-step changes, use the `--interactive` flag:
++
+[source,terminal]
+----
+rosa create machinepool -c <cluster-name> --interactive
+----
++
+image::cloud-experts-getting-started-managing-mp-interactive.png[]
+
+. Run the following command to list the machine pools and see the new, larger instance type:
++
+[source,terminal]
+----
+rosa list machinepools -c <cluster-name>
+----
++
+image::cloud-experts-getting-started-managing-large-mp.png[]