Skip to content

[OSDOCS#12997]: Update agent-based installer documentation to include 2NO#110741

Open
bjahagir-OpenShift wants to merge 1 commit intoopenshift:mainfrom
bjahagir-OpenShift:bjahagir-OSDOCS-12997
Open

[OSDOCS#12997]: Update agent-based installer documentation to include 2NO#110741
bjahagir-OpenShift wants to merge 1 commit intoopenshift:mainfrom
bjahagir-OpenShift:bjahagir-OSDOCS-12997

Conversation

@bjahagir-OpenShift
Copy link
Copy Markdown
Contributor

Version(s):
4.22

Issue:
https://redhat.atlassian.net/browse/OSDOCS-12997

Link to docs preview:

QE review:

  • QE has approved this change.

@openshift-ci openshift-ci Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 23, 2026
@bjahagir-OpenShift bjahagir-OpenShift changed the title [OSDOCS#12997]: For OSDOCS-12997 [OSDOCS#12997]: Update agent-based installer documentation to include 2NO Apr 24, 2026
@openshift-ci openshift-ci Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 24, 2026

[IMPORTANT]
====
Zero Touch Provisioning (ZTP) is not supported for two-node clusters with fencing (TNF). Although you can use Red Hat Advanced Cluster Management (RHACM) for installations, the additional infrastructure components required for ZTP are not validated for this topology.
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] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-rhacm}' rather than the plain text product term 'RHACM', unless your use case is an exception.


The Agent-based Installer performs validation checks on user defined YAML files before the ISO is created. Once the validations are successful, the agent ISO
is created.
The Agent-based Installer validates user-defined YAML files before creating the ISO. The installer creates the agent ISO only after these validations succeed.
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 'installation program' rather than 'The installer'. For more information, see RedHat.TermsErrors.

* If you specify `certificateVerification`, the value must be either `Enabled` or `Disabled`.
* Fencing credentials are valid only with `baremetal`, `external`, or `none` platforms. Other platforms result in a validation error.

.`install-config.yaml` validations
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] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.

.`agent-config.yaml`
* The `baremetal`, `vsphere`, and `none` platforms are supported.
* The `networkType` parameter must be `OVNKubernetes` for the `none` platform.
* You must set the `apiVIPs` and `ingressVIPs` parameters for bare-metal and vSphere platforms.
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.

* The `baremetal`, `vsphere`, and `none` platforms are supported.
* The `networkType` parameter must be `OVNKubernetes` for the `none` platform.
* You must set the `apiVIPs` and `ingressVIPs` parameters for bare-metal and vSphere platforms.
* Some host-specific fields in the bare-metal platform configuration that have equivalents in `agent-config.yaml` file are ignored.
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.


* Each interface must have a defined MAC address. Additionally, all interfaces must have a different MAC address.
* At least one interface must be defined for each host.
.`agent-config.yaml` validations
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] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.

== ZTP manifests

.`agent-cluster-install.yaml`
.`agent-cluster-install.yaml` validations
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] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.

* For IPv6, the only supported value for the `networkType` parameter is `OVNKubernetes`. Use the `OpenshiftSDN` value only for IPv4.

.`cluster-image-set.yaml`
.`cluster-image-set.yaml` validations
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] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA.

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Apr 24, 2026

@bjahagir-OpenShift: all tests passed!

Full PR test history. Your PR dashboard.

Details

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

size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants