Merge pull request #83964 from bhardesty/osdocs-11825-rosa-hcp

JoeAldinger · web-flow · commit 95fc7964bee0 · 2024-10-23T08:24:07.000-04:00
OSDOCS-11825: Add worker node disk size to ROSA HCP
diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml
@@ -159,8 +159,37 @@ Name: Cluster administration
 Dir: rosa_cluster_admin
 Distros: openshift-rosa-hcp
 Topics:
-- Name: Cluster configurations
+- Name: Cluster notifications
   File: rosa-cluster-notifications
+- Name: Configuring private connections
+  Dir: cloud_infrastructure_access
+  Topics:
+  - Name: Configuring private connections
+    File: rosa-configuring-private-connections
+  - Name: Configuring AWS VPC peering
+    File: dedicated-aws-peering
+  - Name: Configuring AWS VPN
+    File: dedicated-aws-vpn
+  - Name: Configuring AWS Direct Connect
+    File: dedicated-aws-dc
+# - Name: Cluster autoscaling  # Cluster autoscaling not supported on HCP
+#   File: rosa-cluster-autoscaling
+- Name: Manage nodes using machine pools
+  Dir: rosa_nodes
+  Topics:
+  - Name: About machine pools
+    File: rosa-nodes-machinepools-about
+  - Name: Managing compute nodes
+    File: rosa-managing-worker-nodes
+# Local zones not yet implemented in HCP
+    # - Name: Configuring machine pools in Local Zones
+    #   File: rosa-nodes-machinepools-configuring
+  - Name: About autoscaling nodes on a cluster
+    File: rosa-nodes-about-autoscaling-nodes
+  - Name: Configuring cluster memory to meet container memory and risk requirements
+    File: nodes-cluster-resource-configure
+- Name: Configuring PID limits
+  File: rosa-configuring-pid-limits
 ---
 Name: Security and compliance
 Dir: security
diff --git a/modules/configuring-machine-pool-disk-volume-cli.adoc b/modules/configuring-machine-pool-disk-volume-cli.adoc
@@ -35,4 +35,5 @@ $ rosa create machinepool --cluster=<cluster_id> \// <1>
 ----
 <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.adoc b/modules/configuring-machine-pool-disk-volume.adoc
@@ -8,9 +8,13 @@
 
 Machine pool disk volume size can be configured for additional flexibility. The default disk size is 300 GiB.
 
+ifdef::openshift-rosa[]
 For {rosa-classic-first} clusters version 4.13 or earlier, the disk size can be configured from a minimum of 128 GiB to a maximum of 1 TiB. For version 4.14 and later, the disk size can be configured to a minimum of 128 GiB to a maximum of 16 TiB.
+endif::openshift-rosa[]
 
-For {hcp-title-first} clusters, the disk size can be configured from a minimum of 75 GiB to a maximum of 16,384 GiB.
+ifdef::openshift-rosa-hcp[]
+For {product-title} clusters, the disk size can be configured from a minimum of 75 GiB to a maximum of 16,384 GiB.
+endif::openshift-rosa-hcp[]
 
 You can configure the machine pool disk size for your cluster by using {cluster-manager} or the ROSA CLI (`rosa`).
 
diff --git a/modules/creating-a-machine-pool-cli.adoc b/modules/creating-a-machine-pool-cli.adoc
diff --git a/modules/creating-a-machine-pool-ocm.adoc b/modules/creating-a-machine-pool-ocm.adoc
@@ -87,9 +87,9 @@ ifdef::openshift-rosa-hcp[]
 . If you did not enable autoscaling, select a *Compute node count* from the drop-down menu. This defines the number of compute nodes to provision to the machine pool for the availability zone.
 endif::openshift-rosa-hcp[]
 
-ifdef::openshift-rosa[]
+ifdef::openshift-rosa,openshift-rosa-hcp[]
 . Optional: Configure *Root disk size*.
-endif::openshift-rosa[]
+endif::openshift-rosa,openshift-rosa-hcp[]
 
 . Optional: Add node labels and taints for your machine pool:
 .. Expand the *Edit node labels and taints* menu.
