Skip to content

Commit f619d62

Browse files
author
Talia Shwartzberg
committed
HCIDOCS-651: Oracle Cloud C3
1 parent 9a02e92 commit f619d62

12 files changed

+382
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -587,6 +587,8 @@ Topics:
587587
File: installing-c3-agent-based-installer
588588
- Name: Installing a cluster on Oracle Private Cloud Appliance by using the Agent-based Installer
589589
File: installing-pca-agent-based-installer
590+
- Name: Installing a cluster on Oracle Compute Cloud@Customer by using the Assisted Installer
591+
File: installing-c3-assisted-installer
590592
- Name: Installing on VMware vSphere
591593
Dir: installing_vsphere
592594
Distros: openshift-origin,openshift-enterprise

‎installing/installing_oci/installing-c3-assisted-installer.adoc

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="installing-c3-assisted-installer"]
4+
= Installing a cluster on {oci-c3-no-rt} by using the {ai-full}
5+
:context: installing-c3-assisted-installer
6+
7+
toc::[]
8+
9+
With {oci-c3} (C3), you can run applications and middleware by using {oci-first} services on high performance cloud infrastructure in your data center.
10+
11+
// Overview
12+
include::modules/c3-assisted-installer-overview.adoc[leveloffset=+1]
13+
14+
// Preparing the Bastian server
15+
include::modules/c3-assisted-installer-preparing-bastion-server.adoc[leveloffset=+1]
16+
17+
// Terraform script execution - part 1
18+
include::modules/c3-assisted-installer-running-script-via-home.adoc[leveloffset=+1]
19+
20+
// Preparing the OpenShift image
21+
[id="c3-assisted-installer-preparing-image_{context}"]
22+
== Preparing the {oci} image
23+
24+
Generate the {product-title} ISO image in the {ai-full} on the Red{nbsp}Hat portal. Then, convert the image to an {oci-first-no-rt} compatible image and upload it to the *Custom Images* page of your {oci-c3-no-rt} environment.
25+
26+
You can generate, convert and upload the image on your laptop and not on the bastion server or within environments such as Oracle Solution Center.
27+
28+
include::modules/c3-assisted-installer-preparing-image-generating.adoc[leveloffset=+2]
29+
30+
include::modules/c3-assisted-installer-preparing-image-converting.adoc[leveloffset=+2]
31+
32+
// Terraform script execution - part 2
33+
include::modules/c3-assisted-installer-running-script-via-region.adoc[leveloffset=+1]
34+
35+
// Completing the installation
36+
37+
[id="c3-ai-completing-installation_{context}"]
38+
== Completing the installation by using the {ai-full} web console
39+
40+
After you configure the infrastructure, the instances are now running and are ready to be registered with{nbsp}Red Hat.
41+
42+
include::modules/c3-assisted-installer-completing-installation-nodes.adoc[leveloffset=+2]
43+
44+
include::modules/c3-assisted-installer-completing-installation-networking.adoc[leveloffset=+2]
45+
46+
include::modules/c3-assisted-installer-completing-installation-manifests.adoc[leveloffset=+2]
47+
48+
// Opening the cluster
49+
include::modules/c3-assisted-installer-opening-cluster.adoc[leveloffset=+1]

‎modules/c3-assisted-installer-completing-installation-manifests.adoc

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-c3-assisted-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="c3-ai-completing-installation-manifests_{context}"]
7+
= Adding custom manifests
8+
9+
Create, modify, and upload the four mandatory custom manifests provided by Oracle.
10+
11+
* In the `C3/custom_manifests_C3/manifests` folder, the following manifests are mandatory:
12+
13+
** `oci-ccm.yml`
14+
** `oci-csi.yml`
15+
16+
* In the `C3/custom_manifests_C3/openshift` folder, the following manifests are mandatory:
17+
18+
** `machineconfig-ccm.yml`
19+
** `machineconfig-csi.yml`
20+
21+
.Prerequisites
22+
23+
* Prepare the custom manifests. For details, see step 8 in the "Install the Cluster using the RH Assisted Installer UI" section of the link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_assisted_installer.pdf?source=:em:nl:mt::::PCATP[Oracle documentation].
24+
25+
.Procedure
26+
27+
. Navigate to the *Custom manifests* page.
28+
29+
. Upload and save the `oci-ccm.yml` and `oci-csi.yml` manifest files:
30+
31+
.. In the *Folder* field, select *manifests*.
32+
33+
.. In the *File name* field, enter `oci-ccm.yml`.
34+
35+
.. In the *Content* section, click *Browse*.
36+
37+
.. Select the *oci-ccm.yml* file from the `C3/custom_ manifest_C3/manifests` folder.
38+
39+
.. Click *Add another manifest* and repeat the previous substeps for the `oci-csi.yml` file.
40+
41+
. Upload and save the `machineconfig-ccm.yml` and `machineconfig-csi.yml` manifest files:
42+
43+
.. Click *Add another manifest*.
44+
45+
.. In the *Folder* field, select *openshift*.
46+
47+
.. In the *File name* field, enter `machineconfig-ccm.yml`.
48+
49+
.. In the *Content* section, click *Browse*.
50+
51+
.. Select the *machineconfig-ccm.yml* file from the `C3/custom_ manifest_C3/openshift` folder.
52+
53+
.. Click *Add another manifest* and repeat the previous substeps for the `machineconfig-csi.yml` file.
54+
55+
. Click *Next* to save the custom manifests.
56+
57+
. From the *Review and create* page, click *Install cluster* to create your {product-title} cluster. This process takes approximately thirty minutes.

‎modules/c3-assisted-installer-completing-installation-networking.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-c3-assisted-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="c3-ai-completing-installation-networking_{context}"]
7+
= Configuring networking
8+
9+
On the *Networking* page, add the NTP sources for any hosts that display the `Some validations failed` status.
10+
11+
.Procedure
12+
13+
. In the *Host inventory* table, click the *Some validations failed* link for each host displaying this status.
14+
15+
. Click *Add NTP sources*, and then add the IP address `169.254.169.254` for one of the nodes.
16+
17+
. Wait for 2 - 3 minutes until all the *Some validations failed* indicators disappear.
18+
19+
. Select *Next*.

‎modules/c3-assisted-installer-completing-installation-nodes.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-c3-assisted-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="c3-ai-completing-installation-nodes_{context}"]
7+
= Assigning node roles
8+
9+
If the Terraform scripts completed successfully, twelve hosts are now listed for the cluster. Three control plane hosts and three compute hosts have the status "Disconnected". Three control plane hosts and three compute hosts have the status "Insufficient".
10+
11+
Delete the disconnected hosts and assign roles to the remaining hosts.
12+
13+
.Procedure
14+
15+
. From the link:https://console.redhat.com/openshift/assisted-installer/clusters[{ai-full} web console], select the cluster and navigate to the *Host discovery* page.
16+
17+
. Delete the six hosts with a "Disconnected" status, by clicking the option button for each host and selecting *Remove host*. The status of the remaining hosts changes from "Insufficient" to "Ready". This process can take up to three minutes.
18+
19+
. From the *Role* column, assign the *Control plane* role to the three nodes with a boot size of 1.10 TB. Assign the *Worker* role to the three nodes with boot size of 100 GB.
20+
21+
. Rename any hosts with a name shorter than 63 characters, by clicking the option button for the host and selecting *Change hostname*. Otherwise the cluster installation will fail.
22+
23+
. Click *Next*.
24+
25+
. On the *Storage* page, click *Next*.

‎modules/c3-assisted-installer-opening-cluster.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-c3-assisted-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="c3-ai-opening-cluster_{context}"]
7+
= Opening {product-title} from the {oci-c3-no-rt} web console
8+
9+
For instructions to access the {product-title} console from {oci-c3-no-rt}, see step 15 - 17 in the "Install the Cluster using the RH Assisted Installer UI" section of the link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_assisted_installer.pdf?source=:em:nl:mt::::PCATP[Oracle documentation].

‎modules/c3-assisted-installer-overview.adoc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-c3-assisted-installer.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="c3-ai-overview_{context}"]
7+
= Overview
8+
9+
You can install {product-title} on {oci-c3-no-rt} by using the {ai-full}.
10+
11+
For an alternative installation method, see "Installing a cluster on {oci-c3} by using the Agent-based Installer".
12+
13+
.Preinstallation considerations
14+
15+
* Ensure that your installation meets the prerequisites specified for Oracle. For details, see the "Access and Considerations" section in the link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_assisted_installer.pdf?source=:em:nl:mt::::PCATP[Oracle documentation].
16+
17+
* Ensure that your infrastructure is certified and uses a compatible cloud instance type. For details, see link:https://catalog.redhat.com/cloud/detail/216977[Oracle Cloud Infrastructure].
18+
19+
* Ensure that you are performing the installation on a virtual machine.
20+
21+
.Installation process
22+
23+
The installation process builds a bastion host within the designated compartment of the {product-title} cluster. The bastion host is used to run two Terraform scripts:
24+
25+
* The first script builds IAM Resources in the {oci} Home region of the {oci-c3-short} system (two Dynamic Groups and one Policy).
26+
27+
* The second script builds the infrastructure resources on the {oci-c3-short} system to support the {product-title} cluster, including the {product-title} VCN, public and private subnets, load balancers, Internet GW, NAT GW, and DNS server. The script includes all the resources needed to activate the control plane nodes and compute nodes that form a cluster.
28+
29+
The bastion host is installed in the designated {product-title} Compartment and configured to communicate through a designated {oci-c3-short} DRG Subnet or Internet GW Subnet within the {oci-c3-short} parent tenancy.
30+
31+
The installation process subsequently provisions three control plane (master) nodes and three compute (worker) nodes, together with the external and internal Load Balancers that form the cluster. This is the standard implementation for {oci-first-no-rt}.
32+
33+
.Main steps
34+
35+
The main steps of the procedure are as follows:
36+
37+
. Preparing the {oci-c3-short} bastion server.
38+
39+
. Running the Terraform script via the Home region.
40+
41+
. Preparing the {product-title} image for {oci-first-no-rt}.
42+
43+
. Running the Terraform script via the {oci-c3-short} region.
44+
45+
. Installing the cluster by using the {ai-full} web console.
46+

‎modules/c3-assisted-installer-preparing-bastion-server.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-c3-assisted-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="c3-ai-preparing-bastian-server_{context}"]
7+
= Preparing the {oci} bastion server
8+
9+
By implementing a bastion host, you can securely and efficiently manage access to your {oci-c3-no-rt} resources, ensuring that your private instances remain protected and accessible only through a secure, controlled entry point.
10+
11+
.Prerequisites
12+
13+
* See the "Bastion server - prerequisites" section in the link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_assisted_installer.pdf?source=:em:nl:mt::::PCATP[Oracle documentation].
14+
15+
.Procedure
16+
17+
. Install the bastion server. For details, see the "Bastion Installation" section in the link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_assisted_installer.pdf?source=:em:nl:mt::::PCATP[Oracle documentation].
18+
19+
. Install the Terraform application which is used to run the Terraform script. For details, see the "Terraform Installation" section in the link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_assisted_installer.pdf?source=:em:nl:mt::::PCATP[Oracle documentation].
20+
21+
. Install and configure the {oci} command line interface (CLI). For details, see the "Installing and Configuring the {oci} CLI" section in the link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_assisted_installer.pdf?source=:em:nl:mt::::PCATP[Oracle documentation].
22+
23+
.Additional resources
24+
25+
* link:https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm[Quick start - Installing the CLI (Oracle documentation)].

‎modules/c3-assisted-installer-preparing-image-converting.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-c3-assisted-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="c3-assisted-installer-preparing-image-converting_{context}"]
7+
= Converting and uploading the image to {oci-c3-no-rt}
8+
9+
Convert the ISO image to an {oci} image and upload it to your {oci-c3-short} system from your OCI Home Region Object
10+
Store.
11+
12+
.Procedure
13+
14+
. Convert the image from ISO to {oci}.
15+
. Upload the {oci} image to an {oci} bucket, and generate a Pre-Authenticated Request (PAR) URL.
16+
. Import the {oci} image to the {oci-c3-short} portal.
17+
. Copy the Oracle Cloud Identifier (OCID) of the image for use in the next procedure.
18+
19+
For the full procedure, see step 6 - 8 in the "OpenShift Image Preparation" section of the link:https://www.oracle.com/a/otn/docs/compute_cloud_at_customer_assisted_installer.pdf?source=:em:nl:mt::::PCATP[Oracle documentation].

‎modules/c3-assisted-installer-preparing-image-generating.adoc

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-c3-assisted-installer.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="c3-assisted-installer-preparing-image-generating_{context}"]
7+
= Generating the image in the {ai-full}
8+
9+
Create a cluster and download the discovery ISO image.
10+
11+
.Procedure
12+
13+
. Log in to link:https://console.redhat.com/[{ai-full} web console] with your credentials.
14+
15+
. In the *Red Hat OpenShift* tile, select *OpenShift*.
16+
17+
. In the *Red Hat {product-title}* tile, select *Create Cluster*.
18+
19+
. On the *Cluster Type* page, scroll to the end of the *Cloud* tab, and select *Oracle Cloud Infrastructure (virtual machines)*.
20+
21+
. On the *Create an OpenShift Cluster* page, select the *Interactive* tile.
22+
23+
. On the *Cluster Details* page, complete the following fields:
24+
+
25+
[cols="1,3",options="header",subs="quotes"]
26+
|===
27+
|Field |Action required
28+
29+
|*Cluster name*
30+
|Specify the name of your {product-title} cluster. This name is the same name you used to create the resource via the Terraform scripts. The name must be between 1-54 characters. It can use lowercase alphanumeric characters or hyphen (-), but must start and end with a lowercase letter or a number.
31+
32+
|*Base domain*
33+
|Specify the base domain of the cluster. This is the value used for the `zone_dns` variables in the Terraform scripts that run on {oci-c3-short}. Make a note of the value.
34+
35+
|*OpenShift version*
36+
| Select *OpenShift 4.16.20*. If it is not immediately visible, scroll to the end of the dropdown menu, select *Show all available versions*, and type the version in the search box.
37+
38+
|*Integrate with external partner platforms*
39+
|Select *Oracle Cloud Infrastructure*.
40+
41+
After you specify this value, the *Include custom manifests* checkbox is selected by default and the *Custom manifests* page is added to the wizard.
42+
|===
43+
44+
. Leave the default settings for the remaining fields, and click *Next*.
45+
46+
. On the *Operators* page, click *Next*.
47+
48+
. On the *Host Discovery* page, click *Add hosts* and complete the following steps:
49+
+
50+
[NOTE]
51+
====
52+
The minimal ISO image is the mandatory *Provisioning type* for the {oci-first-no-rt}, and cannot be changed.
53+
====
54+
55+
.. In the *SSH public key* field, add the SSH public key by copying the output of the following command:
56+
+
57+
[source,terminal]
58+
----
59+
$ cat ~/.ssh/id_rsa.put
60+
----
61+
+
62+
The SSH public key will be installed on all {product-title} control plane and compute nodes.
63+
64+
.. Click the *Show proxy settings* checkbox.
65+
66+
.. Add the proxy variables from the `/etc/environment` file of the bastion server that you configured earlier:
67+
+
68+
[source,terminal]
69+
----
70+
http_proxy=http://www-proxy.<your_domain>.com:80
71+
https_proxy=http://www-proxy.<your_domain>.com:80
72+
no_proxy=localhost,127.0.0.1,1,2,3,4,5,6,7,8,9,0,.<your_domain>.com
73+
#(ie.oracle.com,.oraclecorp.com)
74+
----
75+
76+
.. Click *Generate Discovery ISO* to generate the discovery ISO image file.
77+
78+
. Click *Download Discovery ISO* to save the file to your local system. After you download the ISO file, you can rename it as required, for example `discovery_image_<your_cluster_name>.iso`.

0 commit comments

Comments
 (0)