Merge pull request #101796 from lahinson/osdocs-17180-hcp-env-namespace

stevsmit · web-flow · commit 4a8255b359b5 · 2025-11-07T07:41:02.000-05:00
[OSDOCS-17180]: Correct env namespace in HCP disconnected docs
diff --git a/modules/hcp-bm-hosts.adoc b/modules/hcp-bm-hosts.adoc
@@ -27,45 +27,58 @@ Because you have at least one secret that holds the bare metal host credentials,
 apiVersion: v1
 kind: Secret
 metadata:
-  name: <hosted_cluster_name>-worker0-bmc-secret # <1>
-  namespace: <hosted_cluster_namespace>-<hosted_cluster_name> # <2>
+  name: <hosted_cluster_name>-worker0-bmc-secret
+  namespace: <hosted_cluster_namespace>
 data:
-  password: YWRtaW4= # <3>
-  username: YWRtaW4= # <4>
+  password: YWRtaW4=
+  username: YWRtaW4=
 type: Opaque
 # ...
 apiVersion: metal3.io/v1alpha1
 kind: BareMetalHost
 metadata:
   name: <hosted_cluster_name>-worker0
-  namespace: <hosted_cluster_namespace>-<hosted_cluster_name> # <2>
+  namespace: <hosted_cluster_namespace>
   labels:
-    infraenvs.agent-install.openshift.io: <hosted_cluster_name> # <5>
+    infraenvs.agent-install.openshift.io: <hosted_cluster_name>
   annotations:
     inspect.metal3.io: disabled
-    bmac.agent-install.openshift.io/hostname: <hosted_cluster_name>-worker0 # <6>
+    bmac.agent-install.openshift.io/hostname: <hosted_cluster_name>-worker0
 spec:
-  automatedCleaningMode: disabled # <7>
+  automatedCleaningMode: disabled
   bmc:
-    disableCertificateVerification: true # <8>
-    address: redfish-virtualmedia://[192.168.126.1]:9000/redfish/v1/Systems/local/<hosted_cluster_name>-worker0 # <9>
-    credentialsName: <hosted_cluster_name>-worker0-bmc-secret # <10>
-  bootMACAddress: aa:aa:aa:aa:02:11 # <11>
-  online: true # <12>
+    disableCertificateVerification: true
+    address: redfish-virtualmedia://[192.168.126.1]:9000/redfish/v1/Systems/local/<hosted_cluster_name>-worker0
+    credentialsName: <hosted_cluster_name>-worker0-bmc-secret
+  bootMACAddress: aa:aa:aa:aa:02:11
+  online: true
 ----
 +
-<1> Replace `<hosted_cluster_name>` with your hosted cluster.
-<2> Replace `<hosted_cluster_name>` with your hosted cluster. Replace `<hosted_cluster_namespace>` with the name of your hosted cluster namespace.
-<3> Specify the password of the baseboard management controller (BMC) in Base64 format.
-<4> Specify the user name of the BMC in Base64 format.
-<5> Replace `<hosted_cluster_name>` with your hosted cluster. The `infraenvs.agent-install.openshift.io` field serves as the link between the Assisted Installer and the `BareMetalHost` objects.
-<6> Replace `<hosted_cluster_name>` with your hosted cluster. The `bmac.agent-install.openshift.io/hostname` field represents the node name that is adopted during deployment.
-<7> The `automatedCleaningMode` field prevents the node from being erased by the Metal3 Operator.
-<8> The `disableCertificateVerification` field is set to `true` to bypass certificate validation from the client.
-<9> Replace `<hosted_cluster_name>` with your hosted cluster. The `address` field denotes the BMC address of the worker node.
-<10> Replace `<hosted_cluster_name>` with your hosted cluster. The `credentialsName` field points to the secret where the user and password credentials are stored.
-<11> The `bootMACAddress` field indicates the interface MAC address that the node starts from.
-<12> The `online` field defines the state of the node after the `BareMetalHost` object is created.
+where:
+
+<hosted_cluster_name>:: Specifies the name of your hosted cluster.
+
+<hosted_cluster_namespace>:: Specifies the name of your hosted cluster namespace.
+
+password:: Specifies the password of the baseboard management controller (BMC) in Base64 format.
+
+username:: Specifies the user name of the BMC in Base64 format.
+
+infraenvs.agent-install.openshift.io:: Serves as the link between the Assisted Installer and the `BareMetalHost` objects.
+
+bmac.agent-install.openshift.io/hostname:: Represents the node name that is adopted during deployment.
+
+automatedCleaningMode:: Prevents the node from being erased by the Metal3 Operator.
+
+disableCertificateVerification:: Is set to `true` to bypass certificate validation from the client.
+
+address:: Denotes the BMC address of the worker node.
+
+credentialsName:: Points to the secret where the user and password credentials are stored.
+
+bootMACAddress:: Indicates the interface MAC address that the node starts from.
+
+online:: Defines the state of the node after the `BareMetalHost` object is created.
 
 . Deploy the `BareMetalHost` object by entering the following command:
 +