@@ -109,7 +109,7 @@ Alternatively, you can add the node labels and taints after you create the machi
 
 ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 . Optional: Select additional custom security groups to use for nodes in this machine pool. You must have already created the security groups and associated them with the VPC that you selected for this cluster. You cannot add or edit security groups after you create the machine pool.
-// This can be added back once all of the files have been added to the ROSA HCP distro.
+// TODO: This can be added back once all of the files have been added to the ROSA HCP distro.
 ifndef::openshift-rosa-hcp[]
 For more information, see the requirements for security groups in the "Additional resources" section.
 endif::openshift-rosa-hcp[]
@@ -118,7 +118,7 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 ifdef::openshift-rosa-hcp[]
 [IMPORTANT]
 ====
-You can use up to ten additional security groups for machine pools on {hcp-title} clusters.
+You can use up to ten additional security groups for machine pools on {product-title} clusters.
 ====
 endif::openshift-rosa-hcp[]
 ifdef::openshift-dedicated[]
diff --git a/modules/creating-a-machine-pool.adoc b/modules/creating-a-machine-pool.adoc
@@ -10,4 +10,4 @@ A machine pool is created when you install a {product-title} (ROSA) cluster. Aft
 [NOTE]
 ====
 For users of ROSA CLI `rosa` version 1.2.25 and earlier versions, the machine pool created along with the cluster is identified as `Default`. For users of ROSA CLI  `rosa` version 1.2.26 and later, the machine pool created along with the cluster is identified as `worker`.
-====
+====
diff --git a/modules/rosa-adding-node-labels.adoc b/modules/rosa-adding-node-labels.adoc
@@ -160,6 +160,7 @@ Tags:
 Taints:                                
 Availability zone:             us-east-2a
 Subnet:                        subnet-0df2ec3377847164f
+Disk size:                     300 GiB
 Version:                       4.16.6
 EC2 Metadata Http Tokens:      optional
 Autorepair:                    Yes
@@ -183,7 +184,7 @@ ifdef::openshift-dedicated[]
 . Under the *Machine pools* tab, click the options menu {kebab} for the machine pool that you want to add a label to.
 . Select *Edit labels*.
 . If you have existing labels in the machine pool that you want to remove, select *x* next to the label to delete it.
-. Add a label using the format `<key>=<value>` and press enter. For example, add `app=db` and then press enter. If the format is correct, the key value pair is then highlighted.
+. Add a label using the format `<key>=<value>` and press enter. For example, add `app=db` and then press Enter. If the format is correct, the key value pair is then highlighted.
 . Repeat the previous step if you want to add additional labels.
 . Click *Save* to apply the labels to the machine pool.
 
