Skip to content

Commit cec7dc7

Browse files
skopacz1skopacz1
authored
Merge pull request #88729 from skopacz1/OSDOCS-13356
OSDOCS#13356: Agent Installer with PCA
2 parents bbda322 + c5a34f1 commit cec7dc7

9 files changed

+209
-14
lines changed

‎_attributes/common-attributes.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,9 @@ endif::[]
310310
:oci-c3: Oracle(R) Compute Cloud@Customer
311311
:oci-c3-no-rt: Oracle Compute Cloud@Customer
312312
:oci-c3-short: Compute Cloud@Customer
313+
:oci-pca: Oracle(R) Private Cloud Appliance
314+
:oci-pca-no-rt: Oracle Private Cloud Appliance
315+
:oci-pca-short: Private Cloud Appliance
313316
// Red Hat OpenStack Platform (RHOSP)/OpenStack
314317
ifndef::openshift-origin[]
315318
:rh-openstack-first: Red Hat OpenStack Platform (RHOSP)

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -585,6 +585,8 @@ Topics:
585585
File: installing-oci-agent-based-installer
586586
- Name: Installing a cluster on Oracle Compute Cloud@Customer by using the Agent-based Installer
587587
File: installing-c3-agent-based-installer
588+
- Name: Installing a cluster on Oracle Private Cloud Appliance by using the Agent-based Installer
589+
File: installing-pca-agent-based-installer
588590
- Name: Installing on VMware vSphere
589591
Dir: installing_vsphere
590592
Distros: openshift-origin,openshift-enterprise

‎installing/installing_oci/installing-pca-agent-based-installer.adoc

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="installing-pca-agent-based-installer"]
4+
= Installing a cluster on {oci-pca-no-rt} by using the Agent-based Installer
5+
:context: installing-pca-agent-based-installer
6+
7+
toc::[]
8+
9+
You can use the Agent-based Installer to install a cluster on {oci-pca}, so that you can run cluster workloads on on-premise infrastructure while still using {oci-first} services.
10+
11+
////
12+
Do I need to add a BM/VM support statement like the one below?
13+
14+
Installing a cluster on {oci-pca-short} is supported for virtual-machines (VMs) and bare-metal machines.
15+
////
16+
17+
[id="abi-oci-pca-process-checklist_{context}"]
18+
== Installation process workflow
19+
20+
The following workflow describes a high-level outline for the process of installing an {product-title} cluster on {oci-pca-short} using the Agent-based Installer:
21+
22+
. Create {oci-pca-short} resources and services (Oracle).
23+
. Prepare configuration files for the Agent-based Installer (Red{nbsp}Hat).
24+
. Generate the agent ISO image (Red{nbsp}Hat).
25+
. Convert the ISO image to an {oci-first-no-rt} image, upload it to an {oci} Home Region Bucket, and then import the uploaded image to the {oci-pca-short} system (Oracle).
26+
. Disconnected environments: Prepare a web server that is accessible by {oci} instances (Red{nbsp}Hat).
27+
. Disconnected environments: Upload the rootfs image to the web server (Red{nbsp}Hat).
28+
. Configure your firewall for {product-title} (Red{nbsp}Hat).
29+
. Create control plane nodes and configure load balancers (Oracle).
30+
. Create compute nodes and configure load balancers (Oracle).
31+
. Verify that your cluster runs on {oci} (Oracle).
32+
33+
// Creating Private Cloud Appliance infrastructure resources and services
34+
include::modules/abi-pca-resources-services.adoc[leveloffset=+1]
35+
36+
[role="_additional-resources"]
37+
.Additional resources
38+
39+
* link:https://docs.oracle.com/en-us/iaas/Content/GSG/Concepts/concepts.htm[Learn About Oracle Cloud Basics (Oracle documentation)]
40+
41+
// Creating configuration files for installing a cluster on OCI
42+
include::modules/creating-config-files-cluster-install-oci.adoc[leveloffset=+1]
43+
44+
[role="_additional-resources"]
45+
.Additional resources
46+
47+
* xref:../../architecture/architecture-installation.adoc#installation-overview_architecture-installation[About {product-title} installation]
48+
* xref:../../installing/overview/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type]
49+
* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#preparing-to-install-with-agent-based-installer[Preparing to install with the Agent-based Installer]
50+
* xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-ocp-agent-retrieve_installing-with-agent-based-installer[Downloading the Agent-based Installer]
51+
* xref:../../disconnected/mirroring/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[Creating a mirror registry with mirror registry for Red{nbsp}Hat OpenShift]
52+
* xref:../../disconnected/mirroring/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the {product-title} image repository]
53+
* xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-ocp-agent-ztp_installing-with-agent-based-installer[Optional: Using ZTP manifests]
54+
55+
// Configuring your firewall
56+
include::modules/configuring-firewall.adoc[leveloffset=+1]
57+
58+
// Running your cluster on Private Cloud Appliance
59+
include::modules/running-cluster-oci-pca-agent-based.adoc[leveloffset=+1]
60+
61+
// Verifying that your Agent-based cluster installation runs on {oci}
62+
include::modules/verifying-cluster-install-oci-agent-based.adoc[leveloffset=+1]
63+
64+
[role="_additional-resources"]
65+
[id="additional-resources_{context}"]
66+
== Additional resources
67+
68+
* xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-ocp-agent-gather-log_installing-with-agent-based-installer[Gathering log data from a failed Agent-based installation]
69+
70+
* xref:../../nodes/nodes/nodes-nodes-adding-node-iso.adoc#adding-node-iso[Adding worker nodes to an on-premise cluster]

