diff --git a/installing/installing_oci/installing-oci-assisted-installer.adoc b/installing/installing_oci/installing-oci-assisted-installer.adoc index 1bf95eb90a..0a20edd025 100644 --- a/installing/installing_oci/installing-oci-assisted-installer.adoc +++ b/installing/installing_oci/installing-oci-assisted-installer.adoc @@ -6,7 +6,9 @@ include::_attributes/common-attributes.adoc[] toc::[] -From {product-title} {product-version} and later versions, you can use the {ai-full} to install a cluster on {oci-first} by using infrastructure that you provide. +You can use the {ai-full} to install a cluster on {oci-first}. This method is recommended for most users, and requires an internet connection. + +If you want to set up the cluster manually or using other automation tools, or if you are working in a disconnected environment, you can use the Red Hat Agent-based Installer for the installation. For details, see xref:../../installing/installing_oci/installing-oci-agent-based-installer.adoc#installing-oci-agent-based-installer[Installing a cluster on {oci-first-no-rt} by using the Agent-based Installer]. // The Assisted Installer and OCI overview include::modules/installing-oci-about-assisted-installer.adoc[leveloffset=+1] @@ -15,15 +17,26 @@ include::modules/installing-oci-about-assisted-installer.adoc[leveloffset=+1] .Additional resources * link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/[{ai-full} for {product-title}] +* link:https://docs.oracle.com/en-us/iaas/Content/openshift-on-oci/installing-assisted.htm[Installing a Cluster with Red Hat's {ai-full} (Oracle documentation)] * xref:../../installing/installing_platform_agnostic/installing-platform-agnostic.adoc#cluster-entitlements_installing-platform-agnostic[Internet access for {product-title}] -* link:https://docs.oracle.com/en-us/iaas/Content/Block/Concepts/blockvolumeperformance.htm#vpus[Volume Performance Units (Oracle documentation)] -* 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] -// Creating OCI resources and services +// Preparing the OCI environment include::modules/creating-oci-resources-services.adoc[leveloffset=+1] // Using the Assisted Installer to generate an OCI-compatible discovery ISO image -include::modules/using-assisted-installer-oci-agent-iso.adoc[leveloffset=+1] +[id="using-assisted-installer-oci-agent-iso_{context}"] +== Using the {ai-full} to generate an {oci}-compatible discovery ISO image + +Create the cluster configuration and generate the discovery ISO image in the {ai-full} web console. + +.Prerequisites + +* You created a child compartment and an object storage bucket on {oci}. For details, see _Preparing the {oci} environment_. +* You reviewed details about the {product-title} installation and update processes. + +include::modules/using-assisted-installer-oci-create-cluster.adoc[leveloffset=+2] + +include::modules/using-assisted-installer-oci-agent-iso.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources @@ -35,7 +48,15 @@ include::modules/using-assisted-installer-oci-agent-iso.adoc[leveloffset=+1] include::modules/provision-oci-infrastructure-ocp-cluster.adoc[leveloffset=+1] // Completing the remaining Assisted Installer steps -include::modules/complete-assisted-installer-oci.adoc[leveloffset=+1] + +[id="completing-assisted-installer-oci_{context}"] +== Completing the remaining {ai-full} steps + +After you provision {oci-first} resources and upload {product-title} custom manifest configuration files to {oci}, you must complete the remaining cluster installation steps on the {ai-full} before you can create an instance {oci}. These steps include assigning node roles and adding custom manifests. + +include::modules/complete-assisted-installer-oci-node-roles.adoc[leveloffset=+2] + +include::modules/complete-assisted-installer-oci-custom-manifests.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources @@ -52,4 +73,5 @@ include::modules/installing-troubleshooting-assisted-installer-oci.adoc[leveloff .Additional resources * link:https://docs.oracle.com/iaas/Content/openshift-on-oci/openshift-troubleshooting.htm[Troubleshooting {product-title} on {oci} (Oracle documentation)] + * xref:../../installing/installing_on_prem_assisted/installing-on-prem-assisted.adoc#using-the-assisted-installer_installing-on-prem-assisted[Installing an on-premise cluster using the {ai-full}] diff --git a/modules/complete-assisted-installer-oci-custom-manifests.adoc b/modules/complete-assisted-installer-oci-custom-manifests.adoc new file mode 100644 index 0000000000..afdbdaa6eb --- /dev/null +++ b/modules/complete-assisted-installer-oci-custom-manifests.adoc @@ -0,0 +1,31 @@ +// Module included in the following assemblies: +// +// * installing/installing_oci/installing-oci-assisted-installer.adoc + +:_mod-docs-content-type: PROCEDURE +[id="adding-custom-manifests-oci_{context}"] += Adding custom manifests + +Add the mandatory custom manifests provided by Oracle. For details, see link:https://github.com/dfoster-oracle/oci-openshift/blob/v1.0.0-release-preview/custom_manifests/README.md[Custom Manifests (Oracle documentation).] + +.Prerequisites + +* You copied the `dynamic_custom_manifest.yml` file from the Terraform stack in {oci}. For details, see "Provisioning {oci} infrastructure for your cluster". + +.Procedure + +. On the *Custom manifests* page, in the *Folder* field, select `manifests`. This is the {ai-full} folder where you want to save the custom manifest file. + +. In the *File name* field, enter a filename, for example, `dynamic_custom_manifest.yml`. + +. Paste the contents of the `dynamic_custom_manifest.yml` file that you copied from {oci}: + +.. In the *Content* section, click the *Paste content* icon. + +.. If you are using Firefox, click *OK* to close the dialog box, and then press *Ctrl+V*. Otherwise, skip this step. + +. Click *Next* to save the custom manifest. + +. From the *Review and create* page, click *Install cluster* to create your {product-title} cluster on {oci}. + +After the cluster installation and initialization operations, the {ai-full} indicates the completion of the cluster installation operation. For more information, see "Completing the installation" section in the {ai-full} for {product-title} document. diff --git a/modules/complete-assisted-installer-oci-node-roles.adoc b/modules/complete-assisted-installer-oci-node-roles.adoc new file mode 100644 index 0000000000..194043992c --- /dev/null +++ b/modules/complete-assisted-installer-oci-node-roles.adoc @@ -0,0 +1,27 @@ +// Module included in the following assemblies: +// +// * installing/installing_oci/installing-oci-assisted-installer.adoc + +:_mod-docs-content-type: PROCEDURE +[id="assigning-node-roles-oci_{context}"] += Assigning node roles + +Following host discovery, the role of all nodes appears as *Auto-assign* by default. Change each of the node roles to either *Control Plane node* or *Worker*. + +.Prerequisites + +* You created and applied the Terraform stack in {oci}. For details, see "Provisioning {oci} infrastructure for your cluster". + +.Procedure + +. From the {ai-full} user interface, go to the *Host discovery* page. + +. Under the *Role* column, select either *Control plane node* or *Worker* for each targeted hostname. Then click *Next*. ++ +[NOTE] +==== +. Before continuing to the next step, wait for each node to reach `Ready` status. +. Expand the node to verify that the hardware type is bare metal. +==== + +. Accept the default settings for the *Storage* and *Networking* pages. Then click *Next*. diff --git a/modules/complete-assisted-installer-oci.adoc b/modules/complete-assisted-installer-oci.adoc deleted file mode 100644 index a209e3b0e1..0000000000 --- a/modules/complete-assisted-installer-oci.adoc +++ /dev/null @@ -1,39 +0,0 @@ -// Module included in the following assemblies: -// -// * installing/installing_oci/installing-oci-assisted-installer.adoc - -:_mod-docs-content-type: PROCEDURE -[id="complete-assisted-installer-oci_{context}"] -= Completing the remaining {ai-full} steps - -After you provision {oci-first} resources and upload {product-title} custom manifest configuration files to {oci}, you must complete the remaining cluster installation steps on the {ai-full} before you can create an instance {oci}. - -.Prerequisites - -* You created a resource stack on {oci} that includes the custom manifest configuration files and {oci} Resource Manager configuration resources. See "Provisioning {oci} infrastructure for your cluster". - -.Procedure - -. From the link:https://console.redhat.com/[{hybrid-console}] web console, go to the *Host discovery* page. - -. Under the *Role* column, select either `Control plane node` or `Worker` for each targeted hostname. -+ -[IMPORTANT] -==== -Before, you can continue to the next steps, wait for each node to reach the `Ready` status. -==== - -. Accept the default settings for the *Storage* and *Networking* steps, and then click *Next*. - -. On the *Custom manifests* page, in the *Folder* field, select `manifest`. This is the {ai-full} folder where you want to save the custom manifest file. -.. In the *File name* field, enter a value such as `oci-ccm.yml`. -.. From the *Content* section, click *Browse*, and select the CCM manifest from your drive located in `custom_manifest/manifests/oci-ccm.yml`. - -. Expand the next *Custom manifest* section and repeat the same steps for the following manifests: - - CSI driver manifest: `custom_manifest/manifests/oci-csi.yml` - - CCM machine configuration: `custom_manifest/openshift/machineconfig-ccm.yml` - - CSI driver machine configuration: `custom_manifest/openshift/machineconfig-csi.yml` - -. From the *Review and create* page, click *Install cluster* to create your {product-title} cluster on {oci}. - -After the cluster installation and initialization operations, the {ai-full} indicates the completion of the cluster installation operation. For more information, see "Completing the installation" section in the _{ai-full} for {product-title}_ document. diff --git a/modules/creating-oci-resources-services.adoc b/modules/creating-oci-resources-services.adoc index d998f3d7e8..970adff943 100644 --- a/modules/creating-oci-resources-services.adoc +++ b/modules/creating-oci-resources-services.adoc @@ -4,16 +4,38 @@ :_mod-docs-content-type: PROCEDURE [id="creating-oci-resources-services_{context}"] -= Creating {oci} resources and services += Preparing the {oci} environment -Create {oci-first} resources and services so that you can establish infrastructure with governance standards that meets your organization's requirements. +Before installing {product-title} using Assisted Installer, create the necessary resources and download the configuration file in the {oci} environment. .Prerequisites -* You configured an {oci} account to host the cluster. See link:https://docs.oracle.com/iaas/Content/openshift-on-oci/install-prereq.htm[Prerequisites (Oracle documentation)]. +* You have an {oci} account to host the cluster. +* If you use a firewall and you plan to use a Telemetry service, you configured your firewall to allow {product-title} to access the sites required. .Procedure . Log in to your link:https://cloud.oracle.com/a/[{oci-first-no-rt}] account with administrator privileges. -. Download an archive file from an Oracle resource. The archive file includes files for creating cluster resources and custom manifests. The archive file also includes a script, and when you run the script, the script creates {oci} resources, such as DNS records, an instance, and so on. For more information, see link:https://docs.oracle.com/iaas/Content/openshift-on-oci/install-prereq.htm#install-configuration-files[Configuration Files (Oracle documentation)]. +. Configure the account by defining the link:https://docs.oracle.com/iaas/Content/openshift-on-oci/install-prereq.htm[Cloud Accounts and Resources (Oracle documentation)]. Ensure that you create the following resources: + +.. Create a child compartment for organizing, restricting access, and setting usage limits to {oci} resources. For the full procedure, see link:https://docs.oracle.com/en-us/iaas/Content/Identity/compartments/To_create_a_compartment.htm#To[Creating a Compartment (Oracle documentation)]. + +.. Create a new object storage bucket into which you will upload the discovery ISO image. +For the full procedure, see link:https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/managingbuckets_topic-To_create_a_bucket.htm#top[Creating an Object Storage Bucket (Oracle documentation)]. + +. Download the latest version of the `create-cluster-vX.X.X.zip` configuration file from the link:https://github.com/oracle-quickstart/oci-openshift[`oracle-quickstart/oci-openshift`] repository. This file +provides the infrastructure for the cluster and contains configurations for the following: ++ +-- +** *Terraform Stacks*: The Terraform stack code for provisioning {oci} resources to create and manage {product-title} clusters on {oci}. + +** *Custom Manifests*: The manifest files needed for the installation of {product-title} clusters on {oci}. +-- ++ +[NOTE] +==== +To make any changes to the manifests, you can clone the entire Oracle GitHub repository and access the `custom_manifests` and `terraform-stacks` directories directly. +==== ++ +For details, see link:https://docs.oracle.com/iaas/Content/openshift-on-oci/install-prereq.htm#install-configuration-files[Configuration Files (Oracle documentation)]. \ No newline at end of file diff --git a/modules/installing-oci-about-assisted-installer.adoc b/modules/installing-oci-about-assisted-installer.adoc index 733ea48cdc..c9aa5c08a9 100644 --- a/modules/installing-oci-about-assisted-installer.adoc +++ b/modules/installing-oci-about-assisted-installer.adoc @@ -4,34 +4,87 @@ :_mod-docs-content-type: CONCEPT [id="installing-oci-about-assisted-installer_{context}"] -= The {ai-full} and {oci} overview += About the {ai-full} and {oci} integration You can run cluster workloads on {oci-first} infrastructure that supports dedicated, hybrid, public, and multiple cloud environments. Both Red{nbsp}Hat and Oracle test, validate, and support running {oci} in an {product-title} cluster on {oci}. -The {ai-full} supports the {oci} platform, and you can use the {ai-full} to access an intuitive interactive workflow for the purposes of automating cluster installation tasks on {oci}. +This section explains how to use the {ai-full} to install an {product-title} cluster on the {oci} platform. The installation deploys cloud-native components such as {oci-ccm-full} and {oci-csi-full}, and integrates your cluster with {oci} API resources such as instance node, load balancer, and storage. -.Workflow for using the {ai-full} in a connected environment to install a cluster on {oci} +The installation process uses the {product-title} discovery ISO image provided by Red Hat, together with the scripts and manifests provided and maintained by {oci}. -image::684_OpenShift_Installing_on_OCI_0724_assisted.png[Image of a high-level workflow for using the Assisted Installer in a connected environment to install a cluster on {oci}] +[id="installing-oci-preinstallation-considerations_{context}"] +== Preinstallation considerations -{oci} provides services that can meet your needs for regulatory compliance, performance, and cost-effectiveness. You can access {oci} Resource Manager configurations to provision and configure {oci} resources. +Before installing {product-title} on {oci-first-no-rt}, you must consider the following configuration choices. -[IMPORTANT] -==== -The steps for provisioning {oci} resources are provided as an example only. You can also choose to create the required resources through other methods; the scripts are just an example. Installing a cluster with infrastructure that you provide requires knowledge of the cloud provider and the installation process on {product-title}. You can access {oci} Resource Manager configurations to complete these steps, or use the configurations to model your own custom script. -==== +.Deployment platforms -Follow the steps in the _Installing a cluster on {oci-first-no-rt} by using the Assisted Installer_ document to understand how to use the {ai-full} to install a {product-title} cluster on {oci}. This document demonstrates the use of the {oci} Cloud Controller Manager (CCM) and Oracle’s Container Storage Interface (CSI) objects to link your {product-title} cluster with the {oci} API. +The integration between {product-title} and {oci-first-no-rt} is certified on both virtual machines (VMs) and bare-metal (BM) machines. Bare-metal installations using iSCSI boot drives require a secondary vNIC that is automatically created in the Terraform stack provided by Oracle. + +Before you create a virtual machine (VM) or bare-metal (BM) machine, you must identify the relevant {oci} shape. For details, see the following resource: + +* link:https://catalog.redhat.com/cloud/detail/216977[Cloud instance types (Red{nbsp}Hat Ecosystem Catalog portal)]. + +.VPU sizing recommendations -[IMPORTANT] -==== To ensure the best performance conditions for your cluster workloads that operate on {oci}, ensure that 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: * Test or proof of concept environment: 100 GB, and 20 to 30 VPUs. * Basic environment: 500 GB, and 60 VPUs. * Heavy production environment: More than 500 GB, and 100 or more VPUs. -Consider reserving additional VPUs to provide sufficient capacity for updates and scaling activities. For more information about VPUs, see Volume Performance Units (Oracle documentation). -==== +Consider reserving additional VPUs to provide sufficient capacity for updates and scaling activities. For more information about VPUs, see link:https://docs.oracle.com/en-us/iaas/Content/Block/Concepts/blockvolumeperformance.htm#vpus[Volume Performance Units (Oracle documentation)]. -If you are unfamiliar with the {product-title} {ai-full}, see "Assisted Installer for {product-title}". +.Instance sizing recommendations + +Find recommended values for compute instance CPU, memory, VPU, and volume size for {product-title} nodes. For details, see link:https://docs.oracle.com/en-us/iaas/Content/openshift-on-oci/installing-agent-about-instance-configurations.htm[Instance Sizing Recommendations for {product-title} on {oci} Nodes (Oracle documentation)]. + +[id="installing-oci-workflow_{context}"] +== Workflow + +//// +Diagram will be updated and replace steps in a future task: + +The procedure for using the {ai-full} in a connected environment to install a cluster on {oci} is illustrated in the diagram below. + +image::684_OpenShift_Installing_on_OCI_0724_assisted.png[Image of a high-level workflow for using the Assisted Installer in a connected environment to install a cluster on {oci}] +//// + +The procedure for using the {ai-full} in a connected environment to install a cluster on {oci} is outlined below: + +. In the {oci} console, configure an {oci} account to host the cluster: + +.. Create a new child compartment under an existing compartment. + +.. Create a new object storage bucket or use one provided by {oci}. + +.. Download the stack file template stored locally. + +. In the {ai-full} console, set up a cluster: + +.. Enter the cluster configurations. + +.. Generate and download the discovery ISO image. + +. In the {oci} console, create the infrastructure: + +.. Upload the discovery ISO image to the {oci} bucket. + +.. Create a Pre-Authenticated Request (PAR) for the ISO image. + +.. Upload the stack file template, and use it to create and apply the stack. + +.. Copy the custom manifest YAML file from the stack. + +. In the {ai-full} console, complete the cluster installation: + +.. Set roles for the cluster nodes. + +.. Upload the manifests provided by Oracle. + +.. Install the cluster. + +[IMPORTANT] +==== +The steps for provisioning {oci} resources are provided as an example only. You can also choose to create the required resources through other methods; the scripts are just an example. Installing a cluster with infrastructure that you provide requires knowledge of the cloud provider and the installation process on {product-title}. You can access {oci} configurations to complete these steps, or use the configurations to model your own custom script. +==== diff --git a/modules/installing-troubleshooting-assisted-installer-oci.adoc b/modules/installing-troubleshooting-assisted-installer-oci.adoc index d7635d7d29..068a92d781 100644 --- a/modules/installing-troubleshooting-assisted-installer-oci.adoc +++ b/modules/installing-troubleshooting-assisted-installer-oci.adoc @@ -11,7 +11,7 @@ If you experience issues with using the {ai-full} to install an {product-title} [discrete] == The Ingress Load Balancer in {oci} is not at a healthy status -This issue is classed as a `Warning` 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 2 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. +This issue is classed as a `Warning` because by using {oci} 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 2 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. .Example of a `Warning` message that is under the Backend set information tab on {oci} image::ingress_load_balancer_warning_message.png[Example of an warning message that is under the Backend set information tab on {oci}] diff --git a/modules/provision-oci-infrastructure-ocp-cluster.adoc b/modules/provision-oci-infrastructure-ocp-cluster.adoc index db159df22c..827d98ca3a 100644 --- a/modules/provision-oci-infrastructure-ocp-cluster.adoc +++ b/modules/provision-oci-infrastructure-ocp-cluster.adoc @@ -6,16 +6,58 @@ [id="provision-oci-infrastructure-ocp-cluster_{context}"] = Provisioning {oci} infrastructure for your cluster -By using the {ai-full} to create details for your {product-title} cluster, you can specify these details in a stack. A stack is an {oci} feature where you can automate the provisioning of all necessary {oci} infrastructure resources, such as the custom image, that are required for installing an {product-title} cluster on {oci}. - -The {oci-first} Compute Service creates a virtual machine (VM) instance on {oci}. This instance can then automatically attach to a virtual network interface controller (vNIC) in the virtual cloud network (VCN) subnet. On specifying the IP address of your {product-title} cluster in the custom manifest template files, the {oci} instance can communicate with your cluster over the VCN. +When using the {ai-full} to create details for your {product-title} cluster, you specify these details in a Terraform stack. A stack is an {oci} feature that automates the provisioning of all necessary {oci} infrastructure resources that are required for installing an {product-title} cluster on {oci}. .Prerequisites -* You uploaded the discovery ISO image to the {oci} bucket. For more information, see "Using the {ai-full} to generate an {oci}-compatible discovery ISO image". +* You downloaded the discovery ISO image to a local directory. For details, see "Using the {ai-full} to generate an {oci}-compatible discovery ISO image". +* You downloaded the Terraform stack template to a local directory. For details, see "Preparing the {oci} environment". .Procedure -. Complete the steps for provisioning {oci} infrastructure for your {product-title} cluster. See link:https://docs.oracle.com/iaas/Content/openshift-on-oci/installing-assisted.htm#install-cluster-apply-stack[Creating OpenShift Container Platform Infrastructure Using Resource Manager (Oracle documentation)]. +. Log in to your link:https://cloud.oracle.com/a/[{oci-first-no-rt}] account. -. Create a stack, and then edit the custom manifest files according to the steps in the link:https://docs.oracle.com/iaas/Content/openshift-on-oci/installing-assisted.htm#install-cluster-edit-manifests[Editing the OpenShift Custom Manifests (Oracle documentation)]. +. Upload the discovery ISO image from your local drive to the new object storage bucket you created. For the full procedure, see link:https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/managingobjects_topic-To_upload_objects_to_a_bucket.htm[Uploading an Object Storage Object to a Bucket (Oracle documentation)]. + +. Locate the uploaded discovery ISO, and complete the following steps: ++ +-- +.. Create a Pre-Authenticated Request (PAR) for the ISO from the adjacent options menu. + +.. Copy the generated URL to use as the OpenShift Image Source URI in the next step. +-- ++ +For the full procedure, see link:https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/usingpreauthenticatedrequests_topic-To_create_a_preauthenticated_request_for_all_objects_in_a_bucket.htm[Creating a Pre-Authenticated Requests in Object Storage (Oracle documentation)]. + +. Create and apply the Terraform stack: ++ +[IMPORTANT] +==== +The Terraform stack includes files for creating cluster resources and custom manifests. The stack also includes a script, and when you apply the stack, the script creates {oci} resources, such as DNS records, an instance, and so on. For a list of the resources, see link:https://github.com/oracle-openshift/oci-openshift/blob/main/terraform-stacks/README.md[Terraform Defined Resources for OpenShift on {oci} README file]. +==== ++ +-- +.. Upload the Terraform stack template link:https://github.com/oracle-openshift/oci-openshift/releases/tag/main[create-cluster-vX.X.X.zip] to the new object storage bucket. + +.. Complete the stack information and click *Next*. ++ +[IMPORTANT] +==== +* Make sure that *Cluster Name* matches *Cluster Name* in {ai-full}, and *Zone DNS* matches *Base Domain* in {ai-full}. +* In the *OpenShift Image Source URI* field, paste the Pre-Authenticated Request URL link that you generated in the previous step. +* Ensure that the correct *Compute Shape* field value is defined, depending on whether you are installing on bare metal or a virtual machine. If not, select a different shape from the list. For details, see link:docs.oracle.com/en-us/iaas/Content/Compute/References/computeshapes.htm[Compute Shapes (Oracle documentation)]. +==== + +.. Click *Apply* to apply the stack. +-- ++ +For the full procedure, see link:https://docs.oracle.com/en-us/iaas/Content/openshift-on-oci/installing-assisted.htm#install-cluster-apply-stack[Creating {product-title} Infrastructure Using Resource Manager (Oracle documentation)]. + +. Copy the `dynamic_custom_manifest.yml` file from the *Outputs* page of the Terraform stack. ++ +[NOTE] +==== +The YAML file contains all the required manifests, concatenated and preformatted with the configuration values. For details, see the link:https://github.com/oracle-openshift/oci-openshift/blob/main/custom_manifests/README.md[Custom Manifests README file]. +==== ++ +For the full procedure, see link:https://docs.oracle.com/en-us/iaas/Content/openshift-on-oci/installing-assisted.htm#install-cluster-edit-manifests[Getting the {product-title} Custom Manifests for Installation (Oracle documentation)]. diff --git a/modules/using-assisted-installer-oci-agent-iso.adoc b/modules/using-assisted-installer-oci-agent-iso.adoc index f3f82f93b4..df6190d0de 100644 --- a/modules/using-assisted-installer-oci-agent-iso.adoc +++ b/modules/using-assisted-installer-oci-agent-iso.adoc @@ -3,65 +3,26 @@ // * installing/installing_oci/installing-oci-assisted-installer.adoc :_mod-docs-content-type: PROCEDURE -[id="using-assisted-installer-oci-agent-iso_{context}"] -= Using the {ai-full} to generate an {oci}-compatible discovery ISO image +[id="using-assisted-installer-oci-generating-iso_{context}"] += Generating the Discovery ISO image -Generate a discovery ISO image and upload the image to {oci-first}, so that the agent can perform hardware and network validation checks before you install an {product-title} cluster on {oci}. - -From the {oci} web console, you must create the following resources: - -* A compartment for better organizing, restricting access, and setting usage limits to {oci} resources. -* An object storage bucket for safely and securely storing the discovery ISO image. You can access the image at a later stage for the purposes of booting the instances, so that you can then create your cluster. - -.Prerequisites - -* You created a child compartment and an object storage bucket on {oci}. See link:https://docs.oracle.com/iaas/Content/openshift-on-oci/installing-assisted.htm#provisioning-cloud-infrastructure[Provisioning Cloud Infrastructure ({oci} Console)] in the Oracle documentation. -* You reviewed details about the {product-title} installation and update processes. -* If you use a firewall and you plan to use a Telemetry service, you configured your firewall to allow {product-title} to access the sites required. -* Before you create a virtual machines (VM), see link:https://catalog.redhat.com/cloud/detail/216977[Cloud instance types (Red Hat Ecosystem Catalog portal)] to identify the supported {oci} VM shapes. +Generate and download the Discovery ISO image. .Procedure -. From the link:https://console.redhat.com/openshift/assisted-installer/clusters/~new[*Install OpenShift with the Assisted Installer*] page on the Hybrid Cloud Console, generate the discovery ISO image by completing all the required {ai-full} steps. +. On the *Host Discovery* page, click *Add hosts* and complete the following steps: + +.. For the *Provisioning type* field, select *Minimal image file*. + +.. For the *SSH public key* field, add the SSH public key from your local system, by copying the output of the following command: + -.. In the *Cluster Details* step, complete the following fields: +[source,terminal] +---- +$ cat ~/.ssh/id_rsa.put +---- + -[cols="2,2",options="header",subs="quotes"] -|=== -|Field |Action required - -|*Cluster name* -|Specify the name of your cluster, such as `ocidemo`. - -|*Base domain* -|Specify the base domain of the cluster, such as `splat-oci.devcluster.openshift.com`. Provided you previously created a compartment on {oci}, you can get this information by going to *DNS management* -> *Zones* -> *List scope* and then selecting the parent compartment. Your base domain should show under the *Public zones* tab. - -|*OpenShift version* -| Specify `OpenShift 4.17` or a later version. - -|*CPU architecture* -| Specify `x86_64` or `Arm64`. - -|*Integrate with external partner platforms* -|Specify `Oracle Cloud Infrastructure`. - -After you specify this value, the *Include custom manifests* checkbox is selected by default. -|=== - -.. On the *Operators* page, click *Next*. - -.. On the *Host Discovery* page, click *Add hosts*. - -.. For the *SSH public key* field, add your SSH key from your local system. -+ -[TIP] -==== -You can create an SSH authentication key pair by using the `ssh-keygen` tool. -==== +The SSH public key will be installed on all {product-title} control plane and compute nodes. .. Click *Generate Discovery ISO* to generate the discovery ISO image file. -.. Download the file to your local system. - -. Upload the discovery ISO image to the {oci} bucket. See link:https://docs.public.oneportal.content.oci.oraclecloud.com/en-us/iaas/Content/Object/Tasks/managingobjects_topic-To_upload_objects_to_a_bucket.htm[Uploading an Object Storage Object to a Bucket (Oracle documentation)]. -.. You must create a pre-authenticated request for your uploaded discovery ISO image. Ensure that you make note of the URL from the pre-authenticated request, because you must specify the URL at a later stage when you create an {oci} stack. +.. Click *Download Discovery ISO* to save the file to your local system. \ No newline at end of file diff --git a/modules/using-assisted-installer-oci-create-cluster.adoc b/modules/using-assisted-installer-oci-create-cluster.adoc new file mode 100644 index 0000000000..48cc58b273 --- /dev/null +++ b/modules/using-assisted-installer-oci-create-cluster.adoc @@ -0,0 +1,53 @@ +// Module included in the following assemblies: +// +// * installing/installing_oci/installing-oci-assisted-installer.adoc + +:_mod-docs-content-type: PROCEDURE +[id="using-assisted-installer-oci-create-cluster_{context}"] += Creating the cluster + +Set the cluster details. + +.Procedure + +. Log into link:https://console.redhat.com/[{ai-full} web console] with your credentials. + +. In the *Red Hat OpenShift* tile, select *OpenShift*. + +. In the *Red Hat {product-title}* tile, select *Create Cluster*. + +. On the *Cluster Type* page, scroll down to the end of the *Cloud* tab, and select *Oracle Cloud Infrastructure (virtual machines)*. + +. On the *Create an OpenShift Cluster* page, select the *Interactive* tile. + +. On the *Cluster Details* page, complete the following fields: ++ +[cols="1,3",options="header",subs="quotes"] +|=== +|Field |Action required + +|*Cluster name* +|Specify the name of your cluster, such as `oci`. This is the same value as the cluster name in {oci}. + +|*Base domain* +|Specify the base domain of the cluster, such as `openshift-demo.devcluster.openshift.com`. + +This must be the same value as the zone DNS server in {oci}. + +|*OpenShift version* +| * For installations on virtual machines only, specify `OpenShift 4.14` or a later version. + +* For installations that include bare metal machines, specify `OpenShift 4.16` or a later version. + +|*CPU architecture* +| Specify `x86_64` or `Arm64`. + +|*Integrate with external partner platforms* +|Specify `Oracle Cloud Infrastructure`. + +After you specify this value, the *Include custom manifests* checkbox is selected by default and the *Custom manifests* page is added to the wizard. +|=== + +. Leave the default settings for the remaining fields, and click *Next*. + +. On the *Operators* page, click *Next*. diff --git a/modules/verifying-cluster-install-ai-oci.adoc b/modules/verifying-cluster-install-ai-oci.adoc index 8d4c5dea74..2e5fb3abc7 100644 --- a/modules/verifying-cluster-install-ai-oci.adoc +++ b/modules/verifying-cluster-install-ai-oci.adoc @@ -10,18 +10,27 @@ Verify that your cluster was installed and is running effectively on {oci-first} .Procedure -. From the Hybrid Cloud Console, go to **Clusters > Assisted Clusters** and select your cluster’s name. +. From the link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console], go to *Clusters > Assisted Clusters* and select your cluster’s name. -. Check that the Installation progress bar is at 100% and a message displays indicating “Installation completed successfully”. +. On the *Installation Progress* page, check that the Installation progress bar is at 100% and a message displays indicating `Installation completed successfully`. -. To access the {product-title} web console, click the provided Web Console URL. +. Under *Host inventory*, confirm that the status of all control plane and compute nodes is `Installed`. ++ +[NOTE] +==== +{product-title} designates one of the control plane nodes as the bootstrap virtual machine, eliminating the need for a separate bootstrap machine. +==== -. Go to the **Nodes** menu page. +. Click the Web Console URL, to access the {product-title} web console. -. Locate your node from the **Nodes** table. +. From the menu, select *Compute > Nodes*. -. From the **Overview** tab, check that your node has a `Ready` status. +. Locate your node from the *Nodes* table. -. Select the YAML tab. +. From the *Terminal* tab, verify that iSCSI appears next to the serial number. + +. From the *Overview* tab, check that your node has a *Ready* status. + +. Select the *YAML* tab. . Check the `labels` parameter, and verify that the listed labels apply to your configuration. For example, the `topology.kubernetes.io/region=us-sanjose-1` label indicates in what {oci} region the node was deployed.