diff --git a/modules/rosa-adding-taints-ocm.adoc b/modules/rosa-adding-taints-ocm.adoc
@@ -13,10 +13,10 @@ You can add taints to a machine pool for your {product-title} cluster by using {
 .Prerequisites
 
 ifndef::openshift-rosa,openshift-rosa-hcp[]
-* You created an OpenShift Dedicated cluster.
+* You created an {product-title} cluster.
 endif::[]
 ifdef::openshift-rosa,openshift-rosa-hcp[]
-* You created a {product-title} cluster.
+* You created a {product-title} (ROSA) cluster.
 endif::[]
 * You have an existing machine pool that does not contain any taints and contains at least two instances.
 
diff --git a/rosa_cluster_admin/rosa-cluster-notifications.adoc b/rosa_cluster_admin/rosa-cluster-notifications.adoc
@@ -12,9 +12,6 @@ ifdef::openshift-rosa,openshift-rosa-hcp[]
 [role="_additional-resources"]
 == Additional resources
 // TODO: Add this xref to ARO HCP.
-ifdef::openshift-rosa-hcp[]
-* link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.adoc#notifications_rosa-policy-responsibility-matrix[Customer responsibilities: Review and action cluster notifications]
-endif::openshift-rosa-hcp[]
 ifndef::openshift-rosa-hcp[]
 * xref:../rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.adoc#notifications_rosa-policy-responsibility-matrix[Customer responsibilities: Review and action cluster notifications]
 endif::openshift-rosa-hcp[]
@@ -57,7 +54,7 @@ include::modules/managed-cluster-remove-notification-contacts.adoc[leveloffset=+
 
 .If your cluster does not receive notifications
 * Ensure that your cluster can access resources at `api.openshift.com`.
-// Include this xref once all of the files have been added to the ROSA HCP distro.
+// TODO: Include this xref once all of the files have been added to the ROSA HCP distro.
 ifndef::openshift-rosa-hcp[]
 * Ensure that your firewall is configured according to the documented prerequisites: xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#osd-aws-privatelink-firewall-prerequisites_rosa-sts-aws-prereqs[AWS firewall prerequisites]
 endif::openshift-rosa-hcp[]
diff --git a/rosa_cluster_admin/rosa_nodes/rosa-hcp-managing-worker-nodes.adoc b/rosa_cluster_admin/rosa_nodes/rosa-hcp-managing-worker-nodes.adoc
diff --git a/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc b/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
@@ -13,22 +13,25 @@ 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]
 
-// This additional resource can be added back once all of the files are added to the ROSA HCP distro.
+// TODO: This additional resource can be added back once all of the files are added to the ROSA HCP distro.
+ifndef::openshift-rosa-hcp[]
 [role="_additional-resources"]
 .Additional resources
 * xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc#rosa-security-groups_prerequisites[Additional custom security groups]
+endif::openshift-rosa-hcp[]
 
-include::modules/creating-a-machine-pool-cli.adoc[leveloffset=+2]
-
-// This additional resource can be added back once all of the files are added to the ROSA HCP distro.
 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]
 
+// TODO: This additional resource can be added back once all of the files are added to the ROSA HCP distro.
+ifndef::openshift-rosa-hcp[]
 [role="_additional-resources"]
 .Additional resources
 * For a detailed list of the arguments that are available for the `rosa create machinepool` subcommand, see xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[Managing objects with the ROSA CLI].
+endif::openshift-rosa-hcp[]
 
 include::modules/deleting-machine-pools.adoc[leveloffset=+1]
 include::modules/deleting-machine-pools-ocm.adoc[leveloffset=+2]
@@ -42,24 +45,25 @@ include::modules/rosa-osd-node-label-about.adoc[leveloffset=+1]
 * For more information about labels, see link:https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/[Kubernetes Labels and Selectors overview].
 
 include::modules/rosa-adding-node-labels.adoc[leveloffset=+2]
-// include::modules/rosa-imds-machine-pools.adoc[leveloffset=+1]
-
-// [role="_additional-resources"]
-// .Additional resources
-
-// * For more information about Instance Metadata Service, see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html[Use IMDSv2] in the AWS documentation.
-
-// include::modules/rosa-imds-machine-pools-ui.adoc[leveloffset=+2]
-// include::modules/rosa-imds-machine-pools-cli.adoc[leveloffset=+2]
 include::modules/rosa-adding-tags.adoc[leveloffset=+1]
 include::modules/rosa-adding-tags-cli.adoc[leveloffset=+2]
 include::modules/rosa-adding-taints.adoc[leveloffset=+1]
 include::modules/rosa-adding-taints-ocm.adoc[leveloffset=+2]
 include::modules/rosa-adding-taints-cli.adoc[leveloffset=+2]
 
+ifdef::openshift-rosa-hcp[]
+include::modules/rosa-adding-tuning.adoc[leveloffset=+1]
+include::modules/rosa-node-drain-grace-period.adoc[leveloffset=+1]
+endif::openshift-rosa-hcp[]
+
 == Additional resources
 * xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc#rosa-nodes-machinepools-about[About machine pools]
 * xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc#rosa-nodes-about-autoscaling-nodes[About autoscaling]
 * xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc#rosa-nodes-about-autoscaling-nodes[Enabling autoscaling]
 * xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc#nodes-disabling-autoscaling-nodes[Disabling autoscaling]
-* xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-service-definition[{rosa-classic} Service Definition]
+ifdef::openshift-rosa[]
+* xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-service-definition[{rosa-classic} Service Definition]
+endif::openshift-rosa[]
+ifdef::openshift-rosa-hcp[]
+* xref:../../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-hcp-service-definition[{product-title} Service Definition]
+endif::openshift-rosa-hcp[]
diff --git a/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc b/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc
@@ -17,7 +17,7 @@ A machine is a fundamental unit that describes the host for a worker node.
 == Machine sets
 `MachineSet` resources are groups of compute machines. If you need more machines or must scale them down, change the number of replicas in the machine pool to which the compute machine sets belong.
 
-ifdef::openshift-rosa[]
+ifdef::openshift-rosa,openshift-rosa-hcp[]
 Machine sets are not directly modifiable in ROSA.
 endif::[]
 
@@ -27,7 +27,7 @@ Machine pools are a higher level construct to compute machine sets.
 A machine pool creates compute machine sets that are all clones of the same configuration across availability zones. Machine pools perform all of the host node provisioning management actions on a worker node. If you need more machines or must scale them down, change the number of replicas in the machine pool to meet your compute needs. You can manually configure scaling or set autoscaling.
 
 ifdef::openshift-rosa-hcp[]
-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.
+In {product-title} clusters, the hosted control plane spans three availability zones (AZ) in the installed cloud region. Each machine pool in a {product-title} cluster deploys in a single subnet within a single AZ. Each of these AZs can have only one machine pool.
 endif::openshift-rosa-hcp[]
 
 Multiple machine pools can exist on a single cluster, and each machine pool can contain a unique node type and node size configuration.
@@ -59,23 +59,22 @@ You cannot change the machine pool node type or size. The machine pool node type
 ifdef::openshift-rosa-hcp[]
 === Machine pool upgrade requirements
 
-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.
+Each machine pool in a {product-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.
 
-The following image depicts how machine pools work within ROSA and {hcp-title} clusters:
+The following image depicts how machine pools work within ROSA and {rosa-classic} clusters:
 
 image::hcp-rosa-machine-pools.png[Machine pools on ROSA classic and ROSA with HCP clusters]
 
 [NOTE]
 ====
-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.
+Machine pools in {product-title} clusters each upgrade independently and the machine pool versions must remain within two minor (Y-stream) versions of the control plane.
 ====
 endif::openshift-rosa-hcp[]
 
 ifndef::openshift-rosa-hcp[]
 == Machine pools in multiple zone clusters
 In a cluster created across multiple Availability Zones (AZ), the machine pools can be created across either all of the three AZs or any single AZ of your choice. The machine pool created by default at the time of cluster creation will be created with machines in all three AZs and scale in multiples of three.
 
-
 If you create a new Multi-AZ cluster, the machine pools are replicated to those zones automatically. By default, if you add a machine pool to an existing Multi-AZ cluster, the new machine pool is automatically created in all of the zones.
 
 [NOTE]
@@ -88,8 +87,6 @@ Due to this multiplicative effect, using machine pools in Multi-AZ cluster can c
 endif::openshift-rosa-hcp[]
 
 == Additional resources
-ifdef::openshift-rosa,openshift-rosa-hcp[]
 * xref:../../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing compute nodes]
-endif::[]
 * xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc#rosa-nodes-about-autoscaling-nodes[About autoscaling]
 * xref:../../rosa_cluster_admin/rosa-configuring-pid-limits.adoc#rosa-configuring-pid-limits[Configuring PID limits]

-Original file line number
+Diff line change
 [NOTE]
 ====
 For users of ROSA CLI `rosa` version 1.2.25 and earlier versions, the machine pool created along with the cluster is identified as `Default`. For users of ROSA CLI  `rosa` version 1.2.26 and later, the machine pool created along with the cluster is identified as `worker`.
 -====
 +====