1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

Adding structure for new HCP topics

This commit is contained in:
Laura Hinson
2024-08-12 16:54:13 -04:00
committed by openshift-cherrypick-robot
parent 40679bd90e
commit d3bc2bee04
43 changed files with 255 additions and 97 deletions

View File

@@ -2351,18 +2351,55 @@ Distros: openshift-enterprise, openshift-origin
Topics:
- Name: Hosted control planes overview
File: index
- Name: Getting started with hosted control planes
File: hcp-getting-started
- Name: Authentication and authorization for hosted control planes
File: hcp-authentication-authorization
- Name: Handling a machine configuration for hosted control planes
File: hcp-machine-config
- Name: Using feature gates in a hosted cluster
File: hcp-using-feature-gates
- Name: Preparing to deploy hosted control planes
Dir: hcp-prepare
Topics:
- Name: Requirements for hosted control planes
File: hcp-requirements
- Name: Hosted control planes sizing guidance
File: hcp-sizing-guidance
- Name: Overriding resouce utilization measurements
File: hcp-override-resource-util
- Name: Installing the hosted control plane command line interface
File: hcp-cli
- Name: Distributing hosted cluster workloads
File: hcp-distribute-workloads
- Name: Deploying hosted control planes
Dir: hcp-deploy
Topics:
- Name: Deploying hosted control planes on AWS
File: hcp-deploy-aws
- Name: Deploying hosted control planes on bare metal
File: hcp-deploy-bm
- Name: Deploying hosted conrol planes on OpenShift Virtualization
File: hcp-deploy-virt
- Name: Deploying hosted control planes on non-bare metal agent machines
File: hcp-deploy-non-bm
- Name: Deploying hosted control planes on IBM Z
File: hcp-deploy-ibmz
- Name: Deploying hosted control planes on IBM Power
File: hcp-deploy-ibmpower
- Name: Managing hosted control planes
Dir: hcp-manage
Topics:
- Name: Managing hosted control planes on AWS
File: hcp-manage-aws
- Name: Managing hosted control planes on bare metal
File: hcp-manage-bm
- Name: Managing hosted control planes on OpenShift Virtualization
File: hcp-manage-virt
- Name: Managing hosted control planes on non-bare metal agent machines
File: hcp-manage-non-bm
- Name: Managing hosted control planes on IBM Z
File: hcp-manage-ibmz
- Name: Managing hosted control planes on IBM Power
File: hcp-manage-ibmpower
- Name: Preparing to deploy hosted control planes in a disconnected environment
File: hcp-prepare-disconnected
- Name: Deploying hosted control planes in a disconnected environment
File: hcp-deploy-disconnected
- Name: Updating hosted control planes
File: hcp-updating
- Name: Hosted control planes Observability
File: hcp-observability
- Name: High availability for hosted control planes
Dir: hcp_high_availability
Topics:
@@ -2378,8 +2415,27 @@ Topics:
File: hcp-disaster-recovery-aws
- Name: Disaster recovery for a hosted cluster by using OADP
File: hcp-disaster-recovery-oadp
- Name: Authentication and authorization for hosted control planes
File: hcp-authentication-authorization
- Name: Handling machine configuration for hosted control planes
File: hcp-machine-config
- Name: Using feature gates in a hosted cluster
File: hcp-using-feature-gates
- Name: Observability for hosted control planes
File: hcp-observability
- Name: Troubleshooting hosted control planes
File: hcp-troubleshooting
- Name: Destroying a hosted cluster
Dir: hcp-destroy
Topics:
- Name: Destroying a hosted cluster on AWS
File: hcp-destroy-aws
- Name: Destroying a hosted cluster on bare metal
File: hcp-destroy-bm
- Name: Destroying a hosted cluster on OpenShift Virtualization
File: hcp-destroy-virt
- Name: Destroying a hosted cluster on IBM Z
File: hcp-destroy-ibmz
---
Name: Nodes
Dir: nodes

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-deploy-disconnected"]
include::_attributes/common-attributes.adoc[]
= Deploying {hcp} in a disconnected environment
:context: hcp-deploy-disconnected
toc::[]

View File

