Merge pull request #62116 from eohartman/osdocs-5751

EricPonvelle · web-flow · commit c8e76b1fbef5 · 2023-08-31T11:34:43.000-04:00
OSDOCS-5751: Configuring machine pool disk volume.
diff --git a/modules/configuring-machine-pool-disk-volume-cli.adoc b/modules/configuring-machine-pool-disk-volume-cli.adoc
@@ -0,0 +1,38 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
+
+:_content-type: PROCEDURE
+[id="configuring_machine_pool_disk_volume_cli{context}"]
+= Configuring machine pool disk volume using the ROSA CLI
+
+.Prerequisite for cluster creation
+
+* You have the option to select the root disk sizing for the default machine pool during cluster installation.
+
+.Procedure for cluster creation
+
+* Run the following command when creating your OpenShift cluster for the desired root disk size:
++
+[source,terminal]
+----
+$ rosa create cluster --worker-disk-size=<disk_size>
+----
+The value can be in GB, GiB, TB, or TiB. Replace '<disk_size>' with a numeric value and unit, for example '--worker-disk-size=200GiB'. You cannot separate the digit and the unit. No spaces are allowed.
+
+.Prerequisite for machine pool creation
+
+* You have the option to select the root disk sizing for the new machine pool after the cluster has been installed.
+
+.Procedure for machine pool creation
+
+. Scale up the cluster by executing the following command:
++
+[source,terminal]
+----
+$ rosa create machinepool --cluster=<cluster_id>  <1>
+                          --disk-size=<disk_size>  <2>
+----
+<1> Specifies the ID or name of your existing OpenShift cluster
+<2> Specifies the worker node disk size. The value can be in GB, GiB, TB, or TiB. Replace '<disk_size>' with a numeric value and unit, for example '--disk-size=200GiB'. You cannot separate the digit and the unit. No spaces are allowed.
+. Confirm new machine pool disk volume size by logging into the AWS console and find the EC2 virtual machine root volume size.
diff --git a/modules/configuring-machine-pool-disk-volume-ocm.adoc b/modules/configuring-machine-pool-disk-volume-ocm.adoc
@@ -0,0 +1,36 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
+
+:_content-type: PROCEDURE
+ifdef::openshift-rosa[]
+[id="configuring_machine_pool_disk_volume_ocm{context}"]
+= Configuring machine pool disk volume using OpenShift Cluster Manager
+endif::openshift-rosa[]
+.Prerequisite for cluster creation
+* You have the option to select the node disk sizing for the default machine pool during cluster installation.
+
+.Procedure for cluster creation
+
+. From ROSA cluster wizard, navigate to Cluster settings.
+
+. Navigate to *Machine pool* step.
+
+. Select the desired *Root disk size*.
+
+. Select *Next* to continue creating your cluster.
+
+.Prerequisite for machine pool creation
+* You have the option to select the node disk sizing for the new machine pool after the cluster has been installed.
+
+.Procedure for machine pool creation
+
+. Navigate to {cluster-manager-url} and select your cluster.
+
+. Navigate to *Machine pool tab*.
+
+. Click *Add machine pool*.
+
+. Select the desired *Root disk size*.
+
+. Select *Add machine pool* to create the machine pool.
diff --git a/modules/configuring-machine-pool-disk-volume.adoc b/modules/configuring-machine-pool-disk-volume.adoc
@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// * rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
+
+:_content-type: CONCEPT
+[id="configuring_machine_pool_disk_volume{context}"]
+= Configuring machine pool disk volume
+
+Machine pool disk volume size can be configured for additional flexibility. The default disk size is 300 GiB. For cluster version 4.13 or earlier, the disk size can be configured to a minimum of 128 GiB to a maximum of 1 TiB. For cluster version 4.14 and later, the disk size can be configured to a minimum of 128 GiB to a maximum of 16 TiB.
+
+You can configure the machine pool disk size for your cluster by using {cluster-manager} or the ROSA CLI (`rosa`).
+
+[NOTE]
+====
+Existing cluster and machine pool node volumes cannot be resized.
+====
+
+
+[IMPORTANT]
+====
+The default disk size is 300 GiB. For cluster version 4.13 or earlier, the disk size can be configured to a minimum of 128 GiB to a maximum of 1 TiB. For cluster version 4.14 and later, the disk size can be configured to a minimum of 128 GiB to a maximum of 16 TiB.
+====
diff --git a/modules/creating-a-machine-pool-cli.adoc b/modules/creating-a-machine-pool-cli.adoc
@@ -28,6 +28,9 @@ $ rosa create machinepool --cluster=<cluster-name> \
                           --taints=<key>=<value>:<effect>,<key>=<value>:<effect> \ <5>
                           --use-spot-instances \ <6>
                           --spot-max-price=0.5 <7>
+ifdef::openshift-rosa[]
+                          --disk-size=<disk_size> \ <8>
+endif::openshift-rosa[]
 ----
 <1> Specifies the name of the machine pool. Replace `<machine_pool_id>` with the name of your machine pool.
 <2> Specifies the number of compute nodes to provision. If you deployed ROSA using a single availability zone, this defines the number of compute nodes to provision to the machine pool for the zone. If you deployed your cluster using multiple availability zones, this defines the number of compute nodes to provision in total across all zones and the count must be a multiple of 3. The `--replicas` argument is required when autoscaling is not configured.
