Skip to content
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.

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

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

Merged
merged 1 commit into from
Sep 8, 2023

Conversation

@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 31, 2023
@openshift-ci openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 31, 2023
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Aug 31, 2023

🤖 Updated build preview is available at:
https://64189--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/24159

@mletalie mletalie changed the title Osdocs 7645 [OSDOCS-7645]: Remove Note Regarding Inability to Delete Default Machine Pool, other MP updates Aug 31, 2023
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 5, 2023
@bchandra-ocp
Copy link

https://64189--docspreview.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about#machine-pools -

  1. We need to update the list to reflect a) You can remove or add labels to any machine pool b) You can add taint to any machine pool as long as there is one machine pool without any taints c) You can create or delete a machine pool as long as there is one machine pool without any taints.
  2. "By default, a cluster has one machine pool. During cluster installation, you can label this machine pool. After the cluster is installed its node type or size cannot be changed." This needs to be corrected: "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."
  3. The NOTE in the box already covers for the fact that once created, machine pool can't be updated to change the node type or size.

https://64189--docspreview.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about#machine-pools-in-multiple-zone-clusters

The whole section starting with "When you create a machine pool..." can be simplified into following two sentences that help customer with the feature:

  1. In a cluster created across multiple Availability Zones (AZ), the machine pools can be created across either all 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 3 AZs and scale in multiples of 3.

https://64189--docspreview.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes

  1. What's the difference between two bullet points under 5 (b) "Set the minimum and maximum node count limits for autoscaling."? Perhaps, we need to say what are allowed minimums and allowed values (multiples of 3 in case of 3 AZs)?
  2. The NOTE about optionally configuring autoscaling is already covered by saying step 5 is Optional. Do we need that NOTE box?
  3. Step 7 to Optionally configure disk size must be expanded. It should include what's default, what's minimum and maximum values etc.
  4. Step 8: same comment about NOTE box. We can remove that since the step is Optional already
  5. Step 8 c: Needs a NOTE to call out that creating a machine pool with Taint will be possible only if the cluster already has a machine pool w/o taint.

@@ -86,6 +86,10 @@ 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.

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

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.

@@ -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. cannot be deleted. 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.
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.

Suggested change
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. cannot be deleted. 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.
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 cannot be deleted. 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 that contains no taints and at least two instances for a single-AZ cluster or three instances for a multi-AZ cluster.

* 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.

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 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.
* You can create or delete a machine pool as long as there is one machine pool without any taints.

Choose a reason for hiding this comment

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

Same with above

@xueli181114
Copy link

Any preview changes for OSD part?
Should we clarify about non-ccs cluster cannot delete/taints the default worker pool in the doc? Needs PM's confirmation

@xueli181114
Copy link

And per the preview file https://64189--docspreview.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes#rosa-managing-worker-nodes
It shows Worker node instance type but on UI it's Compute node instance type
And so do Worker node count should be Compute node count (per zone)

