Chapter 4. Nodes 4.1. About machine pools OpenShift Dedicated uses machine pools as an elastic, dynamic provisioning method on top of your cloud infrastructure. The primary resources are machines, machine sets, and machine pools. Important As of OpenShift Dedicated 4.11, the default per-pod PID limit is 4096 . If you want to enable this PID limit, you must upgrade your OpenShift Dedicated clusters to this version or later. OpenShift Dedicated clusters running versions earlier than 4.11 use a default PID limit of 1024 . You cannot configure the per-pod PID limit on any OpenShift Dedicated cluster. 4.1.1. Machines A machine is a fundamental unit that describes the host for a worker node. 4.1.2. 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. 4.1.3. Machine pools 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. By default, a cluster is created with one machine pool. You can add additional machine pools to an existing cluster, modify the default machine pool, and delete machine pools. Multiple machine pools can exist on a single cluster, and they can each have different types or different size nodes. 4.1.4. Machine pools in multiple zone clusters By default, when you create a machine pool in a multiple availability zone (Multi-AZ) cluster, that one machine pool has 3 zones. The machine pool, in turn, creates a total of 3 compute machine sets - one for each zone in the cluster. Each of those compute machine sets manages one or more machines in its respective availability zone. If you create a new Multi-AZ cluster, the machine pools are replicated to those zones automatically. If you add a machine pool to an existing Multi-AZ, the new pool is automatically created in those zones. Similarly, deleting a machine pool will delete it from all zones. Due to this multiplicative effect, using machine pools in Multi-AZ cluster can consume more of your project's quota for a specific region when creating machine pools. 4.1.4.1. Deploying a machine pool in a single availability zone within a Multi-AZ cluster OpenShift Dedicated on Google Cloud Platform (GCP) users can deploy a single machine pool in a specific availability zone that is part of a Multi-AZ cluster using the OpenShift Cluster Manager CLI ( ocm ). This option is especially useful in situations where a desired instance type is not available in all availability zones of a specific region as well as when your cluster does not need more than one of the desired instance types. Important You cannot assign the default machine pool to a single availability zone during the provisioning of a Multi-AZ cluster. Prerequisites You installed the OpenShift Cluster Manager API command-line interface ( ocm ) . Important OpenShift Cluster Manager API command-line interface ( ocm ) is a Developer Preview feature only. For more information about the support scope of Red Hat Developer Preview features, see Developer Preview Support Scope . Procedure Deploy a machine pool to a specific availability zone by running the following command: ocm create machine-pool \ --cluster <cluster_name|cluster_id> \ 1 --instance-type <instance_type> \ 2 --replicas <number_of_replicas> \ 3 --availability-zone <availability_zone> \ 4 [flags] \ 5 <machine_pool_id> 6 1 Replace <cluster_name|cluster_id> with the name or ID of the cluster that you want to add the machine pool to. 2 Replace <instance_type> with the instance type you want to deploy to the single availability zone. 3 Replace <replicas> with the number of replicas of the selected instance type you want to include in the machine pool. 4 Replace <availability_zone> with the availability zone you want to add the machine pool to. 5 Optional: Replace [flags] with any additional flags available for machine pool creation. 6 Replace <machine_pool_id> with an ID for your machine pool. Note To view the additional flags available for machine pool creation, run the ocm create machine-pool --help command. For more information about Google Cloud Platform (GCP) instance types and availability zones, see the Additional resources section. 4.1.5. Additional resources About autoscaling Google Cloud instance types Google Cloud regions and availability zones 4.2. Managing compute nodes This document describes how to manage compute (also known as worker) nodes with OpenShift Dedicated. 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. You can edit machine pool configuration options such as scaling, adding node labels, and adding taints. 4.2.1. Creating a machine pool A machine pool is created when you install an OpenShift Dedicated cluster. After installation, you can create additional machine pools for your cluster by using OpenShift Cluster Manager. Important The compute (also known as worker) node instance types, autoscaling options, and node counts that are available depend on your OpenShift Dedicated subscriptions, resource quotas and deployment scenario. For more information, contact your sales representative or Red Hat support. Prerequisites You created an OpenShift Dedicated cluster. Procedure Navigate to OpenShift Cluster Manager and select your cluster. Under the Machine pools tab, click Add machine pool . Add a Machine pool name . Select a Compute node instance type from the drop-down menu. The instance type defines the vCPU and memory allocation for each compute node in the machine pool. Note You cannot change the instance type for a machine pool after the pool is created. Optional: Configure autoscaling for the machine pool: Select Enable autoscaling to automatically scale the number of machines in your machine pool to meet the deployment needs. Note The Enable autoscaling option is only available for OpenShift Dedicated if you have the capability.cluster.autoscale_clusters subscription. For more information, contact your sales representative or Red Hat support. Set the minimum and maximum node count limits for autoscaling. The cluster autoscaler does not reduce or increase the machine pool node count beyond the limits that you specify. If you deployed your cluster using a single availability zone, set the Minimum and maximum node count . This defines the minimum and maximum compute node limits in the availability zone. If you deployed your cluster using multiple availability zones, set the Minimum nodes per zone and Maximum nodes per zone . This defines the minimum and maximum compute node limits per zone. Note Alternatively, you can set your autoscaling preferences for the machine pool after the machine pool is created. If you did not enable autoscaling, select a compute node count: If you deployed your cluster using a single availability zone, 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 zone. If you deployed your cluster using multiple availability zones, select a Compute node count (per zone) from the drop-down menu. This defines the number of compute nodes to provision to the machine pool per zone. 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. Under Taints , add Key and Value entries for your taints. Note Creating a machine pool with taints is only possible if the cluster already has at least one machine pool without a taint. For each taint, select an Effect from the drop-down menu. Available options include NoSchedule , PreferNoSchedule , and NoExecute . Note Alternatively, you can add the node labels and taints after you create the machine pool. 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. For more information, see the requirements for security groups in the "Additional resources" section. Optional: If you deployed OpenShift Dedicated on AWS using the Customer Cloud Subscription (CCS) model, use Amazon EC2 Spot Instances if you want to configure your machine pool to deploy machines as non-guaranteed AWS Spot Instances: Select Use Amazon EC2 Spot Instances . Leave Use On-Demand instance price selected to use the on-demand instance price. Alternatively, select Set maximum price to define a maximum hourly price for a Spot Instance. For more information about Amazon EC2 Spot Instances, see the AWS documentation . Important Your Amazon EC2 Spot Instances might be interrupted at any time. Use Amazon EC2 Spot Instances only for workloads that can tolerate interruptions. Note 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. 4.2.2. Deleting a machine pool You can delete a machine pool in the event that your workload requirements have changed and your current machine pools no longer meet your needs. You can delete machine pools using Red Hat OpenShift Cluster Manager. Prerequisites You have created an OpenShift Dedicated cluster. The cluster is in the ready state. You have an existing machine pool without any taints and with at least two replicas for a Single-AZ cluster or three replicas for a Multi-AZ cluster. Procedure From OpenShift Cluster Manager , navigate to the Cluster List page and select the cluster that contains the machine pool that you want to delete. On the selected cluster, select the Machine pools tab. Under the Machine pools tab, click the Options menu for the machine pool that you want to delete. Click Delete . The selected machine pool is deleted. 4.2.3. Scaling compute nodes manually If you have not enabled autoscaling for your machine pool, you can manually scale the number of compute (also known as worker) nodes in the pool to meet your deployment needs. You must scale each machine pool separately. Prerequisites You created an OpenShift Dedicated cluster. You have an existing machine pool. Procedure Navigate to OpenShift Cluster Manager and select your cluster. Under the Machine pools tab, click the Options menu for the machine pool that you want to scale. Select Scale . Specify the node count: If you deployed your cluster using a single availability zone, specify the Node count in the drop-down menu. If you deployed your cluster using multiple availability zones, specify the Node count per zone in the drop-down menu. Note Your subscription determines the number of nodes that you can select. Click Apply to scale the machine pool. Verification Under the Machine pools tab, verify that the Node count for your machine pool is as expected. 4.2.4. Node labels 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. Additional resources For more information about labels, see Kubernetes Labels and Selectors overview . For more information about custom additional security group requirements, see Additional custom security groups . 4.2.4.1. Adding node labels to a machine pool Add or edit labels for compute (also known as worker) nodes at any time to manage the nodes in a manner that is relevant to you. For example, you can assign types of workloads to specific nodes. Labels are assigned as key-value pairs. Each key must be unique to the object it is assigned to. Prerequisites You created an OpenShift Dedicated cluster. You have an existing machine pool. Procedure Navigate to OpenShift Cluster Manager and select your cluster. Under the Machine pools tab, click the Options menu 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 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. Repeat the step if you want to add additional labels. Click Save to apply the labels to the machine pool. Verification Under the Machine pools tab, select > to your machine pool to expand the view. Verify that your labels are listed under Labels in the expanded view. 4.2.5. Adding taints to a machine pool You can add taints for compute (also known as worker) nodes in a machine pool to control which pods are scheduled to them. When you apply a taint to a machine pool, the scheduler cannot place a pod on the nodes in the pool unless the pod specification includes a toleration for the taint. Note A cluster must have at least one machine pool that does not contain any taints. Prerequisites You created an OpenShift Dedicated cluster. You have an existing machine pool that does not contain any taints and contains at least two instances. Procedure Navigate to OpenShift Cluster Manager and select your cluster. Under the Machine pools tab, click the Options menu for the machine pool that you want to add a taint to. Select Edit taints . Add Key and Value entries for your taint. Select an Effect for your taint from the drop-down menu. Available options include NoSchedule , PreferNoSchedule , and NoExecute . Select Add taint if you want to add more taints to the machine pool. Click Save to apply the taints to the machine pool. Verification Under the Machine pools tab, select > to your machine pool to expand the view. Verify that your taints are listed under Taints in the expanded view. 4.2.6. Additional resources About machine pools Enabling autoscaling Disabling autoscaling OpenShift Dedicated service definition 4.3. About autoscaling nodes on a cluster Important Autoscaling is available only on clusters that were purchased through Google Cloud Marketplace and Red Hat Marketplace. The autoscaler option can be configured to automatically scale the number of machines in a cluster. The cluster autoscaler increases the size of the cluster when there are pods that failed to schedule on any of the current nodes due to insufficient resources or when another node is necessary to meet deployment needs. The cluster autoscaler does not increase the cluster resources beyond the limits that you specify. Additionally, the cluster autoscaler decreases the size of the cluster when some nodes are consistently not needed for a significant period, such as when it has low resource use and all of its important pods can fit on other nodes. When you enable autoscaling, you must also set a minimum and maximum number of worker nodes. Note Only cluster owners and organization admins can scale or delete a cluster. 4.3.1. Enabling autoscaling nodes on a cluster You can enable autoscaling on worker nodes to increase or decrease the number of nodes available by editing the machine pool definition for an existing cluster. Enabling autoscaling nodes in an existing cluster using Red Hat OpenShift Cluster Manager Enable autoscaling for worker nodes in the machine pool definition from OpenShift Cluster Manager console. Procedure From OpenShift Cluster Manager , navigate to the Cluster List page and select the cluster that you want to enable autoscaling for. On the selected cluster, select the Machine pools tab. Click the Options menu at the end of the machine pool that you want to enable autoscaling for and select Edit . On the Edit machine pool dialog, select the Enable autoscaling checkbox. Select Save to save these changes and enable autoscaling for the machine pool. 4.3.2. Disabling autoscaling nodes on a cluster You can disable autoscaling on worker nodes to increase or decrease the number of nodes available by editing the machine pool definition for an existing cluster. You can disable autoscaling on a cluster using OpenShift Cluster Manager console. Disabling autoscaling nodes in an existing cluster using Red Hat OpenShift Cluster Manager Disable autoscaling for worker nodes in the machine pool definition from OpenShift Cluster Manager. Procedure From OpenShift Cluster Manager , navigate to the Cluster List page and select the cluster with autoscaling that must be disabled. On the selected cluster, select the Machine pools tab. Click the Options menu at the end of the machine pool with autoscaling and select Edit . On the Edit machine pool dialog, deselect the Enable autoscaling checkbox. Select Save to save these changes and disable autoscaling from the machine pool. Applying autoscaling to an OpenShift Dedicated cluster involves deploying a cluster autoscaler and then deploying machine autoscalers for each machine type in your cluster. Important You can configure the cluster autoscaler only in clusters where the Machine API is operational. 4.3.3. About the cluster autoscaler The cluster autoscaler adjusts the size of an OpenShift Dedicated cluster to meet its current deployment needs. It uses declarative, Kubernetes-style arguments to provide infrastructure management that does not rely on objects of a specific cloud provider. The cluster autoscaler has a cluster scope, and is not associated with a particular namespace. The cluster autoscaler increases the size of the cluster when there are pods that fail to schedule on any of the current worker nodes due to insufficient resources or when another node is necessary to meet deployment needs. The cluster autoscaler does not increase the cluster resources beyond the limits that you specify. The cluster autoscaler computes the total memory and CPU on all nodes the cluster, even though it does not manage the control plane nodes. These values are not single-machine oriented. They are an aggregation of all the resources in the entire cluster. For example, if you set the maximum memory resource limit, the cluster autoscaler includes all the nodes in the cluster when calculating the current memory usage. That calculation is then used to determine if the cluster autoscaler has the capacity to add more worker resources. Important Ensure that the maxNodesTotal value in the ClusterAutoscaler resource definition that you create is large enough to account for the total possible number of machines in your cluster. This value must encompass the number of control plane machines and the possible number of compute machines that you might scale to. Automatic node removal Every 10 seconds, the cluster autoscaler checks which nodes are unnecessary in the cluster and removes them. The cluster autoscaler considers a node for removal if the following conditions apply: The node utilization is less than the node utilization level threshold for the cluster. The node utilization level is the sum of the requested resources divided by the allocated resources for the node. If you do not specify a value in the ClusterAutoscaler custom resource, the cluster autoscaler uses a default value of 0.5 , which corresponds to 50% utilization. The cluster autoscaler can move all pods running on the node to the other nodes. The Kubernetes scheduler is responsible for scheduling pods on the nodes. The cluster autoscaler does not have scale down disabled annotation. If the following types of pods are present on a node, the cluster autoscaler will not remove the node: Pods with restrictive pod disruption budgets (PDBs). Kube-system pods that do not run on the node by default. Kube-system pods that do not have a PDB or have a PDB that is too restrictive. Pods that are not backed by a controller object such as a deployment, replica set, or stateful set. Pods with local storage. Pods that cannot be moved elsewhere because of a lack of resources, incompatible node selectors or affinity, matching anti-affinity, and so on. Unless they also have a "cluster-autoscaler.kubernetes.io/safe-to-evict": "true" annotation, pods that have a "cluster-autoscaler.kubernetes.io/safe-to-evict": "false" annotation. For example, you set the maximum CPU limit to 64 cores and configure the cluster autoscaler to only create machines that have 8 cores each. If your cluster starts with 30 cores, the cluster autoscaler can add up to 4 more nodes with 32 cores, for a total of 62. Limitations If you configure the cluster autoscaler, additional usage restrictions apply: Do not modify the nodes that are in autoscaled node groups directly. All nodes within the same node group have the same capacity and labels and run the same system pods. Specify requests for your pods. If you have to prevent pods from being deleted too quickly, configure appropriate PDBs. Confirm that your cloud provider quota is large enough to support the maximum node pools that you configure. Do not run additional node group autoscalers, especially the ones offered by your cloud provider. Note The cluster autoscaler only adds nodes in autoscaled node groups if doing so would result in a schedulable pod. If the available node types cannot meet the requirements for a pod request, or if the node groups that could meet these requirements are at their maximum size, the cluster autoscaler cannot scale up. Interaction with other scheduling features The horizontal pod autoscaler (HPA) and the cluster autoscaler modify cluster resources in different ways. The HPA changes the deployment's or replica set's number of replicas based on the current CPU load. If the load increases, the HPA creates new replicas, regardless of the amount of resources available to the cluster. If there are not enough resources, the cluster autoscaler adds resources so that the HPA-created pods can run. If the load decreases, the HPA stops some replicas. If this action causes some nodes to be underutilized or completely empty, the cluster autoscaler deletes the unnecessary nodes. The cluster autoscaler takes pod priorities into account. The Pod Priority and Preemption feature enables scheduling pods based on priorities if the cluster does not have enough resources, but the cluster autoscaler ensures that the cluster has resources to run all pods. To honor the intention of both features, the cluster autoscaler includes a priority cutoff function. You can use this cutoff to schedule "best-effort" pods, which do not cause the cluster autoscaler to increase resources but instead run only when spare resources are available. Pods with priority lower than the cutoff value do not cause the cluster to scale up or prevent the cluster from scaling down. No new nodes are added to run the pods, and nodes running these pods might be deleted to free resources. 4.3.4. Additional resources About machinepools

Commands:
ocm create machine-pool --cluster <cluster_name|cluster_id> \ 1 --instance-type <instance_type> \ 2 --replicas <number_of_replicas> \ 3 --availability-zone <availability_zone> \ 4 [flags] \ 5 <machine_pool_id> 6