Skip to content

Commit aa2bd16

Browse files
Merge pull request #67825 from lahinson/osdocs-5364-tp-wording-hcp
2 parents c8e7e21 + 10da0c9 commit aa2bd16

10 files changed

+49
-52
lines changed

hosted_control_planes/hcp-backup-restore-dr.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ toc::[]
88

99
If you need to back up and restore etcd on a hosted cluster or provide disaster recovery for a hosted cluster, see the following procedures.
1010

11-
:FeatureName: Hosted control planes
12-
include::snippets/technology-preview.adoc[]
13-
1411
[id="hosted-etcd-non-disruptive-recovery"]
1512
== Recovering etcd pods for hosted clusters
1613

@@ -21,11 +18,14 @@ include::modules/hosted-cluster-single-node-recovery.adoc[leveloffset=+2]
2118
include::modules/hosted-cluster-etcd-quorum-loss-recovery.adoc[leveloffset=+2]
2219

2320
[id="hcp-backup-restore"]
24-
== Backing up and restoring etcd on a hosted cluster in AWS
21+
== Backing up and restoring etcd on a hosted cluster on {aws-short}
2522

2623
If you use hosted control planes for {product-title}, the process to back up and restore etcd is different from xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[the usual etcd backup process].
2724

28-
The following procedures are specific to hosted control planes on AWS.
25+
The following procedures are specific to hosted control planes on {aws-short}.
26+
27+
:FeatureName: Hosted control planes on the {aws-short} platform
28+
include::snippets/technology-preview.adoc[]
2929

3030
// Backing up etcd on a hosted cluster
3131
include::modules/backup-etcd-hosted-cluster.adoc[leveloffset=+2]
@@ -34,9 +34,9 @@ include::modules/backup-etcd-hosted-cluster.adoc[leveloffset=+2]
3434
include::modules/restoring-etcd-snapshot-hosted-cluster.adoc[leveloffset=+2]
3535

3636
[id="hcp-dr-aws"]
37-
== Disaster recovery for a hosted cluster within an AWS region
37+
== Disaster recovery for a hosted cluster within an {aws-short} region
3838

39-
In a situation where you need disaster recovery (DR) for a hosted cluster, you can recover a hosted cluster to the same region within AWS. For example, you need DR when the upgrade of a management cluster fails and the hosted cluster is in a read-only state.
39+
In a situation where you need disaster recovery (DR) for a hosted cluster, you can recover a hosted cluster to the same region within {aws-short}. For example, you need DR when the upgrade of a management cluster fails and the hosted cluster is in a read-only state.
4040

4141
:FeatureName: Hosted control planes
4242
include::snippets/technology-preview.adoc[]
@@ -78,10 +78,10 @@ Consider an scenario where you have three clusters to restore. Two are managemen
7878
* HC Kubeconfig: The hosted cluster `kubeconfig` file
7979
* SSH key file: The SSH public key
8080
* Pull secret: The pull secret file to access the release images
81-
* AWS credentials
82-
* AWS region
81+
* {aws-short} credentials
82+
* {aws-short} region
8383
* Base domain: The DNS base domain to use as an external DNS
84-
* S3 bucket name: The bucket in the AWS region where you plan to upload the etcd backup
84+
* S3 bucket name: The bucket in the {aws-short} region where you plan to upload the etcd backup
8585

8686
This information is shown in the following example environment variables.
8787

