mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
changes for MGMT-600
This commit is contained in:
aireilly
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
5c6d0bfb4e
commit
9abd260b0c
@@ -1645,7 +1645,7 @@ Topics:
|
||||
File: nodes-nodes-viewing
|
||||
- Name: Working with nodes
|
||||
File: nodes-nodes-working
|
||||
- Name: Managing Nodes
|
||||
- Name: Managing nodes
|
||||
File: nodes-nodes-managing
|
||||
- Name: Managing the maximum number of Pods per Node
|
||||
File: nodes-nodes-managing-max-pods
|
||||
@@ -1946,6 +1946,8 @@ Topics:
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
- Name: Optimizing networking
|
||||
File: optimizing-networking
|
||||
- Name: Managing bare metal hosts
|
||||
File: managing-bare-metal-hosts
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
- Name: What huge pages do and how they are consumed by apps
|
||||
File: what-huge-pages-do-and-how-they-are-consumed-by-apps
|
||||
|
||||
10
modules/about-bare-metal-hosts-and-nodes.adoc
Normal file
10
modules/about-bare-metal-hosts-and-nodes.adoc
Normal file
@@ -0,0 +1,10 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// scalability_and_performance/managing-bare-metal-hosts.adoc
|
||||
|
||||
[id="about-bare-metal-hosts-and-nodes_{context}"]
|
||||
= About bare metal hosts and nodes
|
||||
|
||||
To provision a {op-system-first} bare metal host as a node in your cluster, first create a `MachineSet` custom resource (CR) object that corresponds to the bare metal host hardware. Bare metal host machine sets describe infrastructure components specific to your configuration. You apply specific Kubernetes labels to these machine sets and then update the infrastructure components to run on only those machines.
|
||||
|
||||
`Machine` CR's are created automatically when you scale up the relevant `MachineSet` containing a `metal3.io/autoscale-to-hosts` annotation. {product-title} uses `Machine` CR's to provision the bare metal node that corresponds to the host as specified in the `MachineSet` CR.
|
||||
@@ -0,0 +1,30 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// scalability_and_performance/managing-bare-metal-hosts.adoc
|
||||
|
||||
[id="adding-bare-metal-host-to-cluster-using-web-console_{context}"]
|
||||
= Adding a bare metal host to the cluster using the web console
|
||||
|
||||
You can add bare metal hosts to the cluster in the web console.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Install an {op-system} cluster on bare metal.
|
||||
* Log in as a user with `cluster-admin` privileges.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the web console, navigate to *Compute* -> *Bare Metal Hosts*.
|
||||
. Select *Add Host* -> *New with Dialog*.
|
||||
. Specify a unique name for the new bare metal host.
|
||||
. Set the *Boot MAC address*.
|
||||
. Set the *Baseboard Management Console (BMC) Address*.
|
||||
. Optionally, enable power management for the host. This allows {product-title} to control the power state of the host.
|
||||
. Enter the user credentials for the host's baseboard management controller (BMC).
|
||||
. Select to power on the host after creation, and select *Create*.
|
||||
. Scale up the number of replicas to match the number of available bare metal hosts. Navigate to *Compute* -> *MachineSets*, and increase the number of machine replicas in the cluster by selecting *Edit Machine count* from the *Actions* drop-down menu.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
You can also manage the number of bare metal nodes using the `oc scale` command and the appropriate bare metal machine set.
|
||||
====
|
||||
46
modules/adding-bare-metal-host-to-cluster-using-yaml.adoc
Normal file
46
modules/adding-bare-metal-host-to-cluster-using-yaml.adoc
Normal file
@@ -0,0 +1,46 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// scalability_and_performance/managing-bare-metal-hosts.adoc
|
||||
|
||||
[id="adding-bare-metal-host-to-cluster-using-yaml_{context}"]
|
||||
= Adding a bare metal host to the cluster using YAML in the web console
|
||||
|
||||
You can add bare metal hosts to the cluster in the web console using a YAML file that describes the bare metal host.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Install a {op-system} compute machine on bare metal infrastructure for use in the cluster.
|
||||
* Log in as a user with `cluster-admin` privileges.
|
||||
* Create a `Secret` CR for the bare metal host.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the web console, navigate to *Compute* -> *Bare Metal Hosts*.
|
||||
. Select *Add Host* -> *New from YAML*.
|
||||
. Copy and paste the below YAML, modifying the relevant fields with the details of your host:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: metal3.io/v1alpha1
|
||||
kind: BareMetalHost
|
||||
metadata:
|
||||
name: <bare_metal_host_name>
|
||||
spec:
|
||||
online: true
|
||||
bmc:
|
||||
address: <bmc_address>
|
||||
credentialsName: <secret_credentials_name> <1>
|
||||
disableCertificateVerification: True
|
||||
bootMACAddress: <host_boot_mac_address>
|
||||
hardwareProfile: unknown
|
||||
----
|
||||
+
|
||||
<1> `credentialsName` must reference a valid `Secret` CR. The `baremetal-operator` cannot manage the bare metal host without a valid `Secret` referenced in the `credentialsName`. For more information about secrets and how to create them, see xref:../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets-about_nodes-pods-secrets[Understanding secrets].
|
||||
|
||||
. Select *Create* to save the YAML and create the new bare metal host.
|
||||
. Scale up the number of replicas to match the number of available bare metal hosts. Navigate to *Compute* -> *MachineSets*, and increase the number of machines in the cluster by selecting *Edit Machine count* from the *Actions* drop-down menu.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
You can also manage the number of bare metal nodes using the `oc scale` command and the appropriate bare metal machine set.
|
||||
====
|
||||
@@ -0,0 +1,30 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// scalability_and_performance/managing-bare-metal-hosts.adoc
|
||||
|
||||
[id="automatically-scaling-machines-to-available-bare-metal-hosts_{context}"]
|
||||
= Automatically scaling machines to the number of available bare metal hosts
|
||||
|
||||
To automatically create the number of `Machine` objects that matches the number of available `BareMetalHost` objects, add a `metal3.io/autoscale-to-hosts` annotation to the `MachineSet` object.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Install {op-system} bare metal compute machines for use in the cluster, and create corresponding `BareMetalHost` objects.
|
||||
* Install the {product-title} CLI (`oc`).
|
||||
* Log in as a user with `cluster-admin` privileges.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Annotate the machine set that you want to configure for automatic scaling by adding the `metal3.io/autoscale-to-hosts` annotation. Replace `<machineset>` with the name of the machine set.
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc annotate machineset <machineset> -n openshift-machine-api 'metal3.io/autoscale-to-hosts=<any_value>'
|
||||
----
|
||||
+
|
||||
Wait for the new scaled machines to start.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
When you use a `BareMetalHost` object to create a machine in the cluster and labels or selectors are subsequently changed on the `BareMetalHost`, the `BareMetalHost` object continues be counted against the `MachineSet` that the `Machine` object was created from.
|
||||
====
|
||||
20
modules/maintaining-bare-metal-hosts.adoc
Normal file
20
modules/maintaining-bare-metal-hosts.adoc
Normal file
@@ -0,0 +1,20 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// scalability_and_performance/managing-bare-metal-hosts.adoc
|
||||
|
||||
[id="maintaining-bare-metal-hosts_{context}"]
|
||||
= Maintaining bare metal hosts
|
||||
|
||||
You can maintain the details of the bare metal hosts in your cluster from the {product-title} web console. Navigate to *Compute* -> *Bare Metal Hosts*, and select a task from the *Actions* drop down menu. Here you can manage items such as BMC details, boot MAC address for the host, enable power management, and so on. You can also review the details of the network interfaces and drives for the host.
|
||||
|
||||
You can move a bare metal host into maintenance mode. When you move a host into maintenance mode, the scheduler moves all managed workloads off the corresponding bare metal node. No new workloads are scheduled while in maintenance mode.
|
||||
|
||||
You can deprovision a bare metal host in the web console. Deprovisioning a host does the following actions:
|
||||
|
||||
. Annotates the bare metal host CR with `cluster.k8s.io/delete-machine: true`
|
||||
. Scales down the related machine set
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Powering off the host without first moving the daemon set and unmanaged static pods to another node can cause service disruption and loss of data.
|
||||
====
|
||||
26
scalability_and_performance/managing-bare-metal-hosts.adoc
Normal file
26
scalability_and_performance/managing-bare-metal-hosts.adoc
Normal file
@@ -0,0 +1,26 @@
|
||||
[id="managing-bare-metal-hosts"]
|
||||
= Managing bare metal hosts
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: managing-bare-metal-hosts
|
||||
|
||||
toc::[]
|
||||
|
||||
When you install {product-title} on a bare metal cluster, you can provision and manage bare metal nodes using `machine` and `machineset` custom resources (CRs) for bare metal hosts that exist in the cluster.
|
||||
|
||||
include::modules/about-bare-metal-hosts-and-nodes.adoc[leveloffset=+1]
|
||||
include::modules/maintaining-bare-metal-hosts.adoc[leveloffset=+1]
|
||||
|
||||
.Additional Resources
|
||||
|
||||
* xref:../machine_management/user_infra/adding-bare-metal-compute-user-infra.adoc#adding-bare-metal-compute-user-infra[Adding compute machines to bare metal]
|
||||
|
||||
include::modules/adding-bare-metal-host-to-cluster-using-web-console.adoc[leveloffset=+2]
|
||||
include::modules/adding-bare-metal-host-to-cluster-using-yaml.adoc[leveloffset=+2]
|
||||
include::modules/automatically-scaling-machines-to-available-bare-metal-hosts.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.adoc#ipi-install-expanding-the-cluster[Expanding the cluster]
|
||||
* xref:../machine_management/deploying-machine-health-checks.adoc#machine-health-checks-bare-metal_deploying-machine-health-checks[MachineHealthChecks on bare metal]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user