Skip to content

Commit 44c67ce

Browse files
authored
Merge pull request #38127 from Amrita42/OSDOCS-2752
OSDOCS--2572: Machine management overview page
2 parents 9c5e770 + 171a5d3 commit 44c67ce

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1694,6 +1694,8 @@ Name: Machine management
16941694
Dir: machine_management
16951695
Distros: openshift-origin,openshift-enterprise
16961696
Topics:
1697+
- Name: Overview of machine management
1698+
File: index
16971699
- Name: Creating machine sets
16981700
Dir: creating_machinesets
16991701
Distros: openshift-origin,openshift-enterprise

machine_management/index.adoc

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
[id="overview-of-machine-management"]
2+
= Overview of machine management
3+
include::modules/common-attributes.adoc[]
4+
:context: overview-of-machine-management
5+
6+
toc::[]
7+
8+
You can use machine management to flexibly work with underlying infrastructure like Amazon Web Services (AWS), Azure, Google Cloud Platform (GCP), OpenStack, Red Hat Virtualization (RHV), and vSphere to manage the {product-title} cluster.
9+
You can control the cluster, and also perform auto-scaling, that is, scaling up and down the cluster based on specific workload policies.
10+
11+
The {product-title} cluster can horizontally scale up and down, when the load increases or decreases.
12+
It is important to have a cluster that adapts to changing workloads.
13+
14+
Machine management is implemented as a xref:../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Custom Resource Definition](CRD).
15+
A CRD object defines a new unique object `Kind` in the cluster and enables the Kubernetes API server to handle it's entire lifecycle.
16+
17+
The Machine API Operator provisions the following resources:
18+
19+
* MachineSet
20+
* Machine
21+
* Cluster Autoscaler
22+
* Machine Autoscaler
23+
* Machine Health Checks
24+
25+
[discrete]
26+
== What you can do with machine sets
27+
28+
As a cluster administrator you can:
29+
30+
. Create a machine set on:
31+
** xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#creating-machineset-aws[AWS]
32+
** xref:../machine_management/creating_machinesets/creating-machineset-azure.adoc#creating-machineset-azure[Azure]
33+
** xref:../machine_management/creating_machinesets/creating-machineset-gcp.adoc#creating-machineset-gcp[GCP]
34+
** xref:../machine_management/creating_machinesets/creating-machineset-osp.adoc#creating-machineset-osp[OpenStack]
35+
** xref:../machine_management/creating_machinesets/creating-machineset-rhv.adoc#creating-machineset-rhv[RHV]
36+
** xref:../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere[vSphere]
37+
38+
. xref:../machine_management/manually-scaling-machineset.adoc#manually-scaling-machineset[Manually scale a machine set] by adding or removing a machine from the machine set.
39+
. xref:../machine_management/modifying-machineset.adoc#modifying-machineset[Modify a machine set] through the MachineSet YAML configuration file.
40+
. xref:../machine_management/deleting-machine.adoc#deleting-machine[Delete] a machine.
41+
. xref:../machine_management/creating-infrastructure-machinesets.adoc#creating-infrastructure-machinesets[Create infrastructure machine sets].
42+
. Configure and deploy a xref:../machine_management/deploying-machine-health-checks.adoc#deploying-machine-health-checks[machine health check] to automatically fix damaged machines in a machine pool.
43+
44+
[discrete]
45+
== Autoscaler
46+
47+
The autoscaler ensures that your cluster is flexible to changing workloads.
48+
To xref:../machine_management/applying-autoscaling.adoc#applying-autoscaling[autoscale] your {product-title} cluster, you must first deploy a cluster autoscaler, and then deploy a machine autoscaler for each machine set.
49+
The cluster autoscaler increases and decreases the size of the cluster based on deployment needs.
50+
The machine autoscaler adjusts the number of machines in the machine sets that you deploy in your {product-title} cluster.
51+
52+
[discrete]
53+
== User-provisioned infrastructure
54+
User-provisioned infrastructure is an environment, where the user deploys infrastructure that is compute, network, and storage resources, that hosts the {product-title}.
55+
You can xref:../machine_management//user_infra/adding-compute-user-infra-general.adoc#adding-compute-user-infra-general[add compute machines] to a cluster on user-provisioned infrastructure either as part of or after the installation process.
56+
57+
[discrete]
58+
== What you can do with RHEL compute machines
59+
60+
As a cluster administrator, you can:
61+
62+
** xref:../machine_management/adding-rhel-compute.adoc#adding-rhel-compute[Add Red Hat Enterprise Linux (RHEL) compute machines], also known as worker machines, to a user-provisioned infrastructure cluster or an installation-provisioned infrastructure cluster.
63+
** xref:../machine_management/more-rhel-compute.adoc#more-rhel-compute[Add more Red Hat Enterprise Linux (RHEL) compute machines] to an existing cluster.

0 commit comments

Comments
 (0)