Skip to content
Open
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
1 change: 1 addition & 0 deletions _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -434,3 +434,4 @@ endif::openshift-origin[]
:attribute-based-short: Attribute-Based GPU Allocation
//Support log gather operator
:support-log-gather: Support Log Gather
:bmaas-first: Red{nbsp}Hat Bare Metal as a Service for OpenShift
2 changes: 1 addition & 1 deletion _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ Topics:
File: bare-metal-postinstallation-configuration
- Name: Expanding the cluster
File: bare-metal-expanding-the-cluster
- Name: Using bare metal as a service
- Name: Using Red Hat Bare Metal as a Service for OpenShift
File: bare-metal-using-bare-metal-as-a-service
- Name: Installing IBM Cloud Bare Metal (Classic)
Dir: installing_ibm_cloud_classic
Expand Down
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
:_mod-docs-content-type: ASSEMBLY
[id="bare-metal-using-bare-metal-as-a-service"]
= Using bare metal as a service
= Using {bmaas-first}
include::_attributes/common-attributes.adoc[]
:context: bare-metal-using-bmaas

toc::[]

[role="_abstract"]
The Bare Metal as a Service (BMaaS) feature for {product-title} enables you to provision and manage bare-metal hosts by using the Metal^3^ API and the Bare Metal Operator (BMO). These hosts, external to the {product-title} cluster, can run workloads that might not be suitable for containerization or virtualization.
You can provision and manage bare-metal hosts by using the Metal^3^ API and the Bare Metal Operator (BMO). These hosts, external to the {product-title} cluster, can run workloads that might not be suitable for containerization or virtualization, such as legacy applications or applications that require direct hardware access.

BMaaS has the following capabilities:
{bmaas-first} has the following capabilities:

* Provisioning of bare-metal hosts, including initial configuration.
* Lifecycle management such as power management, firmware updates, and decommissioning by using the BMO.

As standalone systems, these hosts operate independently of the {product-title} cluster and support diverse workloads by integrating bare metal resources with containerized and virtualized applications. BMaaS can run other operating systems, but only {op-system-base-full} and CentOS Stream 9 were tested.

:FeatureName: BMaaS
include::snippets/technology-preview.adoc[]

:!FeatureName:
As standalone systems, these hosts operate independently of the {product-title} cluster and support diverse workloads by integrating bare-metal resources with containerized and virtualized applications. {bmaas-first} can run other operating systems, but only {op-system-base-full} and CentOS Stream 9 were tested.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] RedHat.TermsErrors: Use 'bare metal' rather than 'bare-metal'. For more information, see RedHat.TermsErrors.


include::modules/bmaas-prerequisites.adoc[leveloffset=+1]

Expand Down
10 changes: 5 additions & 5 deletions modules/bmaas-prerequisites.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

:_mod-docs-content-type: CONCEPT
[id="bmaas-prerequisites_{context}"]
= Prerequisites for using BMaaS
= Prerequisites for using {bmaas-first}

[role="_abstract"]
To use the Bare Metal as a Service (BMaaS) Technology Preview, complete the prerequisites. BMaaS lets you apply cloud-native management practices to bare-metal infrastructure, enabling automated provisioning and lifecycle management for workloads that require physical hardware.
{bmaas-first} lets you apply cloud-native management practices to bare-metal infrastructure, enabling automated provisioning and lifecycle management for workloads that require physical hardware. To use the {bmaas-first} Technology Preview, complete the following prerequisites:

BareMetalHost Configuration::
All bare-metal hosts must use a Baseboard Management Controller (BMC) configured with the Redfish protocol and virtual media (`redfish-virtualmedia`) driver. Each bare-metal host requires a boot interface with a MAC address configured to receive an IP address lease.
Expand All @@ -16,14 +16,14 @@ Network Requirements::
A DHCP server, separate from the {product-title} and Metal^3^ infrastructure, must be operational on the same Layer 2 network as the bare-metal hosts. The DHCP server must be configured to match the MAC addresses of the boot interfaces on the bare-metal hosts, enabling IP address assignment for communication with Metal^3^ components.

