Skip to content

Commit 022f2ed

Browse files
authored
Merge pull request #80675 from lahinson/osdocs-11001-hcp-disconnected
[OSDOCS-11001]: Moving HCP disconnected docs
2 parents 7255133 + 4f76b9a commit 022f2ed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+2052
-27
lines changed

_topic_maps/_topic_map.yml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2425,7 +2425,7 @@ Topics:
24252425
File: hcp-deploy-aws
24262426
- Name: Deploying hosted control planes on bare metal
24272427
File: hcp-deploy-bm
2428-
- Name: Deploying hosted conrol planes on OpenShift Virtualization
2428+
- Name: Deploying hosted control planes on OpenShift Virtualization
24292429
File: hcp-deploy-virt
24302430
- Name: Deploying hosted control planes on non-bare metal agent machines
24312431
File: hcp-deploy-non-bm
@@ -2446,10 +2446,17 @@ Topics:
24462446
File: hcp-manage-non-bm
24472447
- Name: Managing hosted control planes on IBM Power
24482448
File: hcp-manage-ibmpower
2449-
- Name: Preparing to deploy hosted control planes in a disconnected environment
2450-
File: hcp-prepare-disconnected
24512449
- Name: Deploying hosted control planes in a disconnected environment
2452-
File: hcp-deploy-disconnected
2450+
Dir: hcp-disconnected
2451+
Topics:
2452+
- Name: Introduction to hosted control planes in a disconnected environment
2453+
File: hcp-deploy-dc
2454+
- Name: Deploying hosted control planes on OpenShift Virtualization in a disconnected environment
2455+
File: hcp-deploy-dc-virt
2456+
- Name: Deploying hosted control planes on bare metal in a disconnected environment
2457+
File: hcp-deploy-dc-bm
2458+
- Name: Monitoring user workload in a disconnected environment
2459+
File: hcp-dc-monitor
24532460
- Name: Updating hosted control planes
24542461
File: hcp-updating
24552462
- Name: High availability for hosted control planes

