Skip to content

[OSDOCS-7645]: Remove Note Regarding Inability to Delete Default Machine Pool, other MP updates #64189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 8, 2023
Merged

[OSDOCS-7645]: Remove Note Regarding Inability to Delete Default Machine Pool, other MP updates #64189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions modules/creating-a-machine-pool-ocm.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ifdef::openshift-rosa[]
endif::openshift-rosa[]

ifndef::openshift-rosa[]
A default 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}.
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[]
ifdef::openshift-rosa[]
You can create additional machine pools for your {product-title} (ROSA) cluster by using {cluster-manager}.
Expand All @@ -23,12 +23,12 @@ endif::openshift-rosa[]
ifndef::openshift-rosa[]
[IMPORTANT]
====
The compute (also known as worker) node instance types, autoscaling options, and node counts that are available to you depend on your
The compute (also known as worker) node instance types, autoscaling options, and node counts that are available depend on your
ifdef::openshift-rosa[]
ROSA
ROSA
endif::openshift-rosa[]
ifndef::openshift-rosa[]
{product-title}
{product-title}
endif::[]
subscriptions, resource quotas and deployment scenario. For more information, contact your sales representative or Red Hat support.
====
Expand Down Expand Up @@ -86,6 +86,11 @@ endif::openshift-rosa[]
.. 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.
Copy link

@xueli181114 xueli181114 Sep 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm... In theory a cluster will always to have a machinepool without taint. So customer can create machinepool with taint anytime.

Copy link
Contributor Author

@mletalie mletalie Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xueli181114, Good point. That being said, I will leave it in for now as it was a directive (and is while technically a given, is also factual). Will see if there is any other input to remove. Thx.

====
.. For each taint, select an *Effect* from the drop-down menu. Available options include `NoSchedule`, `PreferNoSchedule`, and `NoExecute`.
Copy link

@xueli181114 xueli181114 Sep 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Above highlight message make this line wrapped as another charactered list which starts with a again.

+
[NOTE]
Expand Down
6 changes: 5 additions & 1 deletion modules/creating-a-machine-pool.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,8 @@
[id="creating_a_machine_pool_{context}"]
= Creating a machine pool

