-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSDOCS-13951: collapse managing compute dir #91474
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
Merged
jeana-redhat
merged 1 commit into
openshift:ocp-docs-cluster_infra_reorg
from
jeana-redhat:OSDOCS-13951-collapse-managing-compute-dir
Apr 15, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 9 additions & 9 deletions
18
...machines/manually-scaling-machineset.adoc → ...d_topics/manually-scaling-machineset.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,29 @@ | ||
:_mod-docs-content-type: ASSEMBLY | ||
[id="manually-scaling-machineset"] | ||
= Manually scaling a compute machine set | ||
include::_attributes/common-attributes.adoc[] | ||
// include::_attributes/common-attributes.adoc[] | ||
:context: manually-scaling-machineset | ||
|
||
toc::[] | ||
|
||
You can add or remove an instance of a machine in a compute machine set. | ||
|
||
[NOTE] | ||
==== | ||
If you need to modify aspects of a compute machine set outside of scaling, see xref:../../../machine_management/compute_machine_management/mapi_compute_managing_machines/modifying-machineset.adoc#modifying-machineset[Modifying a compute machine set]. | ||
==== | ||
// [NOTE] | ||
// ==== | ||
// If you need to modify aspects of a compute machine set outside of scaling, see xref:../../../machine_management/compute_machine_management/mapi_compute_managing_machines/modifying-machineset.adoc#modifying-machineset[Modifying a compute machine set]. | ||
// ==== | ||
|
||
== Prerequisites | ||
|
||
* If you enabled the cluster-wide proxy and scale up compute machines not included in `networking.machineNetwork[].cidr` from the installation configuration, you must xref:../../../networking/enable-cluster-wide-proxy.adoc#nw-proxy-configure-object_config-cluster-wide-proxy[add the compute machines to the Proxy object's `noProxy` field] to prevent connection issues. | ||
|
||
include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] | ||
// include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] | ||
|
||
include::modules/machineset-manually-scaling.adoc[leveloffset=+1] | ||
// include::modules/mapi-compute-scaling.adoc[leveloffset=+1] | ||
|
||
include::modules/machineset-delete-policy.adoc[leveloffset=+1] | ||
// include::modules/machineset-delete-policy.adoc[leveloffset=+1] | ||
|
||
[role="_additional-resources"] | ||
[id="additional-resources_manually-scaling-machineset"] | ||
== Additional resources | ||
* xref:../../../machine_management/manual_machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase] | ||
// * xref:../../../machine_management/manual_machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
:_mod-docs-content-type: ASSEMBLY | ||
[id="modifying-machineset"] | ||
= Modifying a compute machine set | ||
// include::_attributes/common-attributes.adoc[] | ||
:context: modifying-machineset | ||
|
||
toc::[] | ||
|
||
You can modify a compute machine set, such as adding labels, changing the instance type, or changing block storage. | ||
|
||
// [NOTE] | ||
// ==== | ||
// If you need to scale a compute machine set without making other changes, see xref:../../../machine_management/compute_machine_management/mapi_compute_managing_machines/manually-scaling-machineset.adoc#manually-scaling-machineset[Manually scaling a compute machine set]. | ||
// ==== | ||
|
||
//Updating compute machine configurations | ||
//tags exclude CAPI, leaving untagged + MAPI | ||
// include::modules/mapi-compute-config-updating-cli.adoc[leveloffset=+1,tag=!CAPI] | ||
|
||
[role="_additional-resources"] | ||
.Additional resources | ||
// * xref:../../../machine_management/manual_machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase] | ||
// * xref:../../../machine_management/compute_machine_management/mapi_compute_managing_machines/manually-scaling-machineset.adoc#machineset-manually-scaling_manually-scaling-machineset[Scaling a compute machine set manually] | ||
// * xref:../../../nodes/scheduling/nodes-scheduler-about.adoc#nodes-scheduler-about[Controlling pod placement using the scheduler] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 29 additions & 2 deletions
31
machine_management/compute_machine_management/mapi-compute-managing-machines.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,36 @@ | ||
:_mod-docs-content-type: ASSEMBLY | ||
[id="mapi-compute-managing-machines"] | ||
= Managing control plane machines with control plane machine sets | ||
= Managing compute machines with compute machine sets | ||
include::_attributes/common-attributes.adoc[] | ||
:context: mapi-compute-managing-machines | ||
|
||
toc::[] | ||
|
||
Placeholder assembly. | ||
Machine API compute machine sets automate several essential aspects of compute machine management. | ||
|
||
include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] | ||
|
||
//Updating compute machine configurations | ||
//tags exclude CAPI, leaving untagged + MAPI | ||
include::modules/mapi-compute-config-updating-cli.adoc[leveloffset=+1,tag=!CAPI] | ||
|
||
[role="_additional-resources"] | ||
.Additional resources | ||
* xref:../../nodes/scheduling/nodes-scheduler-about.adoc#nodes-scheduler-about[Controlling pod placement using the scheduler] | ||
|
||
//Manually scaling a compute machine set | ||
include::modules/mapi-compute-scaling.adoc[leveloffset=+1] | ||
|
||
[role="_additional-resources"] | ||
.Additional resources | ||
* xref:../../networking/enable-cluster-wide-proxy.adoc#nw-proxy-configure-object_config-cluster-wide-proxy[Enabling the cluster-wide proxy] | ||
|
||
//The compute machine set deletion policy | ||
include::modules/machineset-delete-policy.adoc[leveloffset=+1] | ||
|
||
[role="_additional-resources"] | ||
[id="additional-resources_{context}"] | ||
== Additional resources | ||
* xref:../../machine_management/manual_machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase] | ||
* Compute machine set configuration | ||
* Provider-specific configuration options |
24 changes: 0 additions & 24 deletions
24
...ute_machine_management/mapi_compute_managing_machines/modifying-machineset.adoc
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,39 @@ | ||
// Module included in the following assemblies: | ||
// | ||
// * machine_management/compute_machine_management/mapi_compute_managing_machines/manually-scaling-machineset.adoc | ||
// * machine_management/compute_machine_management/mapi-compute-managing-machines.adoc | ||
// * post_installation_configuration/cluster-tasks.adoc | ||
// * post_installation_configuration/node-tasks.adoc | ||
// * windows_containers/scheduling-windows-workloads.adoc | ||
|
||
:_mod-docs-content-type: PROCEDURE | ||
[id="machineset-manually-scaling_{context}"] | ||
= Scaling a compute machine set manually | ||
[id="mapi-compute-scaling_{context}"] | ||
= Manually scaling a compute machine set | ||
|
||
To add or remove an instance of a machine in a compute machine set, you can manually scale the compute machine set. | ||
|
||
This guidance is relevant to fully automated, installer-provisioned infrastructure installations. Customized, user-provisioned infrastructure installations do not have compute machine sets. | ||
ifeval::["{context}" != "mapi-compute-managing-machines"] | ||
include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] | ||
endif::[] | ||
|
||
.Prerequisites | ||
|
||
* Install an {product-title} cluster and the `oc` command line. | ||
* Install an {product-title} cluster and the {oc-first}. | ||
* Log in to `oc` as a user with `cluster-admin` permission. | ||
* If have you enabled the cluster-wide proxy, you must add any compute machines that are not included in the `networking.machineNetwork[].cidr` field in the installation configuration file to the `noProxy` field in the `Proxy` object before scaling them up to prevent connection issues. | ||
For more information, see "Enabling the cluster-wide proxy". | ||
Comment on lines
+22
to
+23
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This used to be outside the normal Prerequisites section, moved it in with the other two |
||
|
||
.Procedure | ||
|
||
. View the compute machine sets that are in the cluster by running the following command: | ||
. List the compute machine sets that are in the cluster by running the following command: | ||
+ | ||
[source,terminal] | ||
---- | ||
$ oc get machinesets.machine.openshift.io -n openshift-machine-api | ||
---- | ||
+ | ||
The compute machine sets are listed in the form of `<clusterid>-worker-<aws-region-az>`. | ||
The compute machine sets are listed in the form of `<cluster_id>-worker-<region>`. | ||
|
||
. View the compute machines that are in the cluster by running the following command: | ||
. List the compute machines that are in the cluster by running the following command: | ||
+ | ||
[source,terminal] | ||
---- | ||
|
@@ -39,21 +44,24 @@ $ oc get machines.machine.openshift.io -n openshift-machine-api | |
+ | ||
[source,terminal] | ||
---- | ||
$ oc annotate machines.machine.openshift.io/<machine_name> -n openshift-machine-api machine.openshift.io/delete-machine="true" | ||
$ oc annotate machines.machine.openshift.io/<machine_name> \ | ||
-n openshift-machine-api machine.openshift.io/delete-machine="true" | ||
---- | ||
|
||
. Scale the compute machine set by running one of the following commands: | ||
+ | ||
[source,terminal] | ||
---- | ||
$ oc scale --replicas=2 machinesets.machine.openshift.io <machineset> -n openshift-machine-api | ||
$ oc scale --replicas=2 machinesets.machine.openshift.io <machineset> \ | ||
-n openshift-machine-api | ||
---- | ||
+ | ||
Or: | ||
+ | ||
[source,terminal] | ||
---- | ||
$ oc edit machinesets.machine.openshift.io <machineset> -n openshift-machine-api | ||
$ oc edit machinesets.machine.openshift.io <machineset> \ | ||
-n openshift-machine-api | ||
---- | ||
+ | ||
[TIP] | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replaces this one-off line with the warning we have that talks about this issue. Excluded it from the
mapi-compute-managing-machines
page because it already appears at the top of that page.