Cluster Privileges::
You must have `cluster-admin` privileges on the {product-title} cluster to perform BMaaS configuration tasks.
You must have `cluster-admin` privileges on the {product-title} cluster to perform configuration tasks.

Web server with images::
BMaaS does not provide images for deployment on hardware. You must configure a web server with the images and checksums you want to use. The `image` field of the `BareMetalHost` spec references these images during deployment. Ensure that the bare-metal hosts can reach the web server URL. The following is an example of an image and checksum you might include:
{bmaas-first} does not provide images for deployment on hardware. You must configure a web server with the images and checksums you want to use. The `image` field of the `BareMetalHost` spec references these images during deployment. Ensure that the bare-metal hosts can reach the web server URL. The following is an example of an image and checksum you might include:

* `http://example.com/rhel9.qcow2`
* `http://example.com/rhel9.qcow2.sha512sum`
* `http://example.com/stream9.qcow2`
* `http://example.com/stream9.qcow2.sha512sum`

These prerequisites ensure that BMaaS can provision and manage bare-metal hosts effectively.
These prerequisites ensure that you can provision and manage bare-metal hosts effectively.
12 changes: 6 additions & 6 deletions modules/bmaas-setting-up-a-dedicated-namespace.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
= Setting up a dedicated namespace

[role="_abstract"]
To prevent accidental interference between Bare Metal as a Service (BMaaS) workloads and the {product-title} infrastructure, set up a dedicated namespace. Repeat this procedure for every BMaaS project.
To prevent accidental interference between {bmaas-first} workloads and the {product-title} infrastructure, set up a dedicated namespace. Repeat this procedure for every project where you intend to use {bmaas-first}.

.Prerequisites

* You have link:https://docs.redhat.com/en/documentation/openshift_container_platform/{product-version}/html-single/authentication_and_authorization/index#configuring-identity-providers[configured an identify provider].

.Procedure

. Configure a BMaaS `bmadmin` user in the identity provider and create a secret in OpenShift:
. Configure a `bmadmin` user in the identity provider and create a secret in OpenShift:

.. Create the `bmadmin` user in the identity provider. For example, if using the `htpasswd` identity provider, run the following command:
+
Expand Down Expand Up @@ -120,7 +120,7 @@ For more information about identify providers, see link:https://docs.redhat.com/

.. Save and exit the editor.

. Create a BMaaS `bmadmin` user by running the following command:
. Create a `bmadmin` user by running the following command:
+
[source,terminal]
----
Expand All @@ -129,7 +129,7 @@ $ oc create user <username>
<username>::
The user name. Replace `<username>` with your username. The following examples use `bmadmin` as the username.

. Create a dedicated `bmaas` namespace for BMaaS hosts by running the following command:
. Create a dedicated `bmaas` namespace for {bmaas-first} hosts by running the following command:
+
[source,terminal]
----
Expand All @@ -138,7 +138,7 @@ $ oc new-project <namespace>
`<namespace>`::
Replace <namespace> with the namespace name that you want to use. This example uses `bmaas`.

. Assign the `edit` role to the BMaaS `bmadmin` user in the `bmaas` namespace by running the following command:
. Assign the `edit` role to the `bmadmin` user in the `bmaas` namespace by running the following command:
+
[source,terminal]
----
Expand All @@ -159,7 +159,7 @@ $ git clone -b release-{product-version} https://github.com/openshift/baremetal-
$ oc apply -f baremetal-operator/config/base/rbac/<role_filename>.yaml
----

. Assign the custom RBAC roles to the BMaaS `bmadmin` user in the `bmaas` namespace by running the following command:
. Assign the custom RBAC roles to the `bmadmin` user in the `bmaas` namespace by running the following command:
+
[source,terminal]
----
Expand Down
2 changes: 1 addition & 1 deletion modules/bmo-configuring-users-for-bmaas-hosts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="bmo-configuring-users-for-bmaas-hosts_{context}"]
= Configuring users for BMaaS hosts
= Configuring users for {bmaas-first} hosts

[role="_abstract"]
Configure bare-metal host users and add them to a Kubernetes secret. Then, create and apply the secret to customize the host. With configured users you can access or manage the bare-metal host after it is provisioned.
Expand Down