A default machine pool is created when you install a {product-title} (ROSA) cluster. After installation, you can create additional machine pools for your cluster by using {cluster-manager} or the ROSA CLI (`rosa`).
A machine pool is created when you install a {product-title} (ROSA) cluster. After installation, you can create additional machine pools for your cluster by using {cluster-manager} or the ROSA CLI (`rosa`).
[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`.
====
7 changes: 6 additions & 1 deletion modules/deleting-machine-pools-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,17 @@
= Deleting a machine pool using the ROSA CLI
You can delete a machine pool for your Red Hat OpenShift Service on AWS (ROSA) cluster by using the ROSA CLI.

[NOTE]
====
For users of ROSA CLI `rosa` version 1.2.25 and earlier versions, the machine pool (ID='Default') that is created along with the cluster cannot be deleted. For users of ROSA CLI `rosa` version 1.2.26 and later, the machine pool (ID='worker') that is created along with the cluster can be deleted as long as there is one machine pool within the cluster that contains no taints, and at least two replicas for a Single-AZ cluster or three replicas for a Multi-AZ cluster.
====

.Prerequisites

ifdef::openshift-rosa[]
* You created a ROSA cluster.
* The cluster is in the ready state.
* You have an existing machine pool without any taints and with at least two instances for a single-AZ cluster or three instances for a multi-AZ cluster.
* You have an existing machine pool without any taints and with at least two instances for a Single-AZ cluster or three instances for a Multi-AZ cluster.
endif::openshift-rosa[]
ifndef::openshift-rosa[]
* You have created an {product-title} cluster.
Expand Down
14 changes: 3 additions & 11 deletions modules/deleting-machine-pools.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
= 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.
// Over time, users may find that their workload needs have changed, and may want to modify the various machine pool settings. While many of these settings can be modified, certain settings (for example, instance types and availability zones) cannot be changed once a machine pool is created. If a user finds that these settings are no longer meeting their needs, they can delete the machine pool in question and create a new machine pool with the desired settings.


You can delete machine pools using the
ifdef::openshift-rosa[]
Expand All @@ -16,21 +16,13 @@ endif::openshift-rosa[]
ifndef::openshift-rosa[]
Openshift Cluster Manager.
endif::[]

[NOTE]
====
The default machine pool cannot be deleted.
====

// Users that wish to delete the default machine pool that is automatically created during the installation of a {product-title} (ROSA) cluster can do so using the OCM or ROSA CLI.
//

ifndef::openshift-rosa[]

.Prerequisites

* You have created an {product-title} cluster.
* The cluster is in the ready state.
* You have an existing machine pool without any taints and with at least two instances for a single-AZ cluster or three instances for a multi-AZ cluster.
* 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 {cluster-manager-url}, navigate to the *Clusters* page and select the cluster that contains the machine pool that you want to delete.
Expand Down
4 changes: 4 additions & 0 deletions modules/rosa-adding-taints-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@

You can add taints to a machine pool for your Red Hat OpenShift Service on AWS (ROSA) cluster by using the ROSA CLI.

[NOTE]
====
For users of ROSA CLI `rosa` version 1.2.25 and prior versions, the number of taints cannot be changed within the machine pool (ID=`Default`) created along with the cluster. For users of ROSA CLI `rosa` version 1.2.26 and beyond, the number of taints can be changed within the machine pool (ID=`worker`) created along with the cluster. There must be at least one machine pool without any taints and with at least two replicas for a Single-AZ cluster or three replicas for a Multi-AZ cluster.
====
.Prerequisites

ifdef::openshift-rosa[]
Expand Down
10 changes: 6 additions & 4 deletions rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,24 +27,26 @@ 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 has one machine pool. During cluster installation, you can label this machine pool. After the cluster is installed, the `Default` machine pool cannot be deleted, and its node type or size cannot be changed.
By default, a cluster has one machine pool. During cluster installation, you can define instance type or size and add labels to this machine pool.

After a cluster's installation:

* You can relabel a `Default` machine pool.
* You can remove or add labels to any machine pool.
* You can add additional machine pools to an existing cluster.
* You can add taints to any machine pool as long as there is one machine pool without any taints.
Copy link

@xueli181114 xueli181114 Sep 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The machinepool should at the same time have untaint 2(for single zone) and 3(for multi zone) replicas

lixue@Xue-Lis-MacBook-Pro ~ % rosa edit machinepool worker -c sdq-ci-twppd --taints kwy=value:NoSchedule
E: Failed to update machine pool 'worker' on cluster 'sdq-ci-twppd': Machine pool 'worker' for cluster '263hpcg0hqb5v4qkp94taut6rnn4apat' can't be updated with provided params. At least one machine pool able to run OCP workload is required. Pool should not have taints and minimum replica count should be '2'
lixue@Xue-Lis-MacBook-Pro ~ % rosa list machinepools -c sdq-ci-twppd                                   
ID      AUTOSCALING  REPLICAS  INSTANCE TYPE  LABELS                                                                TAINTS    AVAILABILITY ZONES                    SUBNETS                                                                         SPOT INSTANCES  DISK SIZE  
sz1     No           1         m5.xlarge                                                                                      us-west-2b                            subnet-02c45e21191037c15                                                        No              300 GiB
worker  Yes          3-6       m5.xlarge      label1/openshift.com=labelvalue1, label2/openshift.com=labelvalue2              us-west-2a, us-west-2b, us-west-2c    subnet-0bc1a548e9a8b46e1, subnet-02c45e21191037c15, subnet-09416be08e29bd88c    No              150 GiB

* You can create or delete a machine pool as long as there is one machine pool without any taints and at least two replicas for a Single-AZ cluster or three replicas for a Multi-AZ cluster.
+
[NOTE]
====
You cannot change the machine pool node type or size. The machine pool node type or size is specified during their creation only. If you need a different node type or size, you must re-create a machine pool and specify the required node type or size values.
====
* You can add a label to each added machine pool.
* You cannot delete the `Default` machine pool. However, you can delete the non-default machine pools.

Multiple machine pools can exist on a single cluster, and each machine pool can contain a unique node type and node size configuration.

== Machine pools in multiple zone clusters
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.
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.
Copy link
Contributor

@tmalove tmalove Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
In a cluster that is 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. 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.
Expand Down