mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
191 lines
11 KiB
Plaintext
191 lines
11 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc
|
|
// * nodes/rosa-managing-worker-nodes.adoc
|
|
// * osd_cluster_admin/osd_nodes/osd-managing-worker-nodes.adoc
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="creating_machine_pools_ocm_{context}"]
|
|
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
|
= Creating a machine pool
|
|
|
|
endif::openshift-rosa,openshift-rosa-hcp[]
|
|
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
|
= Creating a machine pool using OpenShift Cluster Manager
|
|
|
|
endif::openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
[role="_abstract"]
|
|
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
|
A machine pool is created when you install an {product-title} cluster. After installation, you can create additional machine pools for your cluster by using {cluster-manager}.
|
|
endif::openshift-rosa,openshift-rosa-hcp[]
|
|
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
|
You can create additional machine pools for your {product-title} cluster by using {cluster-manager}.
|
|
endif::openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
|
[IMPORTANT]
|
|
====
|
|
The compute (also known as worker) node instance types, autoscaling options, and node counts that are available depend on your
|
|
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
|
{product-title}
|
|
endif::openshift-rosa,openshift-rosa-hcp[]
|
|
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
|
{product-title}
|
|
endif::[]
|
|
subscriptions, resource quotas and deployment scenario. For more information, contact your sales representative or Red{nbsp}Hat support.
|
|
====
|
|
endif::openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
.Prerequisites
|
|
|
|
ifdef::openshift-rosa,openshift-rosa-hcp[]
|
|
* You created a {product-title} cluster.
|
|
endif::openshift-rosa,openshift-rosa-hcp[]
|
|
ifndef::openshift-rosa,openshift-rosa-hcp[]
|
|
* You created an {product-title} cluster.
|
|
endif::openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
.Procedure
|
|
|
|
. Navigate to {cluster-manager-url} 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 list. 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.
|
|
====
|
|
ifdef::openshift-rosa-hcp[]
|
|
. Optional: If you are using {VirtProductName} on a {product-title} cluster, you might want to run Windows VMs. In order to be license-compliant with Microsoft Windows in AWS, the hosts (x86-64 bare metal EC2 instances) running these VMs must be enabled with AWS EC2 Windows License Included. To enable the machine pool for AWS Windows License Included, select the *Enable machine pool for AWS Windows License Included* checkbox.
|
|
+
|
|
You can only select this option when the host cluster is a {product-title} cluster version 4.19 and later and the instance type is x86-64 bare metal EC2.
|
|
+
|
|
[IMPORTANT]
|
|
====
|
|
Enabling AWS Windows LI on a machine pool applies the associated licensing fees on that specific machine pool. This includes billing for the full vCPU allocation of each AWS Windows LI enabled host in your {product-title} cluster. Windows LI enabled machine pools will also deny vCPU over-allocation on {VirtProductName} VMs. For more information, see link:https://aws.amazon.com/windows/resources/licensing//[Microsoft Licensing on AWS] and the link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/introduction_to_rosa/policies-and-service-definition#rosa-hcp-instance-types[{product-title} instance types].
|
|
====
|
|
endif::openshift-rosa-hcp[]
|
|
. 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.
|
|
ifdef::openshift-dedicated[]
|
|
+
|
|
[NOTE]
|
|
====
|
|
The *Enable autoscaling* option is only available for {product-title} if you have the `capability.cluster.autoscale_clusters` subscription. For more information, contact your sales representative or Red{nbsp}Hat support.
|
|
====
|
|
endif::openshift-dedicated[]
|
|
.. 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.
|
|
ifndef::openshift-rosa-hcp[]
|
|
** 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.
|
|
endif::openshift-rosa-hcp[]
|
|
+
|
|
[NOTE]
|
|
====
|
|
Alternatively, you can set your autoscaling preferences for the machine pool after the machine pool is created.
|
|
====
|
|
|
|
ifdef::openshift-dedicated,openshift-rosa[]
|
|
. 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.
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
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,openshift-rosa-hcp[]
|
|
. Optional: Configure *Root disk size*.
|
|
endif::openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
ifdef::openshift-rosa-hcp[]
|
|
. Optional: Add reserved capacity to your machine pool.
|
|
.. Select a *Reservation Preference* from the list. Valid preferences include:
|
|
... *None*: The instance does not use a Capacity Reservation even if one is available. The instance runs as an EC2 On-Demand instance. Choose this option when you want to avoid consuming purchased reserved capacity and use it for other workloads.
|
|
... *Open*: The instance can run in any `open` Capacity Reservation that has matching attributes such as the instance type, platform, AZ, or tenancy. Choose this option for flexibility; if a reservation is not available, the instance can use regular unreserved EC2 capacity.
|
|
... *CR only* (capacity reservation only): The instance can only run in a Capacity Reservation. If capacity is not available, the instance fails to launch.
|
|
.. Add a *Reservation ID*. You get an ID in the `cr-<capacity_reservation_id>` format when you purchase a Capacity Reservation from AWS. The ID can be for both On-Demand Capacity Reservations or Capacity Blocks for ML.
|
|
endif::openshift-rosa-hcp[]
|
|
|
|
. 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.
|
|
====
|
|
|
|
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.
|
|
// 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[]
|
|
+
|
|
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 {product-title} clusters.
|
|
====
|
|
endif::openshift-rosa-hcp[]
|
|
ifdef::openshift-dedicated[]
|
|
. Optional: If you deployed {product-title} 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 link:https://aws.amazon.com/ec2/spot/[AWS documentation].
|
|
endif::openshift-dedicated[]
|
|
ifdef::openshift-rosa[]
|
|
. Optional: 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 link:https://aws.amazon.com/ec2/spot/[AWS documentation].
|
|
endif::openshift-rosa[]
|
|
ifndef::openshift-rosa-hcp[]
|
|
+
|
|
[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.
|
|
====
|
|
+
|
|
endif::openshift-rosa-hcp[]
|
|
ifdef::openshift-dedicated[]
|
|
. Optional: By default, {product-title} on {GCP} instances in the machine pools inherit the Shielded VM settings at the cluster level. You can override the cluster level Shielded VM settings at the machine pool level by selecting or clearing the *Enable Secure Boot support for Shielded VMs* checkbox.
|
|
+
|
|
[IMPORTANT]
|
|
====
|
|
Once a machine pool is created, the *Enable Secure Boot support for Shielded VMs* setting cannot be changed.
|
|
====
|
|
+
|
|
[IMPORTANT]
|
|
====
|
|
*Enable Secure Boot support for Shielded VMs* is not supported for {product-title} on {GCP} clusters created using bare-metal instance types. For more information, see link:https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#limitations[Limitations] in the {GCP} documentation.
|
|
====
|
|
endif::openshift-dedicated[]
|
|
+
|
|
. 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.
|