@@ -36,6 +39,9 @@ $ rosa create machinepool --cluster=<cluster-name> \
 <5> Optional: Defines the taints for the machine pool. Replace `<key>=<value>:<effect>,<key>=<value>:<effect>` with a key, value, and effect for each taint, for example `--taints=key1=value1:NoSchedule,key2=value2:NoExecute`. Available effects include `NoSchedule`, `PreferNoSchedule`, and `NoExecute`.
 <6> Optional: Configures your machine pool to deploy machines as non-guaranteed AWS Spot Instances. For information, see link:https://aws.amazon.com/ec2/spot/[Amazon EC2 Spot Instances] in the AWS documentation. If you select *Use Amazon EC2 Spot Instances* for a machine pool, you cannot disable the option after the machine pool is created.
 <7> Optional: If you have opted to use Spot Instances, you can specify this argument to define a maximum hourly price for a Spot Instance. If this argument is not specified, the on-demand price is used.
+ifdef::openshift-rosa[]
+<8> Optional: Specifies the worker node disk size. The value can be in GB, GiB, TB, or TiB. Replace '<disk_size>' with a numeric value and unit, for example '--disk-size=200GiB'.
+endif::openshift-rosa[]
 +
 [IMPORTANT]
 ====
diff --git a/modules/creating-a-machine-pool-ocm.adoc b/modules/creating-a-machine-pool-ocm.adoc
@@ -79,7 +79,9 @@ Alternatively, you can set your autoscaling preferences for the machine pool aft
 . If you did not enable autoscaling, select a compute node count:
 * If you deployed your cluster using a single availability zone, select a *Worker node count* from the drop-down menu. This defines the number of compute nodes to provision to the machine pool for the zone.
 * If you deployed your cluster using multiple availability zones, select a *Worker node count (per zone)* from the drop-down menu. This defines the number of compute nodes to provision to the machine pool per zone.
-
+ifdef::openshift-rosa[]
+. Optional: Configure *Root disk size*.
+endif::openshift-rosa[]
 . Optional: Add node labels and taints for your machine pool:
 .. Expand the *Edit node labels and taints* menu.
 .. Under *Node labels*, add *Key* and *Value* entries for your node labels.
@@ -115,9 +117,9 @@ Your Amazon EC2 Spot Instances might be interrupted at any time. Use Amazon EC2
 ====
 If you select *Use Amazon EC2 Spot Instances* for a machine pool, you cannot disable the option after the machine pool is created.
 ====
-
 . Click *Add machine pool* to create the machine pool.
 
+
 .Verification
 
 * Verify that the machine pool is visible on the *Machine pools* page and the configuration is as expected.
diff --git a/modules/deleting-machine-pools-ocm.adoc b/modules/deleting-machine-pools-ocm.adoc
@@ -25,7 +25,7 @@ endif::openshift-rosa[]
 ifndef::openshift-rosa[]
 * You have created an {product-title} cluster.
 * The newly created cluster is in the ready state.
-endif::[]
+endif::openshift-rosa[]
 
 .Procedure
 . From {cluster-manager-url}, navigate to the *Clusters* page and select the cluster that contains the machine pool that you want to delete.
diff --git a/modules/rosa-nodes-machine-pools-local-zones.adoc b/modules/rosa-nodes-machine-pools-local-zones.adoc
@@ -56,6 +56,7 @@ I: Enabling interactive mode <1>
 ? Enable autoscaling (optional): No <6>
 ? Replicas: 2 <7>
 I: Fetching instance types <8>
+? disk-size (optional): <9>
 ----
 +
 
@@ -67,6 +68,7 @@ I: Fetching instance types <8>
 <6> Select yes to enable autoscaling or no to disable autoscaling.
 <7> Selects the number of machines for the machine pool. This number can be anywhere from 1 - 180.
 <8> Selects an instance type from the list. Only instance types that are supported in the selected Local Zone will appear.
+<9> Optional: Specifies the worker node disk size. The value can be in GB, GiB, TB, or TiB. Set a numeric value and unit, for example '200GiB'. You cannot separate the digit and the unit. No spaces are allowed.
 
 . Provide the subnet ID to provision the machine pool in the Local Zone.
 
diff --git a/modules/rosa-osd-node-label-about.adoc b/modules/rosa-osd-node-label-about.adoc
@@ -11,4 +11,3 @@
 A label is a key-value pair applied to a `Node` object. You can use labels to organize sets of objects and control the scheduling of pods.
 
 You can add labels during cluster creation or after. Labels can be modified or updated at any time.
-
diff --git a/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc b/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
@@ -5,6 +5,8 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
 :context: rosa-managing-worker-nodes
 toc::[]
 
+
+
 This document describes how to manage compute (also known as worker) nodes with {product-title} (ROSA).
 
 The majority of changes for compute nodes are configured on machine pools. A machine pool is a group of compute nodes in a cluster that have the same configuration, providing ease of management.
@@ -14,6 +16,9 @@ You can edit machine pool configuration options such as scaling, adding node lab
 include::modules/creating-a-machine-pool.adoc[leveloffset=+1]
 include::modules/creating-a-machine-pool-ocm.adoc[leveloffset=+2]
 include::modules/creating-a-machine-pool-cli.adoc[leveloffset=+2]
+include::modules/configuring-machine-pool-disk-volume.adoc[leveloffset=+1]
+include::modules/configuring-machine-pool-disk-volume-ocm.adoc[leveloffset=+2]
+include::modules/configuring-machine-pool-disk-volume-cli.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources

Original file line number	Diff line number	Diff line change
`@@ -11,4 +11,3 @@`
`11`	`11`	A label is a key-value pair applied to a `Node` object. You can use labels to organize sets of objects and control the scheduling of pods.
`12`	`12`
`13`	`13`	`You can add labels during cluster creation or after. Labels can be modified or updated at any time.`
`14`		`-`