@@ -166,5 +166,4 @@ include::modules/dr-hosted-cluster-within-aws-region-restore.adoc[leveloffset=+2
166166
include::modules/dr-hosted-cluster-within-aws-region-delete.adoc[leveloffset=+2]
167167

168168
//Helper script
169-
include::modules/dr-hosted-cluster-within-aws-region-script.adoc[leveloffset=+2]
170-
169+
include::modules/dr-hosted-cluster-within-aws-region-script.adoc[leveloffset=+2]

hosted_control_planes/hcp-configuring.adoc

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,46 @@ toc::[]
88

99
To get started with hosted control planes for {product-title}, you first configure your hosted cluster on the provider that you want to use. Then, you complete a few management tasks.
1010

11-
:FeatureName: Hosted control planes
12-
include::snippets/technology-preview.adoc[]
13-
1411
You can view the procedures by selecting from one of the following providers:
1512

16-
[id="hcp-configuring-aws"]
17-
== Amazon Web Services (AWS)
18-
19-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#hosting-cluster-aws-infra-reqs[AWS infrastructure requirements]: Review the infrastructure requirements to create a hosted cluster on AWS.
20-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#hosting-service-cluster-configure-aws[Configuring the hosting cluster on AWS]: The tasks to configure a hosted cluster on AWS include creating the AWS S3 OIDC secret, creating a routable public zone, enabling external DNS, enabling AWS PrivateLink, enabling the hosted control planes feature, and installing the hosted control planes CLI.
21-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#hosted-control-planes-manage-aws[Managing hosted control plane clusters on AWS]: Management tasks include creating, importing, accessing, or deleting a hosted cluster on AWS.
22-
* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#sriov-operator-hosted-control-planes_configuring-sriov-operator[Deploying the SR-IOV Operator for hosted control planes]: After you configure and deploy your hosting service cluster, you can create a subscription to the Single Root I/O Virtualization (SR-IOV) Operator on a hosted cluster. The SR-IOV pod runs on worker machines rather than the control plane.
23-
* xref:../scalability_and_performance/using-node-tuning-operator.adoc#node-tuning-hosted-cluster_node-tuning-operator[Configuring node tuning in a hosted cluster]: To set node-level tuning on the nodes in your hosted cluster, you can use the Node Tuning Operator. In hosted control planes, you can configure node tuning by creating config maps that contain `Tuned` objects and referencing those config maps in your node pools.
24-
* xref:../scalability_and_performance/using-node-tuning-operator.adoc#advanced-node-tuning-hosted-cluster_node-tuning-operator[Advanced node tuning for hosted clusters by setting kernel boot parameters]: More advanced tuning in hosted control planes requires setting kernel boot parameters.
25-
2613
[id="hcp-configuring-bm"]
2714
== Bare metal
2815

29-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#infrastructure-reqs-bare-metal[Bare metal infrastructure requirements]: Review the infrastructure requirements to create a hosted cluster on bare metal.
30-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-configure-bm[Configuring the hosting cluster on bare metal]:
16+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#infrastructure-reqs-bare-metal[Bare metal infrastructure requirements]: Review the infrastructure requirements to create a hosted cluster on bare metal.
17+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-configure-bm[Configuring the hosting cluster on bare metal]:
3118
** Configure DNS
3219
** Create an `InfraEnv` resource and add agents to it
3320
** Create a hosted cluster and verify cluster creation
34-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#hosted-control-planes-manage-bm[Managing hosted control plane clusters on bare metal]:
21+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-manage-bm[Managing hosted control plane clusters on bare metal]:
3522
** Scale the `NodePool` object for a hosted cluster
36-
** Handle Ingress for a hosted cluster
23+
** Handle ingress traffic for a hosted cluster
3724
** Enable node auto-scaling for a hosted cluster
3825
** Destroy a hosted cluster
3926

4027
[id="hcp-configuring-virt"]
4128
== {VirtProductName}
4229

43-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#hosted-control-planes-manage-kubevirt[Managing hosted control plane clusters on OpenShift Virtualization]: Create {product-title} clusters with worker nodes that are hosted by KubeVirt virtual machines.
30+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-manage-kubevirt[Managing hosted control plane clusters on OpenShift Virtualization]: Create {product-title} clusters with worker nodes that are hosted by KubeVirt virtual machines.
4431

45-
// To be added after ACM 2.9 goes live:
32+
[id="hcp-configuring-aws"]
33+
== {aws-first}
4634

47-
// IBM Power
48-
// IBM Z
35+
:FeatureName: Hosted control planes on the {aws-short} platform
36+
include::snippets/technology-preview.adoc[]
4937

38+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosting-cluster-aws-infra-reqs[AWS infrastructure requirements]: Review the infrastructure requirements to create a hosted cluster on {aws-short}.
39+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosting-service-cluster-configure-aws[Configuring the hosting cluster on AWS]: The tasks to configure a hosted cluster on {aws-short} include creating the {aws-short} S3 OIDC secret, creating a routable public zone, enabling external DNS, enabling {aws-short} PrivateLink, enabling the hosted control planes feature, and installing the hosted control planes CLI.
40+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-manage-aws[Managing hosted control plane clusters on AWS]: Management tasks include creating, importing, accessing, or deleting a hosted cluster on {aws-short}.
41+
* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#sriov-operator-hosted-control-planes_configuring-sriov-operator[Deploying the SR-IOV Operator for hosted control planes]: After you configure and deploy your hosting service cluster, you can create a subscription to the Single Root I/O Virtualization (SR-IOV) Operator on a hosted cluster. The SR-IOV pod runs on worker machines rather than the control plane.
5042

43+
[id="hcp-configuring-ibmz"]
44+
== {ibm-z-title}
5145

46+
:FeatureName: Hosted control planes on the {ibm-z-title} platform
47+
include::snippets/technology-preview.adoc[]
48+
49+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-ibmz[Configuring the hosting cluster on x86 bare metal for IBM Z compute nodes]
50+
51+
// To be added after ACM 2.9 goes live:
5252

53+
//{ibmpowerProductName}

hosted_control_planes/hcp-managing.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ toc::[]
88

99
After you configure your environment for hosted control planes and create a hosted cluster, you can further manage your clusters and nodes.
1010

11-
:FeatureName: Hosted control planes
12-
include::snippets/technology-preview.adoc[]
13-
1411
include::modules/updates-for-hosted-control-planes.adoc[leveloffset=+1]
1512
include::modules/updating-node-pools-for-hcp.adoc[leveloffset=+1]
1613
//restarting hosted control plane components

hosted_control_planes/hcp-troubleshooting.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,8 @@ If you encounter issues with hosted control planes, see the following informatio
1212
include::snippets/technology-preview.adoc[]
1313

1414
include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1]
15-
include::modules/debug-nodes-hcp.adoc[leveloffset=+1]
15+
16+
[role="_additional-resources"]
17+
.Additional resources
18+
19+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#trouble-hosted-cluster-backplane[Must-gather for a hosted cluster]

