Skip to content

[OSDOCS-15345]: Adding bare metal infra docs for HCP #97233

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lahinson
Copy link
Contributor

@lahinson lahinson commented Aug 6, 2025

Version(s): 4.17+

Issue: https://issues.redhat.com/browse/OSDOCS-15345

Link to docs preview: Creating an infrastructure environment: https://97233--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-bm.html#hcp-bm-create-infra_hcp-deploy-bm

QE review:

  • QE has approved this change.

Additional information: This PR is related to #96275. This PR provides the instructions to create the InfraEnv for hosted control planes on bare metal. The related PR provides the instructions to create the hosted cluster after the infrastructure has been set up.

@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Aug 6, 2025

🤖 Thu Aug 14 16:09:27 - Prow CI generated the docs preview:

https://97233--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-deploy/hcp-deploy-bm.html

@lahinson lahinson force-pushed the osdocs-15345-hcp-create-infra branch from 892a508 to 74b9418 Compare August 7, 2025 18:26
Copy link

@jparrill jparrill left a comment

Choose a reason for hiding this comment

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

Dropped some comments. Thanks!

[id="hcp-bm-create-infra_{context}"]
== Creating an infrastructure environment

Before you can create a hosted cluster on bare metal, you need an infrastructure environment.

Choose a reason for hiding this comment

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

s/infrastructure environment/infraenv/

InfraEnv it's an Assisted Installer object which is more specific, saying "infrastructure environment" sounds generic.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

- <ip_address>
pullSecretRef:
name: pull-secret
sshAuthorizedKey: <ssh_public_key>

Choose a reason for hiding this comment

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

I would add a couple of "..." under the last line, just to let the user know that there are some other options not mentioned in the sample.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

e57a637f-745b-496e-971d-1abbf03341ba true auto-assign
----

** If you use the Metal3 Operator, you can automate the creation of `BareMetalHost` objects by completing the following steps:

Choose a reason for hiding this comment

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

This is not accurate:

"you can automate the creation of BareMetalHost objects by completing the following steps"

I would say something like:

"you can automate the bare metal host registration by creating the following objects"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. Will fix.


. Click **Infrastructure -> Host inventory -> Create infrastructure environment**.

. After you create the infrastructure environment, add bare-metal hosts from within the **InfraEnv** view by clicking **Add hosts** and selecting from the available options.

Choose a reason for hiding this comment

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

s/"infrastructure environment"/InfraEnv object"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

@lahinson lahinson force-pushed the osdocs-15345-hcp-create-infra branch from 74b9418 to 2fcc01d Compare August 14, 2025 15:45
@lahinson lahinson force-pushed the osdocs-15345-hcp-create-infra branch from 2fcc01d to 98f0345 Compare August 14, 2025 16:01
@lahinson
Copy link
Contributor Author

/retest

Copy link

openshift-ci bot commented Aug 14, 2025

@lahinson: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants