Skip to content

Commit 6d3526f

Browse files
authored
Merge pull request #74910 from dfitzmau/OCPBUGS-32490
OCPBUGS-32490: Removed OCI steps from ABI docs
2 parents 2e09d0f + a827275 commit 6d3526f

8 files changed

+63
-100
lines changed

installing/installing_oci/installing-oci-agent-based-installer.adoc

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,15 @@ include::modules/installing-oci-about-agent-based-installer.adoc[leveloffset=+1]
1919
* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#understanding-agent-install_preparing-to-install-with-agent-based-installer[Understanding the Agent-based Installer]
2020
* link:https://docs.oracle.com/en-us/iaas/Content/Compute/Concepts/computeoverview.htm[Overview of the Compute Service (Oracle documentation)]
2121
* link:https://docs.oracle.com/en-us/iaas/Content/Block/Concepts/blockvolumeperformance.htm#vpus[Volume Performance Units (Oracle documentation)]
22+
* link:https://docs.oracle.com/iaas/Content/openshift-on-oci/installing-agent-about-instance-configurations.htm[Instance Sizing Recommendations for {product-title} on {oci} Nodes (Oracle documentation)]
2223
2324
// Creating OCI infrastructure resources and services
24-
include::modules/creating-oci-infra-resources-services.adoc[leveloffset=+1]
25+
include::modules/abi-oci-resources-services.adoc[leveloffset=+1]
2526

2627
[role="_additional-resources"]
2728
.Additional resources
2829

29-
* link:https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcompartments.htm#ariaid-title5[Creating compartments (Oracle documentation)]
30-
* link:https://docs.oracle.com/en-us/iaas/Content/Network/Tasks/create_vcn.htm[Creating a VCN (Oracle documentation)]
31-
* link:https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/create-nsg.htm[Creating an NSG (Oracle documentation)]
32-
* link:https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengdynamicgrouppolicyforselfmanagednodes.htm[Creating a dynamic group and a policy for self-managed nodes (Oracle documentation)]
33-
* link:https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingpolicies.htm[Managing policies (Oracle documentation)]
34-
* link:https://docs.oracle.com/en-us/iaas/Content/Balance/Tasks/managingloadbalancer_topic-Creating_Load_Balancers.htm[Creating a load balancer (Oracle documentation)]
35-
* link:https://docs.oracle.com/en-us/iaas/Content/DNS/Tasks/record-add.htm[Adding a record to a DNS zone (Oracle documentation)]
30+
* link:https://docs.oracle.com/en-us/iaas/Content/GSG/Concepts/concepts.htm[Learn About Oracle Cloud Basics (Oracle documentation)]
3631
3732
// Creating configuration files for installing a cluster on OCI
3833
include::modules/creating-config-files-cluster-install-oci.adoc[leveloffset=+1]
@@ -41,15 +36,10 @@ include::modules/creating-config-files-cluster-install-oci.adoc[leveloffset=+1]
4136
.Additional resources
4237

4338
* xref:../../architecture/architecture-installation.adoc#installation-overview_architecture-installation[About {product-title} installation]
44-
4539
* xref:../../installing/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type]
46-
4740
* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#about-the-agent-based-installer[Preparing to install with the Agent-based Installer]
48-
4941
* 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]
50-
5142
* xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the {product-title} image repository]
52-
5343
* 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]
5444
5545
// Configuring your firewall
@@ -62,6 +52,8 @@ include::modules/running-cluster-oci-agent-based.adoc[leveloffset=+1]
6252
.Additional resources
6353

