Skip to content

Commit 9570d75

Browse files
skopacz1skopacz1
authored
Merge pull request #88588 from skopacz1/OSDOCS-13355
OSDOCS#13355: Agent Installer with C3
2 parents eaaf36a + 539a2ba commit 9570d75

File tree

7 files changed

+214
-2
lines changed

7 files changed

+214
-2
lines changed

‎_attributes/common-attributes.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,9 @@ endif::[]
307307
:ocid: OCID
308308
:ocvs-first: Oracle(R) Cloud VMware Solution (OCVS)
309309
:ocvs: OCVS
310+
:oci-c3: Oracle(R) Compute Cloud@Customer
311+
:oci-c3-no-rt: Oracle Compute Cloud@Customer
312+
:oci-c3-short: Compute Cloud@Customer
310313
// Red Hat OpenStack Platform (RHOSP)/OpenStack
311314
ifndef::openshift-origin[]
312315
: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
@@ -581,6 +581,8 @@ Topics:
581581
File: installing-oci-assisted-installer
582582
- Name: Installing a cluster on Oracle Cloud Infrastructure by using the Agent-based Installer
583583
File: installing-oci-agent-based-installer
584+
- Name: Installing a cluster on Oracle Compute Cloud@Customer by using the Agent-based Installer
585+
File: installing-c3-agent-based-installer
584586
- Name: Installing on VMware vSphere
585587
Dir: installing_vsphere
586588
Distros: openshift-origin,openshift-enterprise

‎installing/installing_oci/installing-c3-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-c3-agent-based-installer"]
4+
= Installing a cluster on {oci-c3-no-rt} by using the Agent-based Installer
5+
:context: installing-c3-agent-based-installer
6+
7+
toc::[]
8+
9+
You can use the Agent-based Installer to install a cluster on {oci-c3}, 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-c3-short} is supported for virtual-machines (VMs) and bare-metal machines.
15+
////
16+
17+
[id="abi-oci-c3-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-c3-short} using the Agent-based Installer:
21+
22+
. Create {oci-c3-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-c3-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 Compute Cloud@Customer infrastructure resources and services
34+
include::modules/abi-c3-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 Compute Cloud@Customer
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 Compute Cloud@Customer
59+
include::modules/running-cluster-oci-c3-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: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-c3-agent-based-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="abi-c3-resources-services_{context}"]
7+
= Creating {oci-c3-no-rt} infrastructure resources and services
8+
9+
You must create an {oci-c3-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.
25+
See "Access and Considerations" in link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
26+
Agent Based Installer on Compute
27+
Cloud@Customer] (Oracle documentation).
28+
29+
.Procedure
30+
31+
* Create the required {oci-c3-short} resources and services.
32+
+
33+
For more information, see "Terraform Script Execution" in link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
34+
Agent Based Installer on Compute
35+
Cloud@Customer] (Oracle documentation).

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

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,28 @@
22
//
33
// * installing/installing_oci/installing-oci-agent-based-installer.adoc
44

5+
6+
ifeval::["{context}" == "installing-c3-agent-based-installer"]
7+
:c3:
8+
endif::[]
9+
510
:_mod-docs-content-type: PROCEDURE
11+
12+
ifdef::c3[]
13+
[id="creating-config-files-cluster-install-c3_{context}"]
14+
= Creating configuration files for installing a cluster on {oci-c3-short}
15+
16+
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.
17+
endif::c3[]
18+
19+
ifndef::c3[]
620
[id="creating-config-files-cluster-install-oci_{context}"]
721
= Creating configuration files for installing a cluster on {oci}
822

923
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.
1024

11-
At a later stage, you must follow the steps in the Oracle documentation for uploading your generated agent ISO image to Oracle's default Object Storage bucket, which is the initial step for integrating your {product-title} cluster on {oci-first}.
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[]
1227

1328
[NOTE]
1429
====
@@ -101,15 +116,30 @@ pullSecret: '<pull_secret>' <6>
101116
Do not move the `install-config.yaml` or `agent-config.yaml` configuration files to the `openshift` directory.
102117
====
103118

119+
ifndef::c3[]
104120
. 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.
105121

106122
. If you did not use a stack to provision OCI infrastructure resources: Download and prepare custom manifests to create an Agent ISO image:
107123

124+
108125
.. Go to link:https://docs.oracle.com/iaas/Content/openshift-on-oci/install-prereq.htm#install-configuration-files[Configuration Files] (Oracle documentation) and follow the link to the custom manifests directory on GitHub.
109126

110127
.. Copy the contents of the `condensed-manifest.yml` file and save it locally to a file in the `openshift` directory.
111128

112129
.. 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[]
131+
132+
ifdef::c3[]
133+
. Configure the Oracle custom manifest files.
134+
135+
.. Go to "Prepare the OpenShift Master Images" in link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
136+
Agent Based Installer on Compute
137+
Cloud@Customer] (Oracle documentation).
138+
139+
.. Copy and paste the `oci-ccm.yml`, `oci-csi.yml`, and `machineconfig-ccm.yml` files into your `openshift` directory.
140+
141+
.. 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.
142+
endif::c3[]
113143

114144
. Configure the `agent-config.yaml` configuration file to meet your organization's requirements.
115145
+
@@ -164,3 +194,7 @@ The Agent-based Installer also adds the value of the `bootArtifactsBaseURL` to t
164194
====
165195
Consider that the full ISO image, which is in excess of `1` GB, includes the rootfs image. The image is larger than the minimal ISO Image, which is typically less than `150` MB.
166196
====
197+
198+
ifeval::["{context}" == "installing-c3-agent-based-installer"]
199+
:!c3:
200+
endif::[]

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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-c3-agent-based_{context}"]
7+
= Running a cluster on {oci-c3-short}
8+
9+
To run a cluster on {oci-c3}, 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-c3-short} system.
10+
11+
[NOTE]
12+
====
13+
{oci-c3-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-c3-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-c3-short} system.
27+
See "Prepare the OpenShift Master Images" in link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
28+
Agent Based Installer on Compute
29+
Cloud@Customer (Oracle documentation)] for instructions.
30+
31+
. Create control plane instances on {oci-c3-short}.
32+
See "Create control plane instances on C3 and Master Node LB Backend Sets" in link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
33+
Agent Based Installer on Compute
34+
Cloud@Customer (Oracle documentation)] for instructions.
35+
36+
. Create a compute instance from the supplied base image for your cluster topology.
37+
See "Add worker nodes" in link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_agent_based_installation.pdf?source=:em:nl:mt::::PCATP[OpenShift Cluster Setup with
38+
Agent Based Installer on Compute
39+
Cloud@Customer (Oracle documentation)] for instructions.
40+
+
41+
[IMPORTANT]
42+
====
43+
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.
44+
====

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

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,26 @@
22
//
33
// * installing/installing_oci/installing-oci-agent-based-installer.adoc
44

5+
ifeval::["{context}" == "installing-c3-agent-based-installer"]
6+
:c3:
7+
endif::[]
8+
59
:_mod-docs-content-type: PROCEDURE
10+
11+
ifdef::c3[]
12+
[id="verifying-cluster-install-oci-agent-based_{context}"]
13+
= Verifying that your Agent-based cluster installation runs on {oci-c3-short}
14+
15+
Verify that your cluster was installed and is running effectively on {oci-first}.
16+
17+
.Prerequisites
18+
19+
* You created all the required {oci-c3} resources and services. See the "Creating {oci-c3-no-rt} infrastructure resources and services" section.
20+
* You created `install-config.yaml` and `agent-config.yaml` configuration files. See the "Creating configuration files for installing a cluster on {oci-c3-short}" section.
21+
* 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}".
22+
endif::c3[]
23+
24+
ifndef::c3[]
625
[id="verifying-cluster-install-oci-agent-based_{context}"]
726
= Verifying that your Agent-based cluster installation runs on {oci}
827

@@ -12,7 +31,8 @@ Verify that your cluster was installed and is running effectively on {oci-first}
1231

1332
* You created all the required {oci} resources and services. See the "Creating OCI infrastructure resources and services" section.
1433
* You created `install-config.yaml` and `agent-config.yaml` configuration files. See the "Creating configuration files for installing a cluster on OCI" section.
15-
* You uploaded the agent ISO image to Oracle’s default Object Storage bucket, and you created a compute instance on {oci}. For more information, see "Running a cluster on OCI".
34+
* 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[]
1636
1737
.Procedure
1838

@@ -68,3 +88,7 @@ baremetal 4.18.0-0 True False False 2m42s
6888
network 4.18.0-0 True True False 5m58s Progressing: …
6989
…
7090
----
91+
92+
ifeval::["{context}" == "installing-c3-agent-based-installer"]
93+
:!c3:
94+
endif::[]

0 commit comments

Comments
 (0)