hosted_control_planes/hcp-deploy-disconnected.adoc

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_attributes/
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="hcp-dc-monitor"]
3+
include::_attributes/common-attributes.adoc[]
4+
= Monitoring user workload in a disconnected environment
5+
:context: hcp-dc-monitor
6+
7+
toc::[]
8+
9+
The `hypershift-addon` managed cluster add-on enables the `--enable-uwm-telemetry-remote-write` option in the HyperShift Operator. By enabling that option, you ensure that user workload monitoring is enabled and that it can remotely write telemetry metrics from control planes.
10+
11+
include::modules/hcp-dc-usr-wkld.adoc[leveloffset=+1]
12+
include::modules/hcp-dc-verify.adoc[leveloffset=+1]
13+
include::modules/hcp-dc-addon.adoc[leveloffset=+1]
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="hcp-deploy-dc-bm"]
3+
include::_attributes/common-attributes.adoc[]
4+
= Deploying {hcp} on bare metal in a disconnected environment
5+
:context: hcp-deploy-dc-bm
6+
7+
toc::[]
8+
9+
When you provision hosted control planes on bare metal, you use the Agent platform. The Agent platform and {mce} work together to enable disconnected deployments. The Agent platform uses the central infrastructure management service to add worker nodes to a hosted cluster. For an introduction to the central infrastructure management service, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#enable-cim[Enabling the central infrastructure management service].
10+
11+
include::modules/hcp-dc-bm-arch.adoc[leveloffset=+1]
12+
include::modules/hcp-dc-bm-reqs.adoc[leveloffset=+1]
13+
include::modules/hcp-dc-extract.adoc[leveloffset=+1]
14+
include::modules/hcp-dc-hypervisor.adoc[leveloffset=+1]
15+
include::modules/hcp-bm-dns.adoc[leveloffset=+1]
16+
include::modules/hcp-dc-registry.adoc[leveloffset=+1]
17+
include::modules/hcp-dc-mgmt-cluster.adoc[leveloffset=+1]
18+
include::modules/hcp-dc-web-server.adoc[leveloffset=+1]
19+
include::modules/hcp-dc-image-mirror.adoc[leveloffset=+1]
20+
include::modules/hcp-dc-apply-objects.adoc[leveloffset=+1]
21+
22+
[role="_additional-resources"]
23+
.Additional resources
24+
* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin].
25+
26+
[id="hcp-dc-mce-bm"]
27+
== Deploying {mce-short} for a disconnected installation of {hcp}
28+
29+
The {mce} plays a crucial role in deploying clusters across providers. If you do not have {mce-short} installed, review the following documentation to understand the prerequisites and steps to install it:
30+
31+
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#mce-intro[About cluster lifecycle with multicluster engine operator]
32+
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#mce-install-intro[Installing and upgrading multicluster engine operator]
33+
34+
include::modules/hcp-agentserviceconfig.adoc[leveloffset=+2]
35+
36+
[id="hcp-dc-tls-bm"]
37+
== Configuring TLS certificates for a disconnected installation of {hcp}
38+
39+
To ensure proper function in a disconnected deployment, you need to configure the registry CA certificates in the management cluster and the worker nodes for the hosted cluster.
40+
41+
include::modules/hcp-dc-tls-mgmt.adoc[leveloffset=+2]
42+
include::modules/hcp-dc-tls-hosted.adoc[leveloffset=+2]
43+
44+
[id="hcp-dc-bm-hosted"]
45+
== Creating a hosted cluster on bare metal
46+
47+
A hosted cluster is an {product-title} cluster with its control plane and API endpoint hosted on a management cluster. The hosted cluster includes the control plane and its corresponding data plane.
48+
49+
include::modules/hcp-hc-objects.adoc[leveloffset=+2]
50+
include::modules/hcp-nodepool-hc.adoc[leveloffset=+2]
51+
include::modules/hcp-dc-infraenv.adoc[leveloffset=+2]
52+
include::modules/hcp-worker-hc.adoc[leveloffset=+2]
53+
include::modules/hcp-bm-hosts.adoc[leveloffset=+2]
54+
include::modules/hcp-dc-scale-np.adoc[leveloffset=+2]
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="hcp-deploy-dc-virt"]
3+
include::_attributes/common-attributes.adoc[]
4+
= Deploying {hcp} on {VirtProductName} in a disconnected environment
5+
:context: hcp-deploy-dc-virt
6+
7+
toc::[]
8+
9+
When you deploy {hcp} in a disconnected environment, some of the steps differ depending on the platform you use. The following procedures are specific to deployments on {VirtProductName}.
10+
11+
:FeatureName: {hcp-capital} on {VirtProductName} in a disconnected environment
12+
include::snippets/technology-preview.adoc[]
13+
14+
[id="prerequisites_{context}"]
15+
== Prerequisites
16+
17+
* You have a disconnected {product-title} environment serving as your management cluster.
18+
* You have an internal registry to mirror images on. For more information, see xref:../../disconnected/mirroring/index.adoc#installing-mirroring-disconnected-about[About disconnected installation mirroring].
19+
20+
include::modules/hcp-dc-image-mirror.adoc[leveloffset=+1]
21+
include::modules/hcp-dc-apply-objects.adoc[leveloffset=+1]
22+
23+
[role="_additional-resources"]
24+
.Additional resources
25+
* xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin].
26+
27+
[id="hcp-dc-mce-virt"]
28+
== Deploying {mce-short} for a disconnected installation of {hcp}
29+
30+
The {mce} plays a crucial role in deploying clusters across providers. If you do not have {mce-short} installed, review the following documentation to understand the prerequisites and steps to install it:
31+
32+
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#mce-intro[About cluster lifecycle with multicluster engine operator]
33+
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#mce-install-intro[Installing and upgrading multicluster engine operator]
34+
35+
[id="hcp-dc-tls-virt"]
36+
== Configuring TLS certificates for a disconnected installation of {hcp}
37+
38+
To ensure proper function in a disconnected deployment, you need to configure the registry CA certificates in the management cluster and the worker nodes for the hosted cluster.
39+
40+
include::modules/hcp-dc-tls-mgmt.adoc[leveloffset=+2]
41+
include::modules/hcp-dc-tls-hosted.adoc[leveloffset=+2]
42+
43+
[id="hcp-dc-virt-hosted"]
44+
== Creating a hosted cluster on {VirtProductName}
45+
46+
A hosted cluster is an {product-title} cluster with its control plane and API endpoint hosted on a management cluster. The hosted cluster includes the control plane and its corresponding data plane.
47+
48+
include::modules/hcp-virt-reqs.adoc[leveloffset=+2]
49+
include::modules/hcp-virt-create-hc-cli.adoc[leveloffset=+2]
50+
include::modules/hcp-virt-ingress-dns.adoc[leveloffset=+2]
51+
52+
[id="hcp-dc-virt-ingress-dns-custom"]
53+
=== Customizing ingress and DNS behavior
54+
55+
If you do not want to use the default ingress and DNS behavior, you can configure a KubeVirt hosted cluster with a unique base domain at creation time. This option requires manual configuration steps during creation and involves three main steps: cluster creation, load balancer creation, and wildcard DNS configuration.
56+
57+
include::modules/hcp-virt-hc-base-domain.adoc[leveloffset=+3]
58+
include::modules/hcp-virt-load-balancer.adoc[leveloffset=+3]
59+
include::modules/hcp-virt-wildcard-dns.adoc[leveloffset=+3]
60+
61+
[id="hcp-dc-finish"]
62+
== Finishing the deployment
63+
64+
You can monitor the deployment of a hosted cluster from two perspectives: the control plane and the data plane.
65+
66+
include::modules/hcp-monitor-cp.adoc[leveloffset=+2]
67+
include::modules/hcp-monitor-dp.adoc[leveloffset=+2]
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="hcp-deploy-dc"]
3+
include::_attributes/common-attributes.adoc[]
4+
= Introduction to {hcp} in a disconnected environment
5+
:context: hcp-deploy-dc
6+
7+
toc::[]
8+
9+
In the context of {hcp}, a disconnected environment is an {product-title} deployment that is not connected to the internet and that uses {hcp} as a base. You can deploy {hcp} in a disconnected environment on bare metal or {VirtProductName}.
10+
11+
{hcp-capital} in disconnected environments function differently than in standalone {product-title}:
12+
13+
* The control plane is in the management cluster. The control plane is where the pods of the hosted control plane are run and managed by the Control Plane Operator.
14+
* The data plane is in the workers of the hosted cluster. The data plane is where the workloads and other pods run, all managed by the HostedClusterConfig Operator.
15+
16+
Depending on where the pods are running, they are affected by the `ImageDigestMirrorSet` (IDMS) or `ImageContentSourcePolicy` (ICSP) that is created in the management cluster or by the `ImageContentSource` that is set in the `spec` field of the manifest for the hosted cluster. The `spec` field is translated into an IDMS object on the hosted cluster.
17+
18+
You can deploy {hcp} in a disconnected environment on IPv4, IPv6, and dual-stack networks. IPv4 is one of the simplest network configurations to deploy {hcp} in a disconnected environment. IPv4 ranges require fewer external components than IPv6 or dual-stack setups. For {hcp} on {VirtProductName} in a disconnected environment, use either an IPv4 or a dual-stack network.
19+
20+
:FeatureName: {hcp-capital} in a disconnected environment on a dual-stack network
21+
include::snippets/technology-preview.adoc[]
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../snippets

0 commit comments

Comments
 (0)