Skip to content

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 8 additions & 6 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2375,12 +2375,14 @@ Topics:
# - Name: Getting started with compute machine sets
# File: mapi-compute-getting-started
- Name: Managing compute machines with compute machine sets
Dir: mapi_compute_managing_machines
Topics:
- Name: Manually scaling a compute machine set
File: manually-scaling-machineset
- Name: Modifying a compute machine set
File: modifying-machineset
File: mapi-compute-managing-machines
# - Name: Managing compute machines with compute machine sets
# Dir: mapi_compute_managing_machines
# Topics:
# - Name: Manually scaling a compute machine set
# File: manually-scaling-machineset
# - Name: Modifying a compute machine set
# File: modifying-machineset
# - Name: Compute machine set configuration
# File: mapi-compute-configuration
# - Name: Configuration options for compute machines
Expand Down
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]
24 changes: 24 additions & 0 deletions _unused_topics/modifying-machineset.adoc
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]
2 changes: 1 addition & 1 deletion installing/installing_nutanix/nutanix-failure-domains.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ include::modules/post-installation-adding-nutanix-failure-domains-compute-machin

[role="_additional-resources"]
.Additional resources
* xref:../../machine_management/compute_machine_management/mapi_compute_managing_machines/modifying-machineset.adoc#modifying-machineset[Modifying a compute machine set]
* xref:../../machine_management/compute_machine_management/mapi-compute-managing-machines.adoc#mapi-compute-config-updating-cli_mapi-compute-managing-machines[Updating compute machine configurations]

include::modules/post-installation-adding-nutanix-failure-domains-compute-machines-replace.adoc[leveloffset=+3]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ include::modules/capi-modifying-machine-template.adoc[leveloffset=+1]
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-template-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API machine template resource on {azure-full}]
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc#capi-yaml-machine-template-rhosp_cluster-api-config-options-rhosp[Sample YAML for a Cluster API machine template resource on {rh-openstack}]
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-template-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API machine template resource on {vmw-full}]
* xref:../../machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc#machineset-modifying_cluster-api-managing-machines[Modifying a compute machine set by using the CLI]
* xref:../../machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc#mapi-compute-config-updating-cli_cluster-api-managing-machines[Updating compute machine configurations]

//Modifying a compute machine set by using the CLI
//Updating compute machine configurations
//tags exclude MAPI, leaving untagged + CAPI
include::modules/machineset-modifying.adoc[leveloffset=+1,tag=!MAPI]
include::modules/mapi-compute-config-updating-cli.adoc[leveloffset=+1,tag=!MAPI]
[role="_additional-resources"]
.Additional resources
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-set-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API compute machine set resource on {aws-full}]
Expand Down
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

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@ include::modules/machineset-azure-enabling-accelerated-networking-existing.adoc[

[role="_additional-resources"]
.Additional resources
* xref:../../machine_management/compute_machine_management/mapi_compute_managing_machines/manually-scaling-machineset.adoc#manually-scaling-machineset[Manually scaling a compute machine set]
* xref:../../machine_management/compute_machine_management/mapi-compute-managing-machines.adoc#mapi-compute-scaling_mapi-compute-managing-machines[Manually scaling a compute machine set]
4 changes: 2 additions & 2 deletions machine_management/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ As a cluster administrator, you can perform the following actions:

* Create a machine set for a bare metal deployment: xref:../machine_management/creating_machinesets/creating-machineset-bare-metal.adoc#creating-machineset-bare-metal[Creating a compute machine set on bare metal]

* xref:../machine_management/compute_machine_management/mapi_compute_managing_machines/manually-scaling-machineset.adoc#manually-scaling-machineset[Manually scale a compute machine set] by adding or removing a machine from the compute machine set.
* xref:../machine_management/compute_machine_management/mapi-compute-managing-machines.adoc#mapi-compute-scaling_mapi-compute-managing-machines[Manually scale a compute machine set] by adding or removing a machine from the compute machine set.

* xref:../machine_management/compute_machine_management/mapi_compute_managing_machines/modifying-machineset.adoc#modifying-machineset[Modify a compute machine set] through the `MachineSet` YAML configuration file.
* xref:../machine_management/compute_machine_management/mapi-compute-managing-machines.adoc#mapi-compute-config-updating-cli_mapi-compute-managing-machines[Updating compute machine configurations] through the `MachineSet` YAML configuration file.

* xref:../machine_management/manual_machine_management/deleting-machine.adoc#deleting-machine[Delete] a machine.

Expand Down
2 changes: 1 addition & 1 deletion modules/capi-modifying-machine-template.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ $ oc apply -f <modified_template_name>.yaml <1>
.Next steps

* For any Cluster API compute machine sets that reference this template, update the `spec.template.spec.infrastructureRef.name` parameter to match the `metadata.name` value in the new machine template resource.
For more information, see "Modifying a compute machine set by using the CLI."
For more information, see "Updating compute machine configurations."
2 changes: 2 additions & 0 deletions modules/machineset-delete-policy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
[id="machineset-delete-policy_{context}"]
= The compute machine set deletion policy

//needs a rewrite

`Random`, `Newest`, and `Oldest` are the three supported deletion options. The default is `Random`, meaning that random machines are chosen and deleted when scaling compute machine sets down. The deletion policy can be set according to the use case by modifying the particular compute machine set:

[source,yaml]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
// * machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc

:_mod-docs-content-type: PROCEDURE
[id="machineset-modifying_{context}"]
= Modifying a compute machine set by using the CLI
[id="mapi-compute-config-updating-cli_{context}"]
= Updating compute machine configurations

You can modify the configuration of a compute machine set, and then propagate the changes to the machines in your cluster by using the CLI.

Expand Down
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]
Copy link
Contributor Author

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.

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

@jeana-redhat jeana-redhat Apr 2, 2025

Choose a reason for hiding this comment

The 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]
----
Expand All @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion nodes/nodes/nodes-nodes-working.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ include::modules/nodes-nodes-working-deleting.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources

* xref:../../machine_management/compute_machine_management/mapi_compute_managing_machines/manually-scaling-machineset.adoc#machineset-manually-scaling-manually-scaling-machineset[Manually scaling a compute machine set]
* xref:../../machine_management/compute_machine_management/mapi-compute-managing-machines.adoc#mapi-compute-scaling_mapi-compute-managing-machines[Manually scaling a compute machine set]

include::modules/nodes-nodes-working-deleting-bare-metal.adoc[leveloffset=+2]
endif::openshift-rosa,openshift-rosa-hcp[]
2 changes: 1 addition & 1 deletion post_installation_configuration/cluster-tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ If you incorrectly sized the worker nodes during deployment, adjust them by crea

include::modules/differences-between-machinesets-and-machineconfigpool.adoc[leveloffset=+2]

include::modules/machineset-manually-scaling.adoc[leveloffset=+2]
include::modules/mapi-compute-scaling.adoc[leveloffset=+2]

include::modules/machineset-delete-policy.adoc[leveloffset=+2]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ include::modules/multi-architecture-scheduling-examples.adoc[leveloffset=+2]
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
* xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity[Controlling pod placement on nodes using node affinity]
* xref:../../nodes/scheduling/nodes-scheduler-about.adoc#nodes-scheduler-about[Controlling pod placement using the scheduler]
* xref:../../machine_management/compute_machine_management/mapi_compute_managing_machines/modifying-machineset.adoc#machineset-modifying_modifying-machineset[Modifying a compute machine set]
* xref:../../machine_management/compute_machine_management/mapi-compute-managing-machines.adoc#mapi-compute-config-updating-cli_mapi-compute-managing-machines[Updating compute machine configurations]

include::modules/multi-architecture-enabling-64k-pages.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion post_installation_configuration/node-tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ include::modules/machine-health-checks-about.adoc[leveloffset=+2]

include::modules/machine-health-checks-resource.adoc[leveloffset=+2]
include::modules/machine-health-checks-creating.adoc[leveloffset=+2]
include::modules/machineset-manually-scaling.adoc[leveloffset=+2]
include::modules/mapi-compute-scaling.adoc[leveloffset=+2]
include::modules/differences-between-machinesets-and-machineconfigpool.adoc[leveloffset=+2]

include::modules/recommended-node-host-practices.adoc[leveloffset=+1]
Expand Down
Loading