Skip to content

Commit 9b274b2

Browse files
authored
Merge pull request #97313 from openshift-cherrypick-robot/cherry-pick-97184-to-enterprise-4.19
[enterprise-4.19] [OSDOCS-15316]: Revising formatting in HCP bare metal docs
2 parents 5298c55 + 02dc4dd commit 9b274b2

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,54 +17,62 @@ The {hcp} feature is enabled by default.
1717

1818
The {mce-short} supports only the default `local-cluster`, which is a hub cluster that is managed, and the hub cluster as the management cluster. If you have Red{nbsp}Hat Advanced Cluster Management installed, you can use the managed hub cluster, also known as the `local-cluster`, as the management cluster.
1919

20-
A _hosted cluster_ is an {product-title} cluster with its API endpoint and control plane that are hosted on the management cluster. The hosted cluster includes the control plane and its corresponding data plane. You can use the {mce-short} console or the hosted control plane command-line interface, `hcp`, to create a hosted cluster.
20+
A _hosted cluster_ is an {product-title} cluster with its API endpoint and control plane that are hosted on the management cluster. The hosted cluster includes the control plane and its corresponding data plane. You can use the {mce-short} console or the hosted control plane command-line interface (`hcp`) to create a hosted cluster.
2121

22-
The hosted cluster is automatically imported as a managed cluster. If you want to disable this automatic import feature, see _Disabling the automatic import of hosted clusters into {mce-short}_.
22+
The hosted cluster is automatically imported as a managed cluster. If you want to disable this automatic import feature, see "Disabling the automatic import of hosted clusters into {mce-short}".
2323

2424
include::modules/hcp-bm-prepare.adoc[leveloffset=+1]
25+
2526
include::modules/hcp-bm-prereqs.adoc[leveloffset=+2]
2627

2728
[role="_additional-resources"]
2829
.Additional resources
30+
2931
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#advanced-config-engine[Advanced configuration]
3032
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#enable-cim[Enabling the central infrastructure management service]
3133
3234
include::modules/hcp-bm-firewall-port-svc-reqs.adoc[leveloffset=+2]
3335

3436
[role="_additional-resources"]
3537
.Additional resources
38+
3639
* xref:../../networking/configuring_network_settings/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[Configuring the cluster-wide proxy]
3740
3841
include::modules/hcp-bm-infra-reqs.adoc[leveloffset=+2]
3942

4043
[role="_additional-resources"]
4144
.Additional resources
45+
4246
* xref:../../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
4347
* xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc[Persistent storage using {lvms}]
4448
* xref:../../hosted_control_planes/hcp-import.adoc#hcp-import-disable_hcp-import[Disabling the automatic import of hosted clusters into {mce-short}]
4549
* xref:../../hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc[Enabling or disabling the {hcp} feature]
4650
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#ansible-config-hosted-cluster[Configuring Ansible Automation Platform jobs to run on hosted clusters]
4751
4852
include::modules/hcp-bm-dns.adoc[leveloffset=+1]
53+
4954
include::modules/hcp-custom-dns.adoc[leveloffset=+2]
5055

5156
include::modules/hcp-bm-hc.adoc[leveloffset=+1]
5257

5358
[role="_additional-resources"]
5459
.Additional resources
60+
5561
* xref:../../hosted_control_planes/hcp-import.adoc[Manually importing a hosted cluster]
5662
5763
include::modules/hcp-bm-hc-console.adoc[leveloffset=+2]
5864

5965
.Next steps
66+
6067
* To access the web console, see xref:../../web_console/web-console.adoc#web-console-overview[Accessing the web console].
6168
6269
include::modules/hcp-bm-hc-mirror.adoc[leveloffset=+2]
6370

6471
.Next steps
72+
6573
* To create credentials that you can reuse when you create a hosted cluster with the console, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#creating-a-credential-for-an-on-premises-environment[Creating a credential for an on-premises environment].
6674
* To access a hosted cluster, see xref:../../hosted_control_planes/hcp-manage/hcp-manage-bm.adoc#hcp-bm-access_hcp-manage-bm[Accessing the hosted cluster].
6775
* To add hosts to the host inventory by using the Discovery Image, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#add-host-host-inventory[Adding hosts to the host inventory by using the Discovery Image].
6876
* To extract the {product-title} release image digest, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#configure-hosted-disconnected-digest-image[Extracting the {product-title} release image digest].
6977
70-
include::modules/hcp-bm-verify.adoc[leveloffset=+1]
78+
include::modules/hcp-bm-verify.adoc[leveloffset=+1]

modules/hcp-bm-hc-console.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To create a hosted cluster by using the console, complete the following steps.
1010

1111
.Procedure
1212

13-
. Open the {product-title} web console and log in by entering your administrator credentials. For instructions to open the console, see _Accessing the web console_.
13+
. Open the {product-title} web console and log in by entering your administrator credentials. For instructions to open the console, see "Accessing the web console".
1414

1515
. In the console header, ensure that **All Clusters** is selected.
1616

@@ -28,7 +28,7 @@ The **Create cluster** page is displayed.
2828
====
2929
As you enter details about the cluster, you might find the following tips useful:
3030
31-
** If you want to use predefined values to automatically populate fields in the console, you can create a host inventory credential. For more information, see _Creating a credential for an on-premises environment_.
31+
** If you want to use predefined values to automatically populate fields in the console, you can create a host inventory credential. For more information, see "Creating a credential for an on-premises environment".
3232
3333
** On the *Cluster details* page, the pull secret is your {product-title} pull secret that you use to access {product-title} resources. If you selected a host inventory credential, the pull secret is automatically populated.
3434

modules/hcp-bm-hc-mirror.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@ $ hcp create cluster agent \
5252
<6> Specify the `icsp.yaml` file that defines ICSP and your mirror registries.
5353
<7> Specify the path to your SSH public key. The default file path is `~/.ssh/id_rsa.pub`.
5454
<8> Specify your hosted cluster namespace.
55-
<9> Specify the supported {product-title} version that you want to use, for example, `4.19.0-multi`. If you are using a disconnected environment, replace `<ocp_release_image>` with the digest image. To extract the {product-title} release image digest, see _Extracting the {product-title} release image digest_.
55+
<9> Specify the supported {product-title} version that you want to use, for example, `4.19.0-multi`. If you are using a disconnected environment, replace `<ocp_release_image>` with the digest image. To extract the {product-title} release image digest, see "Extracting the {product-title} release image digest".

0 commit comments

Comments
 (0)