‎modules/abi-c3-resources-services.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ You must create an {oci-c3-short} environment on your virtual machine (VM) or ba
1212
====
1313
To ensure compatibility with {product-title}, you must set `A` as the record type for each DNS record and name records as follows:
1414
15-
* `api.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer.
16-
* `api-int.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer.
17-
* `*.apps.<cluster_name>.<base_domain>`, which targets the `ingressVIP` parameter of the Ingress load balancer.
15+
* `api.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer
16+
* `api-int.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer
17+
* `*.apps.<cluster_name>.<base_domain>`, which targets the `ingressVIP` parameter of the Ingress load balancer
1818
1919
The `api.{asterisk}` and `api-int.{asterisk}` DNS records relate to control plane machines, so you must ensure that all nodes in your installed {product-title} cluster can access these DNS records.
2020
====

‎modules/abi-oci-resources-services.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ The Agent-based Installer method for installing an {product-title} cluster on {o
1414
====
1515
To ensure compatibility with {product-title}, you must set `A` as the record type for each DNS record and name records as follows:
1616
17-
* `api.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer.
18-
* `api-int.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer.
19-
* `*.apps.<cluster_name>.<base_domain>`, which targets the `ingressVIP` parameter of the Ingress load balancer.
17+
* `api.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer
18+
* `api-int.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer
19+
* `*.apps.<cluster_name>.<base_domain>`, which targets the `ingressVIP` parameter of the Ingress load balancer
2020
2121
The `api.{asterisk}` and `api-int.{asterisk}` DNS records relate to control plane machines, so you must ensure that all nodes in your installed {product-title} cluster can access these DNS records.
2222
====

‎modules/abi-pca-resources-services.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-pca-agent-based-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="abi-pca-resources-services_{context}"]
7+
= Creating {oci-pca-no-rt} infrastructure resources and services
8+
9+
You must create an {oci-pca-short} environment on your virtual machine (VM) or bare-metal shape. By creating this environment, you can install {product-title} and deploy a cluster on an infrastructure that supports a wide range of cloud options and strong security policies. Having prior knowledge of {oci} components can help you with understanding the concept of {oci} resources and how you can configure them to meet your organizational needs.
10+
11+
[IMPORTANT]
12+
====
13+
To ensure compatibility with {product-title}, you must set `A` as the record type for each DNS record and name records as follows:
14+
15+
* `api.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer
16+
* `api-int.<cluster_name>.<base_domain>`, which targets the `apiVIP` parameter of the API load balancer
17+
* `*.apps.<cluster_name>.<base_domain>`, which targets the `ingressVIP` parameter of the Ingress load balancer
18+
19+
The `api.{asterisk}` and `api-int.{asterisk}` DNS records relate to control plane machines, so you must ensure that all nodes in your installed {product-title} cluster can access these DNS records.
20+
====
21+
22+
.Prerequisites
23+
24+
* You configured an {oci} account to host the {product-title} cluster. See "Access and Considerations" in link:https://www.oracle.com/a/otn/docs/private_cloud_appliance_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
25+
Agent Based Installer on Private Cloud Appliance] (Oracle documentation).
26+
27+
.Procedure
28+
29+
* Create the required {oci-pca-short} resources and services.
30+
+
31+
For more information, see "Terraform Script Execution" in link:https://www.oracle.com/a/otn/docs/private_cloud_appliance_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
32+
Agent Based Installer on Private Cloud Appliance] (Oracle documentation).

‎modules/creating-config-files-cluster-install-oci.adoc

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing_oci/installing-oci-agent-based-installer.adoc
4+
// * installing/installing_oci/installing-pca-agent-based-installer.adoc
5+
6+
ifeval::["{context}" == "installing-pca-agent-based-installer"]
7+
:pca:
8+
endif::[]
49

510

611
ifeval::["{context}" == "installing-c3-agent-based-installer"]
@@ -16,14 +21,20 @@ ifdef::c3[]
1621
You must create the `install-config.yaml` and the `agent-config.yaml` configuration files so that you can use the Agent-based Installer to generate a bootable ISO image. The Agent-based installation comprises a bootable ISO that has the Assisted discovery agent and the Assisted Service. Both of these components are required to perform the cluster installation, but the latter component runs on only one of the hosts.
1722
endif::c3[]
1823

19-
ifndef::c3[]
24+
ifdef::pca[]
25+
[id="creating-config-files-cluster-install-pca_{context}"]
26+
= Creating configuration files for installing a cluster on {oci-pca-short}
27+
28+
You must create the `install-config.yaml` and the `agent-config.yaml` configuration files so that you can use the Agent-based Installer to generate a bootable ISO image. The Agent-based installation comprises a bootable ISO that has the Assisted discovery agent and the Assisted Service. Both of these components are required to perform the cluster installation, but the latter component runs on only one of the hosts.
29+
endif::pca[]
30+
31+
ifndef::pca,c3[]
2032
[id="creating-config-files-cluster-install-oci_{context}"]
2133
= Creating configuration files for installing a cluster on {oci}
2234

2335
You must create the `install-config.yaml` and the `agent-config.yaml` configuration files so that you can use the Agent-based Installer to generate a bootable ISO image. The Agent-based installation comprises a bootable ISO that has the Assisted discovery agent and the Assisted Service. Both of these components are required to perform the cluster installation, but the latter component runs on only one of the hosts.
2436

25-
At a later stage, you must follow the steps in the Oracle documentation for uploading your generated Agent ISO image to a default Oracle Object Storage bucket, which is the initial step for integrating your {product-title} cluster on {oci-first}.
26-
endif::c3[]
37+
endif::pca,c3[]
2738

2839
[NOTE]
2940
====
@@ -116,7 +127,7 @@ pullSecret: '<pull_secret>' <6>
116127
Do not move the `install-config.yaml` or `agent-config.yaml` configuration files to the `openshift` directory.
117128
====
118129

119-
ifndef::c3[]
130+
ifndef::c3,pca[]
120131
. If you used a stack to provision OCI infrastructure resources: Copy and paste the `dynamic_custom_manifest` output of the OCI stack into a file titled `manifest.yaml` and save the file in the `openshift` directory.
121132

122133
. If you did not use a stack to provision OCI infrastructure resources: Download and prepare custom manifests to create an Agent ISO image:
@@ -127,7 +138,7 @@ ifndef::c3[]
127138
.. Copy the contents of the `condensed-manifest.yml` file and save it locally to a file in the `openshift` directory.
128139

129140
.. In the `condensed-manifest.yml` file, update the sections marked with `TODO` to specify the compartment {ocid-first}, VCN {ocid}, subnet {ocid} from the load balancer, and the security lists {ocid}.
130-
endif::c3[]
141+
endif::c3,pca[]
131142

132143
ifdef::c3[]
133144
. Configure the Oracle custom manifest files.
@@ -141,6 +152,17 @@ Cloud@Customer] (Oracle documentation).
141152
.. Edit the `oci-ccm.yml` and `oci-csi.yml` files to specify the compartment {ocid-first}, VCN {ocid}, subnet {ocid} from the load balancer, the security lists {ocid}, and the `c3-cert.pem` section.
142153
endif::c3[]
143154

155+
ifdef::pca[]
156+
. Configure the Oracle custom manifest files.
157+
158+
.. Go to "Prepare the OpenShift Master Images" in link:https://www.oracle.com/a/otn/docs/private_cloud_appliance_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
159+
Agent Based Installer on Private Cloud Appliance] (Oracle documentation).
160+
161+
.. Copy and paste the `oci-ccm.yml`, `oci-csi.yml`, and `machineconfig-ccm.yml` files into your `openshift` directory.
162+
163+
.. Edit the `oci-ccm.yml` and `oci-csi.yml` files to specify the compartment {ocid-first}, VCN {ocid}, subnet {ocid} from the load balancer, the security lists {ocid}, and the `c3-cert.pem` section.
164+
endif::pca[]
165+
144166
. Configure the `agent-config.yaml` configuration file to meet your organization's requirements.
145167
+
146168
.Sample `agent-config.yaml` file for an IPv4 network.
@@ -197,4 +219,8 @@ Consider that the full ISO image, which is in excess of `1` GB, includes the roo
197219

198220
ifeval::["{context}" == "installing-c3-agent-based-installer"]
199221
:!c3:
222+
endif::[]
223+
224+
ifeval::["{context}" == "installing-pca-agent-based-installer"]
225+
:!pca:
200226
endif::[]

‎modules/running-cluster-oci-pca-agent-based.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-oci-agent-based-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="running-cluster-oci-pca-agent-based_{context}"]
7+
= Running a cluster on {oci-pca-short}
8+
9+
To run a cluster on {oci-pca}, you must first convert your generated Agent ISO image into an {oci} image, upload it to an {oci} Home Region Bucket, and then import the uploaded image to the {oci-pca-short} system.
10+
11+
[NOTE]
12+
====
13+
{oci-pca-short} supports the following {product-title} cluster topologies:
14+
15+
* Installing an {product-title} cluster on a single node.
16+
* A highly available cluster that has a minimum of three control plane instances and two compute instances.
17+
* A compact three-node cluster that has a minimum of three control plane instances.
18+
====
19+
20+
.Prerequisites
21+
22+
* You generated an Agent ISO image. See the "Creating configuration files for installing a cluster on {oci-pca-short}" section.
23+
24+
.Procedure
25+
26+
. Convert the agent ISO image to an {oci} image, upload it to an {oci} Home Region Bucket, and then import the uploaded image to the {oci-pca-short} system.
27+
See "Prepare the OpenShift Master Images" in link:https://www.oracle.com/a/otn/docs/private_cloud_appliance_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
28+
Agent Based Installer on Private Cloud Appliance (Oracle documentation)] for instructions.
29+
30+
. Create control plane instances on {oci-pca-short}.
31+
See "Create control plane instances on PCA and Master Node LB Backend Sets" in link:https://www.oracle.com/a/otn/docs/private_cloud_appliance_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
32+
Agent Based Installer on Private Cloud Appliance (Oracle documentation)] for instructions.
33+
34+
. Create a compute instance from the supplied base image for your cluster topology.
35+
See "Add worker nodes" in link:https://www.oracle.com/a/otn/docs/private_cloud_appliance_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
36+
Agent Based Installer on Private Cloud Appliance (Oracle documentation)] for instructions.
37+
+
38+
[IMPORTANT]
39+
====
40+
Before you create the compute instance, check that you have enough memory and disk resources for your cluster. Additionally, ensure that at least one compute instance has the same IP address as the address stated under `rendezvousIP` in the `agent-config.yaml` file.
41+
====

‎modules/verifying-cluster-install-oci-agent-based.adoc

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,17 @@ ifeval::["{context}" == "installing-c3-agent-based-installer"]
66
:c3:
77
endif::[]
88

9+
ifeval::["{context}" == "installing-pca-agent-based-installer"]
10+
:pca:
11+
endif::[]
12+
913
:_mod-docs-content-type: PROCEDURE
1014

1115
ifdef::c3[]
1216
[id="verifying-cluster-install-oci-agent-based_{context}"]
1317
= Verifying that your Agent-based cluster installation runs on {oci-c3-short}
1418

15-
Verify that your cluster was installed and is running effectively on {oci-first}.
19+
Verify that your cluster was installed and is running effectively on {oci-c3-short}.
1620

1721
.Prerequisites
1822

@@ -21,7 +25,20 @@ Verify that your cluster was installed and is running effectively on {oci-first}
2125
* You uploaded the agent ISO image to a default Oracle Object Storage bucket, and you created a compute instance on {oci-c3-short}. For more information, see "Running a cluster on {oci-c3-short}".
2226
endif::c3[]
2327
24-
ifndef::c3[]
28+
ifdef::pca[]
29+
[id="verifying-cluster-install-oci-agent-based_{context}"]
30+
= Verifying that your Agent-based cluster installation runs on {oci-pca-short}
31+
32+
Verify that your cluster was installed and is running effectively on {oci-pca-short}.
33+
34+
.Prerequisites
35+
36+
* You created all the required {oci-pca} resources and services. See the "Creating {oci-pca-no-rt} infrastructure resources and services" section.
37+
* You created `install-config.yaml` and `agent-config.yaml` configuration files. See the "Creating configuration files for installing a cluster on {oci-pca-short}" section.
38+
* You uploaded the agent ISO image to a default Oracle Object Storage bucket, and you created a compute instance on {oci-pca-short}. For more information, see "Running a cluster on {oci-pca-short}".
39+
endif::pca[]
40+
41+
ifndef::pca,c3[]
2542
[id="verifying-cluster-install-oci-agent-based_{context}"]
2643
= Verifying that your Agent-based cluster installation runs on {oci}
2744

@@ -32,7 +49,7 @@ Verify that your cluster was installed and is running effectively on {oci-first}
3249
* You created all the required {oci} resources and services. See the "Creating OCI infrastructure resources and services" section.
3350
* You created `install-config.yaml` and `agent-config.yaml` configuration files. See the "Creating configuration files for installing a cluster on OCI" section.
3451
* You uploaded the agent ISO image to a default Oracle Object Storage bucket, and you created a compute instance on {oci}. For more information, see "Running a cluster on OCI".
35-
endif::c3[]
52+
endif::pca,c3[]
3653
3754
.Procedure
3855

@@ -91,4 +108,8 @@ network 4.18.0-0 True True False 5m58s Progressi
91108
92109
ifeval::["{context}" == "installing-c3-agent-based-installer"]
93110
:!c3:
111+
endif::[]
112+
113+
ifeval::["{context}" == "installing-pca-agent-based-installer"]
114+
:!pca:
94115
endif::[]

0 commit comments

Comments
 (0)