@@ -0,0 +1 @@
../../_attributes/

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-deploy-aws"]
include::_attributes/common-attributes.adoc[]
= Deploying {hcp} on AWS
:context: hcp-deploy-aws
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-deploy-bm"]
include::_attributes/common-attributes.adoc[]
= Deploying {hcp} on bare metal
:context: hcp-deploy-bm
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-deploy-ibmpower"]
include::_attributes/common-attributes.adoc[]
= Deploying {hcp} on {ibm-power-title}
:context: hcp-deploy-ibmpower
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-deploy-ibmz"]
include::_attributes/common-attributes.adoc[]
= Deploying {hcp} on {ibm-z-title}
:context: hcp-deploy-ibmz
toc::[]

View File

@@ -0,0 +1,9 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-deploy-non-bm"]
include::_attributes/common-attributes.adoc[]
= Deploying {hcp} on non-bare metal agent machines
:context: hcp-deploy-non-bm
toc::[]

View File

@@ -0,0 +1,8 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-deploy-virt"]
include::_attributes/common-attributes.adoc[]
= Deploying {hcp} on {VirtProductName}
:context: hcp-deploy-virt
toc::[]

View File

@@ -0,0 +1 @@
../../images

View File

@@ -0,0 +1 @@
../../modules

View File

@@ -0,0 +1 @@
../../snippets

View File

@@ -0,0 +1 @@
../../_attributes/

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-destroy-aws"]
include::_attributes/common-attributes.adoc[]
= Destroying a hosted cluster on AWS
:context: hcp-destroy-aws
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-destroy-bm"]
include::_attributes/common-attributes.adoc[]
= Destroying a hosted cluster on bare metal
:context: hcp-destroy-bm
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-destroy-ibmz"]
include::_attributes/common-attributes.adoc[]
= Destroying a hosted cluster on {ibm-z-title}
:context: hcp-destroy-ibmz
toc::[]

View File

@@ -0,0 +1,8 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-destroy-virt"]
include::_attributes/common-attributes.adoc[]
= Destroying a hosted cluster on {VirtProductName}
:context: hcp-destroy-virt
toc::[]

View File

@@ -0,0 +1 @@
../../images

View File

@@ -0,0 +1 @@
../../modules

View File

@@ -0,0 +1 @@
../../snippets

View File

@@ -1,85 +0,0 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-getting-started"]
include::_attributes/common-attributes.adoc[]
= Getting started with {hcp}
:context: hcp-getting-started
toc::[]
To get started with {hcp} for {product-title}, you first configure your hosted cluster on the provider that you want to use. Then, you complete a few management tasks.
You can view the procedures by selecting from one of the following providers:
[id="hcp-getting-started-bm"]
== Bare metal
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-sizing-guidance[Hosted control plane sizing guidance]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-cluster-workload-distributing[Distributing hosted cluster workloads]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#firewall-port-reqs-bare-metal[Bare metal firewall and port requirements]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/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.
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-configure-bm[Configuring hosted control plane clusters on bare metal]:
** Configure DNS
** Create a hosted cluster and verify cluster creation
** Scale the `NodePool` object for the hosted cluster
** Handle ingress traffic for the hosted cluster
** Enable node auto-scaling for the hosted cluster
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configure-hosted-disconnected[Configuring {hcp} in a disconnected environment]
* To destroy a hosted cluster on bare metal, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-bm[Destroying a hosted cluster on bare metal].
* If you want to disable the hosted control plane feature, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#disable-hosted-control-planes[Disabling the hosted control plane feature].
[id="hcp-getting-started-virt"]
== {VirtProductName}
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-sizing-guidance[Hosted control plane sizing guidance]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-cluster-workload-distributing[Distributing hosted cluster workloads]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/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.
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configure-hosted-disconnected[Configuring {hcp} in a disconnected environment]
* To destroy a hosted cluster is on {VirtProductName}, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-kubevirt[Destroying a hosted cluster on OpenShift Virtualization].
* If you want to disable the hosted control plane feature, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#disable-hosted-control-planes[Disabling the hosted control plane feature].
[id="hcp-getting-started-aws"]
== {aws-first}
:FeatureName: {hcp-capital} on the {aws-short} platform
include::snippets/technology-preview.adoc[]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/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}.
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosting-service-cluster-configure-aws[Configuring hosted control plane clusters on AWS (Technology Preview)]: The tasks to configure hosted control plane clusters on {aws-short} include creating the {aws-short} S3 OIDC secret, creating a routable public zone, enabling external DNS, enabling {aws-short} PrivateLink, and deploying a hosted cluster.
* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#sriov-operator-hosted-control-planes_configuring-sriov-operator[Deploying the SR-IOV Operator for {hcp}]: 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.
* To destroy a hosted cluster on AWS, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-aws[Destroying a hosted cluster on AWS].
* If you want to disable the hosted control plane feature, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#disable-hosted-control-planes[Disabling the hosted control plane feature].
[id="hcp-getting-started-ibmz"]
== {ibm-z-title}
:FeatureName: {hcp-capital} on the {ibm-z-title} platform
include::snippets/technology-preview.adoc[]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-ibmz[Configuring the hosting cluster on x86 bare metal for IBM Z compute nodes (Technology Preview)]
[id="hcp-getting-started-ibmpower"]
== {ibm-power-title}
:FeatureName: {hcp-capital} on the {ibm-power-title} platform
include::snippets/technology-preview.adoc[]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#config-hosted-service-ibmpower[Configuring the hosting cluster on a 64-bit x86 OpenShift Container Platform cluster to create {hcp} for IBM Power compute nodes (Technology Preview)]
[id="hcp-getting-started-non-bm-agent"]
== Non bare metal agent machines
:FeatureName: {hcp-capital} clusters using non bare metal agent machines
include::snippets/technology-preview.adoc[]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-configure-agent-non-bm[Configuring hosted control plane clusters using non bare metal agent machines (Technology Preview)]
* To destroy a hosted cluster on non bare metal agent machines, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-non-bm[Destroying a hosted cluster on non bare metal agent machines]
* If you want to disable the hosted control plane feature, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#disable-hosted-control-planes[Disabling the hosted control plane feature].