6454
* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#recommended-resources-for-topologies[Recommended resources for topologies]
55+
* link:https://docs.oracle.com/iaas/Content/openshift-on-oci/installing-agent-about-instance-configurations.htm[Instance Sizing Recommendations for {product-title} on {oci} Nodes (Oracle documentation)]
56+
* link:https://docs.oracle.com/iaas/Content/openshift-on-oci/openshift-troubleshooting.htm[Troubleshooting {product-title} on {oci} (Oracle documentation)]
6557
6658
// Verifying a succesful cluster installation on OCI
6759
include::modules/verifying-cluster-install-oci-agent-based.adoc[leveloffset=+1]
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
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="abi-oci-resources-services_{context}"]
7+
= Creating {oci} infrastructure resources and services
8+
9+
You must create an {oci} environment on your virtual machine (VM) 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+
The Agent-based installer method for installing an {product-title} cluster on {oci} requires that you manually create {oci} resources and services.
12+
13+
[IMPORTANT]
14+
====
15+
To ensure compatibility with {product-title}, you must set `A` as the record type for each DNS record and name records as follows:
16+
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.
20+
21+
The `api.+*+` and `api-int.+*+` 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.
22+
====
23+
24+
.Prerequisites
25+
26+
* You configured an {oci} account to host the {product-title} cluster. See link:https://docs.oracle.com/iaas/Content/openshift-on-oci/install-prereq.htm[Prerequisites (Oracle documentation)].
27+
28+
.Procedure
29+
30+
* Create the required {oci} resources and services. See link:https://docs.oracle.com/iaas/Content/openshift-on-oci/agent-prereq.htm[{oci} Resources Needed for Using the Agent-based Installer (Oracle documentation)].

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

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,22 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="creating-config-files-cluster-install-oci_{context}"]
7-
= Creating configuration files for installing a cluster on OCI
7+
= Creating configuration files for installing a cluster on {oci}
88

99
You need to 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.
1010

11-
In a later procedure, you can upload 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}.
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}.
1212

13+
[NOTE]
14+
====
1315
You can also use the Agent-based Installer to generate or accept Zero Touch Provisioning (ZTP) custom resources.
16+
====
1417

1518
.Prerequisites
1619
* You reviewed details about the {product-title} installation and update processes.
17-
* You read the documentation on selecting a cluster installation method and preparing it for users.
20+
* You read the documentation on selecting a cluster installation method and preparing the method for users.
1821
* You have read the "Preparing to install with the Agent-based Installer" documentation.
19-
* You downloaded the Agent-Based Installer and the command-line interface (CLI) from the Red{nbsp}Hat Hybrid Cloud Console.
22+
* You downloaded the Agent-Based Installer and the command-line interface (CLI) from the {hybrid-console}.
2023
* You have logged in to the {product-title} with administrator privileges.
2124
2225
.Procedure
@@ -83,7 +86,7 @@ pullSecret: '<pull_secret>' <6>
8386
<3> Depending on your infrastructure, you can select either `x86_64`, or `amd64`.
8487
<4> Set `OCI` as the external platform, so that {product-title} can integrate with {oci}.
8588
<5> Specify your SSH public key.
86-
<6> The pull secret that you need for authenticate purposes when downloading container images for {product-title} components and services, such as Quay.io. See link:https://console.redhat.com/openshift/install/pull-secret[Install {product-title} 4] from the Red{nbsp}Hat Hybrid Cloud Console.
89+
<6> The pull secret that you need for authenticate purposes when downloading container images for {product-title} components and services, such as Quay.io. See link:https://console.redhat.com/openshift/install/pull-secret[Install {product-title} 4] from the {hybrid-console}.
8790
8891
. Create a directory on your local system named `openshift`.
8992
+
@@ -92,16 +95,11 @@ pullSecret: '<pull_secret>' <6>
9295
Do not move the `install-config.yaml` and `agent-config.yaml` configuration files to the `openshift` directory.
9396
====
9497