diff --git a/modules/hcp-dc-infraenv.adoc b/modules/hcp-dc-infraenv.adoc
@@ -6,7 +6,7 @@
 [id="hcp-dc-infraenv_{context}"]
 = Creating an InfraEnv resource for the hosted cluster
 
-The `InfraEnv` resource is an Assisted Service object that includes essential details, such as the `pullSecretRef` and the `sshAuthorizedKey`. Those details are used to create the Red Hat Enterprise Linux CoreOS (RHCOS) boot image that is customized for the hosted cluster.
+The `InfraEnv` resource is an Assisted Service object that includes essential details, such as the `pullSecretRef` and the `sshAuthorizedKey`. Those details are used to create the {op-system-first} boot image that is customized for the hosted cluster.
 
 You can host more than one `InfraEnv` resource, and each one can adopt certain types of hosts. For example, you might want to divide your server farm between a host that has greater RAM capacity.
 
@@ -20,17 +20,20 @@ apiVersion: agent-install.openshift.io/v1beta1
 kind: InfraEnv
 metadata:
   name: <hosted_cluster_name>
-  namespace: <hosted-cluster-namespace>-<hosted_cluster_name> <1> <2>
+  namespace: <hosted_cluster_namespace>
 spec:
-  pullSecretRef: <3>
+  pullSecretRef:
     name: pull-secret
-  sshAuthorizedKey: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDk7ICaUE+/k4zTpxLk4+xFdHi4ZuDi5qjeF52afsNkw0w/glILHhwpL5gnp5WkRuL8GwJuZ1VqLC9EKrdmegn4MrmUlq7WTsP0VFOZFBfq2XRUxo1wrRdor2z0Bbh93ytR+ZsDbbLlGngXaMa0Vbt+z74FqlcajbHTZ6zBmTpBVq5RHtDPgKITdpE1fongp7+ZXQNBlkaavaqv8bnyrP4BWahLP4iO9/xJF9lQYboYwEEDzmnKLMW1VtCE6nJzEgWCufACTbxpNS7GvKtoHT/OVzw8ArEXhZXQUS1UY8zKsX2iXwmyhw5Sj6YboA8WICs4z+TrFP89LmxXY0j6536TQFyRz1iB4WWvCbH5n6W+ABV2e8ssJB1AmEy8QYNwpJQJNpSxzoKBjI73XxvPYYC/IjPFMySwZqrSZCkJYqQ023ySkaQxWZT7in4KeMu7eS2tC+Kn4deJ7KwwUycx8n6RHMeD8Qg9flTHCv3gmab8JKZJqN3hW1D378JuvmIX4V0= <4>
+  sshAuthorizedKey: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDk7ICaUE+/k4zTpxLk4+xFdHi4ZuDi5qjeF52afsNkw0w/glILHhwpL5gnp5WkRuL8GwJuZ1VqLC9EKrdmegn4MrmUlq7WTsP0VFOZFBfq2XRUxo1wrRdor2z0Bbh93ytR+ZsDbbLlGngXaMa0Vbt+z74FqlcajbHTZ6zBmTpBVq5RHtDPgKITdpE1fongp7+ZXQNBlkaavaqv8bnyrP4BWahLP4iO9/xJF9lQYboYwEEDzmnKLMW1VtCE6nJzEgWCufACTbxpNS7GvKtoHT/OVzw8ArEXhZXQUS1UY8zKsX2iXwmyhw5Sj6YboA8WICs4z+TrFP89LmxXY0j6536TQFyRz1iB4WWvCbH5n6W+ABV2e8ssJB1AmEy8QYNwpJQJNpSxzoKBjI73XxvPYYC/IjPFMySwZqrSZCkJYqQ023ySkaQxWZT7in4KeMu7eS2tC+Kn4deJ7KwwUycx8n6RHMeD8Qg9flTHCv3gmab8JKZJqN3hW1D378JuvmIX4V0=
 ----
 +
-<1> Replace `<hosted_cluster_name>` with your hosted cluster.
-<2> Replace `<hosted_cluster_namespace>` with the name of your hosted cluster namespace.
-<3> The `pullSecretRef` refers to the config map reference in the same namespace as the `InfraEnv`, where the pull secret is used.
-<4> The `sshAuthorizedKey` represents the SSH public key that is placed in the boot image. The SSH key allows access to the worker nodes as the `core` user.
+where:
+
+<hosted_cluster_namespace>:: Specifies the name of your hosted cluster namespace.
+
+pullSecretRef:: Specifies the config map reference in the same namespace as the `InfraEnv`, where the pull secret is used.
+
+sshAuthorizedKey:: Specifies the SSH public key that is placed in the boot image. The SSH key allows access to the worker nodes as the `core` user.
 
 . Create the `InfraEnv` resource by entering the following command:
 +
