Skip to content

Commit bdc7334

Browse files
committed
OSDOCS-13951: collapse managing compute dir
1 parent 34de84e commit bdc7334

File tree

19 files changed

+107
-68
lines changed

19 files changed

+107
-68
lines changed

Diff for: _topic_maps/_topic_map.yml

+8-6
Original file line numberDiff line numberDiff line change
@@ -2375,12 +2375,14 @@ Topics:
23752375
# - Name: Getting started with compute machine sets
23762376
# File: mapi-compute-getting-started
23772377
- Name: Managing compute machines with compute machine sets
2378-
Dir: mapi_compute_managing_machines
2379-
Topics:
2380-
- Name: Manually scaling a compute machine set
2381-
File: manually-scaling-machineset
2382-
- Name: Modifying a compute machine set
2383-
File: modifying-machineset
2378+
File: mapi-compute-managing-machines
2379+
# - Name: Managing compute machines with compute machine sets
2380+
# Dir: mapi_compute_managing_machines
2381+
# Topics:
2382+
# - Name: Manually scaling a compute machine set
2383+
# File: manually-scaling-machineset
2384+
# - Name: Modifying a compute machine set
2385+
# File: modifying-machineset
23842386
# - Name: Compute machine set configuration
23852387
# File: mapi-compute-configuration
23862388
# - Name: Configuration options for compute machines
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="manually-scaling-machineset"]
33
= Manually scaling a compute machine set
4-
include::_attributes/common-attributes.adoc[]
4+
// include::_attributes/common-attributes.adoc[]
55
:context: manually-scaling-machineset
66

77
toc::[]
88

99
You can add or remove an instance of a machine in a compute machine set.
1010

11-
[NOTE]
12-
====
13-
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].
14-
====
11+
// [NOTE]
12+
// ====
13+
// 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].
14+
// ====
1515

1616
== Prerequisites
1717

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

20-
include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1]
20+
// include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1]
2121

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

24-
include::modules/machineset-delete-policy.adoc[leveloffset=+1]
24+
// include::modules/machineset-delete-policy.adoc[leveloffset=+1]
2525

2626
[role="_additional-resources"]
2727
[id="additional-resources_manually-scaling-machineset"]
2828
== Additional resources
29-
* xref:../../../machine_management/manual_machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase]
29+
// * xref:../../../machine_management/manual_machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase]

Diff for: _unused_topics/modifying-machineset.adoc

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="modifying-machineset"]
3+
= Modifying a compute machine set
4+
// include::_attributes/common-attributes.adoc[]
5+
:context: modifying-machineset
6+
7+
toc::[]
8+
9+
You can modify a compute machine set, such as adding labels, changing the instance type, or changing block storage.
10+
11+
// [NOTE]
12+
// ====
13+
// 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].
14+
// ====
15+
16+
//Updating compute machine configurations
17+
//tags exclude CAPI, leaving untagged + MAPI
18+
// include::modules/mapi-compute-config-updating-cli.adoc[leveloffset=+1,tag=!CAPI]
19+
20+
[role="_additional-resources"]
21+
.Additional resources
22+
// * xref:../../../machine_management/manual_machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase]
23+
// * 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]
24+
// * xref:../../../nodes/scheduling/nodes-scheduler-about.adoc#nodes-scheduler-about[Controlling pod placement using the scheduler]

Diff for: installing/installing_nutanix/nutanix-failure-domains.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ include::modules/post-installation-adding-nutanix-failure-domains-compute-machin
5151

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

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

Diff for: machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ include::modules/capi-modifying-machine-template.adoc[leveloffset=+1]
1818
* 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}]
1919
* 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}]
2020
* 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}]
21-
* 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]
21+
* 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]
2222
23-
//Modifying a compute machine set by using the CLI
23+
//Updating compute machine configurations
2424
//tags exclude MAPI, leaving untagged + CAPI
25-
include::modules/machineset-modifying.adoc[leveloffset=+1,tag=!MAPI]
25+
include::modules/mapi-compute-config-updating-cli.adoc[leveloffset=+1,tag=!MAPI]
2626
[role="_additional-resources"]
2727
.Additional resources
2828
* 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}]
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,36 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="mapi-compute-managing-machines"]
3-
= Managing control plane machines with control plane machine sets
3+
= Managing compute machines with compute machine sets
44
include::_attributes/common-attributes.adoc[]
55
:context: mapi-compute-managing-machines
66

77
toc::[]
88

9-
Placeholder assembly.
9+
Machine API compute machine sets automate several essential aspects of compute machine management.
10+
11+
include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1]
12+
13+
//Updating compute machine configurations
14+
//tags exclude CAPI, leaving untagged + MAPI
15+
include::modules/mapi-compute-config-updating-cli.adoc[leveloffset=+1,tag=!CAPI]
16+
17+
[role="_additional-resources"]
18+
.Additional resources
19+
* xref:../../nodes/scheduling/nodes-scheduler-about.adoc#nodes-scheduler-about[Controlling pod placement using the scheduler]
20+
21+
//Manually scaling a compute machine set
22+
include::modules/mapi-compute-scaling.adoc[leveloffset=+1]
23+
24+
[role="_additional-resources"]
25+
.Additional resources
26+
* xref:../../networking/enable-cluster-wide-proxy.adoc#nw-proxy-configure-object_config-cluster-wide-proxy[Enabling the cluster-wide proxy]
27+
28+
//The compute machine set deletion policy
29+
include::modules/machineset-delete-policy.adoc[leveloffset=+1]
30+
31+
[role="_additional-resources"]
32+
[id="additional-resources_{context}"]
33+
== Additional resources
34+
* xref:../../machine_management/manual_machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase]
35+
* Compute machine set configuration
36+
* Provider-specific configuration options

Diff for: machine_management/compute_machine_management/mapi_compute_managing_machines/modifying-machineset.adoc

-24
This file was deleted.

Diff for: machine_management/creating_machinesets/creating-machineset-azure.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,4 @@ include::modules/machineset-azure-enabling-accelerated-networking-existing.adoc[
8888

8989
[role="_additional-resources"]
9090
.Additional resources
91-
* xref:../../machine_management/compute_machine_management/mapi_compute_managing_machines/manually-scaling-machineset.adoc#manually-scaling-machineset[Manually scaling a compute machine set]
91+
* xref:../../machine_management/compute_machine_management/mapi-compute-managing-machines.adoc#mapi-compute-scaling_mapi-compute-managing-machines[Manually scaling a compute machine set]

Diff for: machine_management/index.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ As a cluster administrator, you can perform the following actions:
5555

5656
* 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]
5757

58-
* 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.
58+
* 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.
5959

60-
* 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.
60+
* 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.
6161

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

Diff for: modules/capi-modifying-machine-template.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,4 @@ $ oc apply -f <modified_template_name>.yaml <1>
9191
.Next steps
9292

9393
* 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.
94-
For more information, see "Modifying a compute machine set by using the CLI."
94+
For more information, see "Updating compute machine configurations."

Diff for: modules/machineset-delete-policy.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[id="machineset-delete-policy_{context}"]
77
= The compute machine set deletion policy
88