95-
. From the link:https://github.com/oracle-quickstart/oci-openshift[`oracle-quickstart / oci-openshift`] GitHub web page, select the *<> Code* button and click *Download ZIP*. Save the archive file to your `openshift` directory, so that all the {oci-ccm-full} and {oci-csi-full} manifests exist in the same directory. The downloaded archive file includes files for creating cluster resources and custom manifests.
98+
. Complete the steps in the link:https://docs.oracle.com/iaas/Content/openshift-on-oci/install-prereq.htm#install-configuration-files["Configuration Files"] section of the _Oracle_ documentation to download {oci-ccm-full} and {oci-csi-full} manifests as an archive file and save the archive file in your `openshift` directory. You need the {oci-ccm} manifests for deploying the {oci-ccm} during cluster installation so that {product-title} can connect to the external {oci} platform. You need the {oci-csi} custom manifests for deploying the {oci-csi} driver during cluster installation so that {product-title} can claim required objects from {oci}.
9699

97-
. Go to the link:https://github.com/oracle-quickstart/oci-openshift/tree/main/custom_manifests[custom_manifests] web page on GitHub to access the custom manifest files.
98-
+
99-
The {oci-ccm} manifest are required for deploying the {oci-ccm} during cluster installation so that {product-title} can connect to the external {oci} platform. The {oci-csi} custom manifests are required for deploying the {oci-csi} driver during cluster installation so that {product-title} can claim required objects from {oci}.
100+
. Access the custom manifest files that are provided in the link:https://docs.oracle.com/iaas/Content/openshift-on-oci/install-prereq.htm#install-configuration-files["Configuration Files"] section of the _Oracle_ documentation.
100101
+
101-
[IMPORTANT]
102-
====
103-
You must change the secret `oci-cloud-controller-manager` defined in the link:https://github.com/oracle-quickstart/oci-openshift/blob/main/custom_manifests/manifests/oci-ccm.yml[`oci-ccm.yml`] configuration file to match your organization's region, compartment {ocid}, VCN {ocid}, and the subnet {ocid} from the load balancer.
104-
====
102+
.. Change the `oci-cloud-controller-manager` secret that is defined in the `oci-ccm.yml` configuration file to match your organization's region, compartment {ocid}, VCN {ocid}, and the subnet {ocid} from the load balancer.
105103

106104
. Use the Agent-based Installer to generate a minimal ISO image, which excludes the rootfs image, by entering the following command in your {product-title} CLI. You can use this image later in the process to boot all your cluster’s nodes.
107105
+

modules/creating-oci-infra-resources-services.adoc

Lines changed: 0 additions & 48 deletions
This file was deleted.

modules/installing-oci-about-agent-based-installer.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="installing-oci-about-agent-based-installer_{context}"]
7-
= The Agent-based Installer and OCI overview
7+
= The Agent-based Installer and {oci} overview
88

99
You can install an {product-title} cluster on {oci-first} by using the Agent-based Installer. Both Red Hat and Oracle test, validate, and support running {oci} and {ocvs-first} workloads in an {product-title} cluster on {oci}.
1010

11-
:FeatureName: Using the Agent-based Installer to install an {product-title} cluster on OCI that is configured with a virtual machine (VM) compute instance
11+
:FeatureName: Using the Agent-based Installer to install an {product-title} cluster on {oci} that is configured with a virtual machine (VM) compute instance
1212
include::snippets/technology-preview.adoc[]
1313

1414
The Agent-based installer provides the ease of use of the Assisted Installation service, but with the capability to install a cluster in either a connected or disconnected environment.
@@ -36,5 +36,5 @@ To ensure the best performance conditions for your cluster workloads that operat
3636
* Basic environment: 500 GB, and 60 VPUs.
3737
* Heavy production environment: More than 500 GB, and 100 or more VPUs.
3838
39-
Consider reserving additional VPUs to provide sufficient capacity for updates and scaling activities. For more information about VPUs, see Volume Performance Units (Oracle_ documentatio).
39+
Consider reserving additional VPUs to provide sufficient capacity for updates and scaling activities. For more information about VPUs, see Volume Performance Units (Oracle documentation).
4040
====

0 commit comments

Comments
 (0)