hosted_control_planes/index.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@ include::modules/hosted-control-planes-overview.adoc[leveloffset=+1]
1212

1313
[role="_additional-resources"]
1414
.Additional resources
15-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#hypershift-addon-intro[HyperShift add-on (Technology Preview)]
1615

17-
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#hosted-control-planes-intro[Hosted control planes (Technology Preview)]
16+
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-intro[Hosted control planes]
1817
1918
include::modules/hosted-control-planes-concepts-personas.adoc[leveloffset=+1]
2019
include::modules/hosted-control-planes-version-support.adoc[leveloffset=+1]
20+
21+
[role="_additional-resources"]
22+
.Additional resources
23+
24+
* xref:../scalability_and_performance/using-node-tuning-operator.adoc#node-tuning-hosted-cluster_node-tuning-operator[Configuring node tuning in a hosted cluster]
25+
* xref:../scalability_and_performance/using-node-tuning-operator.adoc#advanced-node-tuning-hosted-cluster_node-tuning-operator[Advanced node tuning for hosted clusters by setting kernel boot parameters]

modules/advanced-node-tuning-hosted-cluster.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
[id="advanced-node-tuning-hosted-cluster_{context}"]
88
= Advanced node tuning for hosted clusters by setting kernel boot parameters
99

10-
:FeatureName: Hosted control planes
11-
include::snippets/technology-preview.adoc[]
12-
1310
For more advanced tuning in hosted control planes, which requires setting kernel boot parameters, you can also use the Node Tuning Operator. The following example shows how you can create a node pool with huge pages reserved.
1411

1512
.Procedure

modules/hosted-control-planes-overview.adoc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,11 @@
66

77
:_mod-docs-content-type: CONCEPT
88
[id="hosted-control-planes-overview_{context}"]
9-
= Introduction to hosted control planes (Technology Preview)
9+
= Introduction to hosted control planes
1010

1111
You can use hosted control planes for Red Hat {product-title} to reduce management costs, optimize cluster deployment time, and separate management and workload concerns so that you can focus on your applications.
1212

13-
You can enable hosted control planes as a Technology Preview feature by using the link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#cluster_mce_overview[multicluster engine for Kubernetes operator version 2.0 or later] on Amazon Web Services (AWS), bare metal by using the Agent provider, or {VirtProductName}.
14-
15-
:FeatureName: Hosted control planes
16-
include::snippets/technology-preview.adoc[]
13+
You can enable hosted control planes by using the link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#cluster_mce_overview[multicluster engine for Kubernetes operator version 2.0 or later] on bare metal by using the Agent provider, or {VirtProductName}. Hosted control planes is available as a Technology Preview feature on the {aws-first} and {ibm-z-title} platforms.
1714

1815
[id="hosted-control-planes-architecture_{context}"]
1916
== Architecture of hosted control planes

modules/node-tuning-hosted-cluster.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88

99
//# Manage node-level tuning with the Node Tuning Operator
1010

11-
:FeatureName: Hosted control planes
12-
include::snippets/technology-preview.adoc[]
13-
1411
To set node-level tuning on the nodes in your hosted cluster, you can use the Node Tuning Operator. In hosted control planes, you can configure node tuning by creating config maps that contain `Tuned` objects and referencing those config maps in your node pools.
1512

1613
.Procedure

modules/sriov-operator-hosted-control-planes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[id="sriov-operator-hosted-control-planes_{context}"]
88
= Deploying the SR-IOV Operator for hosted control planes
99

10-
:FeatureName: Hosted control planes
10+
:FeatureName: Hosted control planes on the AWS platform
1111
include::snippets/technology-preview.adoc[]
1212

1313
[role="_abstract"]

scalability_and_performance/using-node-tuning-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ include::modules/advanced-node-tuning-hosted-cluster.adoc[leveloffset=+1]
3030
[role="_additional-resources"]
3131
.Additional resources
3232

33-
For more information about hosted control planes, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#hosted-control-planes-intro[Hosted control planes (Technology Preview)].
33+
For more information about hosted control planes, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-intro[Hosted control planes].

0 commit comments

Comments
 (0)