9+
//needs a rewrite
10+
911
`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:
1012

1113
[source,yaml]

Diff for: modules/machineset-modifying.adoc renamed to modules/mapi-compute-config-updating-cli.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
// * machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc
66

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

1111
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.
1212

Diff for: modules/machineset-manually-scaling.adoc renamed to modules/mapi-compute-scaling.adoc

+19-11
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,39 @@
11
// Module included in the following assemblies:
22
//
3-
// * machine_management/compute_machine_management/mapi_compute_managing_machines/manually-scaling-machineset.adoc
3+
// * machine_management/compute_machine_management/mapi-compute-managing-machines.adoc
44
// * post_installation_configuration/cluster-tasks.adoc
5+
// * post_installation_configuration/node-tasks.adoc
56
// * windows_containers/scheduling-windows-workloads.adoc
67

78
:_mod-docs-content-type: PROCEDURE
8-
[id="machineset-manually-scaling_{context}"]
9-
= Scaling a compute machine set manually
9+
[id="mapi-compute-scaling_{context}"]
10+
= Manually scaling a compute machine set
1011

1112
To add or remove an instance of a machine in a compute machine set, you can manually scale the compute machine set.
1213

13-
This guidance is relevant to fully automated, installer-provisioned infrastructure installations. Customized, user-provisioned infrastructure installations do not have compute machine sets.
14+
ifeval::["{context}" != "mapi-compute-managing-machines"]
15+
include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1]
16+
endif::[]
1417

1518
.Prerequisites
1619

17-
* Install an {product-title} cluster and the `oc` command line.
20+
* Install an {product-title} cluster and the {oc-first}.
1821
* Log in to `oc` as a user with `cluster-admin` permission.
22+
* 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.
23+
For more information, see "Enabling the cluster-wide proxy".
1924
2025
.Procedure
2126

22-
. View the compute machine sets that are in the cluster by running the following command:
27+
. List the compute machine sets that are in the cluster by running the following command:
2328
+
2429
[source,terminal]
2530
----
2631
$ oc get machinesets.machine.openshift.io -n openshift-machine-api
2732
----
2833
+
29-
The compute machine sets are listed in the form of `<clusterid>-worker-<aws-region-az>`.
34+
The compute machine sets are listed in the form of `<cluster_id>-worker-<region>`.
3035

31-
. View the compute machines that are in the cluster by running the following command:
36+
. List the compute machines that are in the cluster by running the following command:
3237
+
3338
[source,terminal]
3439
----
@@ -39,21 +44,24 @@ $ oc get machines.machine.openshift.io -n openshift-machine-api
3944
+
4045
[source,terminal]
4146
----
42-
$ oc annotate machines.machine.openshift.io/<machine_name> -n openshift-machine-api machine.openshift.io/delete-machine="true"
47+
$ oc annotate machines.machine.openshift.io/<machine_name> \
48+
-n openshift-machine-api machine.openshift.io/delete-machine="true"
4349
----
4450

4551
. Scale the compute machine set by running one of the following commands:
4652
+
4753
[source,terminal]
4854
----
49-
$ oc scale --replicas=2 machinesets.machine.openshift.io <machineset> -n openshift-machine-api
55+
$ oc scale --replicas=2 machinesets.machine.openshift.io <machineset> \
56+
-n openshift-machine-api
5057
----
5158
+
5259
Or:
5360
+
5461
[source,terminal]
5562
----
56-
$ oc edit machinesets.machine.openshift.io <machineset> -n openshift-machine-api
63+
$ oc edit machinesets.machine.openshift.io <machineset> \
64+
-n openshift-machine-api
5765
----
5866
+
5967
[TIP]

Diff for: nodes/nodes/nodes-nodes-working.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ include::modules/nodes-nodes-working-deleting.adoc[leveloffset=+2]
4343
[role="_additional-resources"]
4444
.Additional resources
4545

46-
* 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]
46+
* xref:../../machine_management/compute_machine_management/mapi-compute-managing-machines.adoc#mapi-compute-scaling_mapi-compute-managing-machines[Manually scaling a compute machine set]
4747

4848
include::modules/nodes-nodes-working-deleting-bare-metal.adoc[leveloffset=+2]
4949
endif::openshift-rosa,openshift-rosa-hcp[]

Diff for: post_installation_configuration/cluster-tasks.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ If you incorrectly sized the worker nodes during deployment, adjust them by crea
220220

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

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

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

Diff for: post_installation_configuration/configuring-multi-arch-compute-machines/multi-architecture-compute-managing.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ include::modules/multi-architecture-scheduling-examples.adoc[leveloffset=+2]
2121
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
2222
* xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity[Controlling pod placement on nodes using node affinity]
2323
* xref:../../nodes/scheduling/nodes-scheduler-about.adoc#nodes-scheduler-about[Controlling pod placement using the scheduler]
24-
* xref:../../machine_management/compute_machine_management/mapi_compute_managing_machines/modifying-machineset.adoc#machineset-modifying_modifying-machineset[Modifying a compute machine set]
24+
* xref:../../machine_management/compute_machine_management/mapi-compute-managing-machines.adoc#mapi-compute-config-updating-cli_mapi-compute-managing-machines[Updating compute machine configurations]
2525
2626
include::modules/multi-architecture-enabling-64k-pages.adoc[leveloffset=+1]
2727

Diff for: post_installation_configuration/node-tasks.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ include::modules/machine-health-checks-about.adoc[leveloffset=+2]
7070

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

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

0 commit comments

Comments
 (0)