View File

@@ -1,7 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-machine-config"]
include::_attributes/common-attributes.adoc[]
= Handling a machine configuration for {hcp}
= Handling machine configuration for {hcp}
:context: hcp-machine-config
toc::[]

View File

@@ -0,0 +1 @@
../../_attributes/

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-manage-aws"]
include::_attributes/common-attributes.adoc[]
= Managing {hcp} on AWS
:context: hcp-managing-aws
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-manage-bm"]
include::_attributes/common-attributes.adoc[]
= Managing {hcp} on bare metal
:context: hcp-manage-bm
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-manage-ibmpower"]
include::_attributes/common-attributes.adoc[]
= Managing {hcp} on {ibm-power-title}
:context: hcp-manage-ibmpower
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-manage-ibmz"]
include::_attributes/common-attributes.adoc[]
= Managing {hcp} on {ibm-z-title}
:context: hcp-manage-ibmz
toc::[]

View File

@@ -0,0 +1,9 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-manage-non-bm"]
include::_attributes/common-attributes.adoc[]
= Managing {hcp} on non-bare metal agent machines
:context: hcp-manage-non-bm
toc::[]

View File

@@ -0,0 +1,8 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-manage-virt"]
include::_attributes/common-attributes.adoc[]
= Managing {hcp} on {VirtProductName}
:context: hcp-manage-virt
toc::[]

View File

@@ -0,0 +1 @@
../../images

View File

@@ -0,0 +1 @@
../../modules

View File

@@ -0,0 +1 @@
../../snippets

View File

@@ -1,7 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-observability"]
include::_attributes/common-attributes.adoc[]
= {hcp-capital} Observability
= Observability for {hcp}
:context: hcp-observability
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-prepare-disconnected"]
include::_attributes/common-attributes.adoc[]
= Preparing to deploy {hcp} in a disconnected environment
:context: hcp-prepare-disconnected
toc::[]

View File

@@ -0,0 +1 @@
../../_attributes/

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-cli"]
include::_attributes/common-attributes.adoc[]
= Installing the {hcp} command line interface
:context: hcp-cli
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-distribute-workloads"]
= Distributing hosted cluster workloads
include::_attributes/common-attributes.adoc[]
:context: hcp-distribute-workloads
toc::[]

View File

@@ -0,0 +1,8 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-override-resource-util"]
= Overriding resource utilization measurements
include::_attributes/common-attributes.adoc[]
:context: hcp-override-resource-util
toc::[]

View File

@@ -0,0 +1,9 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-requirements"]
include::_attributes/common-attributes.adoc[]
= Requirements for {hcp}
:context: hcp-requirements
toc::[]

View File

@@ -0,0 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-sizing-guidance"]
include::_attributes/common-attributes.adoc[]
= Sizing guidance for {hcp}
:context: hcp-sizing-guidance
toc::[]

View File

@@ -0,0 +1 @@
../../images

View File

@@ -0,0 +1 @@
../../modules

View File

@@ -0,0 +1 @@
../../snippets