[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`.

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.

@xueli181114
Copy link

And per tuning config part
https://64189--docspreview.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes#rosa-adding-tuning_rosa-managing-worker-nodes
tuning config only work for hosted cluster, it's not highlighted
And commands output should be updated, there is no Default worker pool for hosted cluster.

@mletalie
Copy link
Contributor Author

mletalie commented Sep 8, 2023

https://64189--docspreview.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about#machine-pools -

  1. We need to update the list to reflect a) You can remove or add labels to any machine pool b) You can add taint to any machine pool as long as there is one machine pool without any taints c) You can create or delete a machine pool as long as there is one machine pool without any taints.
  2. "By default, a cluster has one machine pool. During cluster installation, you can label this machine pool. After the cluster is installed its node type or size cannot be changed." This needs to be corrected: "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."
  3. The NOTE in the box already covers for the fact that once created, machine pool can't be updated to change the node type or size.

https://64189--docspreview.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about#machine-pools-in-multiple-zone-clusters

The whole section starting with "When you create a machine pool..." can be simplified into following two sentences that help customer with the feature:

  1. In a cluster created across multiple Availability Zones (AZ), the machine pools can be created across either all 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 3 AZs and scale in multiples of 3.

https://64189--docspreview.netlify.app/openshift-rosa/latest/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes

  1. What's the difference between two bullet points under 5 (b) "Set the minimum and maximum node count limits for autoscaling."? Perhaps, we need to say what are allowed minimums and allowed values (multiples of 3 in case of 3 AZs)?
  2. The NOTE about optionally configuring autoscaling is already covered by saying step 5 is Optional. Do we need that NOTE box?
  3. Step 7 to Optionally configure disk size must be expanded. It should include what's default, what's minimum and maximum values etc.
  4. Step 8: same comment about NOTE box. We can remove that since the step is Optional already
  5. Step 8 c: Needs a NOTE to call out that creating a machine pool with Taint will be possible only if the cluster already has a machine pool w/o taint.

Addressed everything in this comment except #1, #2 and #3 in last section of comment. Outside the scope of the ticket, and this needs to get merged by 9/11/23. Will address these concerns in another ticket asap.

@mletalie
Copy link
Contributor Author

mletalie commented Sep 8, 2023

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Sep 8, 2023
@tmalove
Copy link
Contributor

tmalove commented Sep 8, 2023

/remove-label peer-review-needed
/label peer-review-in-progress

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Sep 8, 2023
@mletalie
Copy link
Contributor Author

mletalie commented Sep 8, 2023

Any preview changes for OSD part? Should we clarify about non-ccs cluster cannot delete/taints the default worker pool in the doc? Needs PM's confirmation

As far as I know, this will be addressed in another ticket. I will follow up with team/PR.

@@ -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 to you depend on your
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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

See SSG: https://redhat-documentation.github.io/supplementary-style-guide/#minimalism

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 prior versions, the machine pool created along with the cluster is identified as `Default`. For users of ROSA CLI `rosa` version 1.2.26 and beyond, the machine pool created along with the cluster is identified as `worker`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For users of ROSA CLI `rosa` version 1.2.25 and prior versions, the machine pool created along with the cluster is identified as `Default`. For users of ROSA CLI `rosa` version 1.2.26 and beyond, the machine pool created along with the cluster is identified as `worker`.
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,6 +7,11 @@
= 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 prior versions, the machine pool (ID='Default') created along with the cluster cannot be deleted. For users of ROSA CLI `rosa` version 1.2.26 and beyond, the machine pool (ID='worker') 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For users of ROSA CLI `rosa` version 1.2.25 and prior versions, the machine pool (ID='Default') created along with the cluster cannot be deleted. For users of ROSA CLI `rosa` version 1.2.26 and beyond, the machine pool (ID='worker') 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.
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.

Does 'AZ' modify 'cluster'? Should it be 'single AZ-cluster' and 'multi AZ-cluster'?

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.

Hi @tmalove, the hyphen looks to be where it should be; however, in doing some research on our docs and AWS docs, the majority of the time "M" in multi-AZ is capped. Same with "S" in single-AZ. so I am going to go with that. May need to be added to our style guide...thx.

.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.
Copy link
Contributor

Choose a reason for hiding this comment

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

See my earlier question about 'AZ-cluster'.

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.
For users of ROSA CLI `rosa` version 1.2.25 and earlier versions, the number of taints cannot be changed within the machine pool (ID=`Default`) that are created along with the cluster. For users of ROSA CLI `rosa` version 1.2.26 and later, the number of taints can be changed within the machine pool (ID=`worker`) that are 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.


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

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.

@tmalove
Copy link
Contributor

tmalove commented Sep 8, 2023

/remove-label peer-review-in-progress
/label peer-review-done

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Sep 8, 2023
@mletalie
Copy link
Contributor Author

mletalie commented Sep 8, 2023

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Sep 8, 2023
@EricPonvelle EricPonvelle merged commit 090505e into openshift:main Sep 8, 2023
@EricPonvelle
Copy link
Contributor

/cherrypick enterprise-4.13

@EricPonvelle
Copy link
Contributor

/cherrypick enterprise-4.14

@openshift-cherrypick-robot

@EricPonvelle: new pull request created: #64541

In response to this:

/cherrypick enterprise-4.13

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@EricPonvelle: new pull request created: #64542

In response to this:

/cherrypick enterprise-4.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.13 branch/enterprise-4.14 merge-review-needed Signifies that the merge review team needs to review this PR peer-review-done Signifies that the peer review team has reviewed this PR size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants