Skip to content

Commit 7e48a6c

Browse files
committed
OSDOCS-8210: Crated an OCI doc book for the AI install route
1 parent 779e98e commit 7e48a6c

11 files changed

+258
-1
lines changed

_attributes/common-attributes.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,10 @@ endif::[]
244244
:vmw-full: VMware vSphere
245245
:vmw-short: vSphere
246246
//Oracle
247-
:oci-first: Oracle(R) Cloud Infrastructure
247+
:oci-first: Oracle(R) Cloud Infrastructure (OCI)
248248
:oci: OCI
249+
:ocid-first: Oracle(R) Cloud Identifier (OCID)
250+
:ocid: OCID
249251
:ocvs-first: Oracle(R) Cloud VMware Solution (OCVS)
250252
:ocvs: OCVS
251253
// Cluster Observability Operator

_topic_maps/_topic_map.yml

+6
Original file line numberDiff line numberDiff line change
@@ -459,6 +459,12 @@ Topics:
459459
File: uninstalling-openstack-user
460460
- Name: Installation configuration parameters for OpenStack
461461
File: installation-config-parameters-openstack
462+
- Name: Installing on OCI
463+
Dir: installing_oci
464+
Distros: openshift-origin,openshift-enterprise
465+
# Topics:
466+
# - Name: Using the Assisted Installer to install a cluster on OCI
467+
# - File: installing-oci-assisted-installer
462468
- Name: Installing on vSphere
463469
Dir: installing_vsphere
464470
Distros: openshift-origin,openshift-enterprise
Loading

installing/installing_oci/_attributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_attributes/

installing/installing_oci/images

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="installing-oci-assisted-installer"]
3+
= Using the Assisted Installer to install a cluster on OCI
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installing-oci-assisted-installer
6+
7+
toc::[]
8+
9+
In {product-title} {product-version}, you can use the Assisted Installer to install a cluster on {oci-first} by using infrastructure that you provide.
10+
11+
// The Assisted Installer and OCI overview
12+
//include::modules/installing-oci-about-assisted-installer.adoc[leveloffset=+1]
13+
////
14+
[role="_additional-resources"]
15+
.Additional resources
16+
17+
* xref:../../installing/installing_platform_agnostic/installing-platform-agnostic.html#cluster-entitlements_installing-platform-agnostic[Internet access for {product-title}]
18+
* xref:../../installing/installing_on_prem_assisted/installing-on-prem-assisted.html#using-the-assisted-installer_installing-on-prem-assisted[Using the Assisted Installer]
19+
20+
// Using the Assisted Installer to install a cluster on OCI
21+
include::modules/installing-using-assisted-installer-oci.adoc[leveloffset=+1]
22+
23+
// Troubleshooting installation of a cluster on OCI
24+
include::modules/installing-troubleshooting-assisted-installer-oci.adoc[leveloffset=+1]
25+
26+
[role="_additional-resources"]
27+
.Additional resources
28+
29+
* xref:../../installing/installing_on_prem_assisted/installing-on-prem-assisted.adoc[Installing an on-premise cluster using the Assisted Installer]
30+
* link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2022/html-single/assisted_installer_for_openshift_container_platform/index[Assisted Installer for {product-title}]
31+
//* link:https://access.redhat.com/node/7038262[Using the Agent-based Installer to install a cluster on OCI]
32+
* link:https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#ariaid-title6[Ways to access Resource Manager]
33+
* [Creating a stack](https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Tasks/create-stack.htm#top) in the Oracle documentation.
34+
////

installing/installing_oci/modules

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules/

installing/installing_oci/snippets

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../snippets/
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-oci-assisted-installer.adoc [Using the Assisted Installer to install a cluster on OCI]
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="installing-oci-about-assisted-installer_{context}"]
7+
= The Assisted Installer and OCI overview
8+
9+
From {product-title} {product-version} and later versions, you can install an {product-title} cluster on {oci-first} virtual machines (VMs) by using the Assisted Installer. You can run cluster workloads on infrastructure that supports dedicated, hybrid, public, and multiple cloud environments. Both Red Hat and Oracle test, validate, and supports running {oci} in an {product-title} cluster on {oci}.
10+
11+
{oci} provides services that can meet your needs for regulatory compliance and performance and cost-effectiveness.
12+
13+
[IMPORTANT]
14+
====
15+
To ensure the best performance conditions for your cluster workloads that operate on {oci}, ensure volume performance units (VPUs) for your block volume are sized for your workloads. The following list provides guidance for selecting the VPUs needed for specific performance needs:
16+
17+
* Test or proof of concept environment: 100 GB, and 20 to 30 VPUs.
18+
* Basic environment: 500 GB, and 60 VPUs.
19+
* Heavy production environment: More than 500 GB, and 100 or more VPUs.
20+
21+
Consider reserving additional VPUs to provide sufficient capacity for updates and scaling activities. For more information about VPUs, see Volume Performance Units in the Oracle documentation.
22+
====
23+
24+
If you are unfamiliar with the {product-title} Assisted Installer, go to the links in the following _Additional resources_ section.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_oci/installing-oci-assisted-installer.adoc [Using the Assisted Installer to install a cluster on OCI]
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="installing-troubleshooting-assisted-installer-oci_{context}"]
7+
= Troubleshooting installation of a cluster on OCI
8+
9+
If you experience issues with using the Assisted Installer to install an {product-title} cluster on {oci-first}, read the following sections to troubleshoot common problems.
10+
11+
== The Ingress Load Balancer in OCI is not at a healthy status
12+
13+
This issue is classed as a `Warning` as against an `Error`, because by using the Resource Manager to create a stack, you created a pool of compute nodes, 3 by default, that are automatically added as backend listeners for the Ingress Load Balancer. By default, the {product-title} deploys two router pods, which are based on the default values from the {product-title} manifest files. The `Warning` is expected because a mismatch exists with the number of router pods available, two, to run on the three compute nodes.
14+
15+
.Example of a `Warning` message that is under the **Backend set information** tab on {oci}:
16+
image::ingress_load_balancer_warning_message.png[Example of an warning message that is under the Backend set information tab on OCI]
17+
18+
You do not need to modify the Ingress Load Balancer's configuration. Instead, you can point the Ingress Load Balancer to specific compute nodes that operate in your cluster on {product-title}. To do this, you will need to use placement mechanisms, such as annotations, on {product-title} to ensure router pods only run on the compute nodes that you originally configured on the Ingress Load Balancer as backend listeners.
19+
20+
== OCI create stack operation fails with an Error: 400-InvalidParameter message
21+
22+
On attempting to create a stack on {oci}, you identified that the **Logs** section of the job outputs an error message. For example:
23+
24+
[source,terminal]
25+
----
26+
Error: 400-InvalidParameter, DNS Label oci-demo does not follow Oracle requirements
27+
Suggestion: Please update the parameter(s) in the Terraform config as per error message DNS Label oci-demo does not follow Oracle requirements
28+
Documentation: https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/core_vcn
29+
----
30+
31+
Go to the https://console.redhat.com/openshift/assisted-installer/clusters/~new[**Install OpenShift with the Assisted Installer**] page on the Hybrid Cloud Console, and check the **Cluster name** field on the **Cluster Details** step. Remove any special characters, such as a hyphen (`-`), from the name, because these special characters are not compatible with the {oci} naming conventions. For example, change `oci-demo` to `ocidemo`.

0 commit comments

Comments
 (0)