diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 8bf3df31db..fb845b2f36 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -342,6 +342,9 @@ endif::[] :oci-distributed-no-rt: Oracle Distributed Cloud :oci-edge: Oracle(R) Edge Cloud :oci-edge-no-rt: Oracle Edge Cloud +:oda-first: Oracle Database Appliance (ODA) +:oda: Oracle Database Appliance +:oda-short: ODA // Red Hat OpenStack Platform (RHOSP)/OpenStack ifndef::openshift-origin[] :rh-openstack-first: Red{nbsp}Hat OpenStack Platform (RHOSP) diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index e984d54e0e..b0431a3945 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -604,6 +604,12 @@ Topics: File: installing-c3-assisted-installer - Name: Installing a cluster on Oracle Edge Cloud by using the Agent-based Installer File: installing-c3-agent-based-installer +- Name: Installing on Oracle Database Appliance + Dir: installing_oda + Distros: openshift-enterprise + Topics: + - Name: Installing a cluster on Oracle Database Appliance by using the Assisted Installer + File: installing-oda-assisted - Name: Installing on VMware vSphere Dir: installing_vsphere Distros: openshift-origin,openshift-enterprise diff --git a/installing/installing_oda/_attributes b/installing/installing_oda/_attributes new file mode 120000 index 0000000000..20cc1dcb77 --- /dev/null +++ b/installing/installing_oda/_attributes @@ -0,0 +1 @@ +../../_attributes/ \ No newline at end of file diff --git a/installing/installing_oda/images b/installing/installing_oda/images new file mode 120000 index 0000000000..847b03ed05 --- /dev/null +++ b/installing/installing_oda/images @@ -0,0 +1 @@ +../../images/ \ No newline at end of file diff --git a/installing/installing_oda/installing-oda-assisted.adoc b/installing/installing_oda/installing-oda-assisted.adoc new file mode 100644 index 0000000000..0c9c2fbc4a --- /dev/null +++ b/installing/installing_oda/installing-oda-assisted.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: ASSEMBLY +include::_attributes/common-attributes.adoc[] +[id="installing-oda-assisted-installer"] += Installing a cluster on {oda} by using the Assisted Installer +:context: installing-oda-assisted-installer + +toc::[] + +[role="_abstract"] +You can use the {ai-full} to install a cluster on {oda-first}. + +include::modules/ai-oda-environment.adoc[leveloffset=+1] + +include::modules/ai-oda-discovery.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* xref:../../installing/installing_platform_agnostic/installing-platform-agnostic.adoc#ssh-agent-using_installing-platform-agnostic[Generating a key pair for cluster node SSH access] + +include::modules/ai-oda-create-nodes.adoc[leveloffset=+1] + +include::modules/ai-oda-start-install.adoc[leveloffset=+1] + +include::modules/ai-oda-complete-install.adoc[leveloffset=+1] \ No newline at end of file diff --git a/installing/installing_oda/modules b/installing/installing_oda/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/installing/installing_oda/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file diff --git a/installing/installing_oda/snippets b/installing/installing_oda/snippets new file mode 120000 index 0000000000..5a3f5add14 --- /dev/null +++ b/installing/installing_oda/snippets @@ -0,0 +1 @@ +../../snippets/ \ No newline at end of file diff --git a/modules/ai-oda-complete-install.adoc b/modules/ai-oda-complete-install.adoc new file mode 100644 index 0000000000..e5b7c2ea4c --- /dev/null +++ b/modules/ai-oda-complete-install.adoc @@ -0,0 +1,51 @@ +:_mod-docs-content-type: PROCEDURE +[id="abi-oda-complete-install_{context}"] += Completing the installation + +[role="_abstract"] +After the cluster is installed and initialized, the {ai-full} indicates that the installation is finished. The {ai-full} provides the console URL, the `kubeadmin` username and password, and the `kubeconfig` file. + +.Prerequisites + +* You have installed the {oc-first}. + +.Procedure + +. Make a copy of the `kubeadmin` username and password. + +. Download the `kubeconfig` file and copy it to the auth directory under your working directory by running the following commands: ++ +[source,terminal] +---- +$ mkdir -p /auth +---- ++ +[source,terminal] +---- +$ cp kubeconfig /auth +---- ++ +[NOTE] +==== +The `kubeconfig` file is available for download for 20 days after completing the installation. +==== + +. Add the `kubeconfig` file to your environment by running the following command: ++ +[source,terminal] +---- +$ export KUBECONFIG=/auth/kubeconfig +---- + +. Log in with the {oc-first} by running the following command: ++ +[source,terminal] +---- +$ oc login -u kubeadmin -p +---- ++ +Replace `` with the password of the `kubeadmin` user. + +. Click the web console URL or click **Launch OpenShift Console** to open the console. + +. Enter the `kubeadmin` username and password. Follow the instructions in the {product-title} console to configure an identity provider and configure alert receivers. \ No newline at end of file diff --git a/modules/ai-oda-create-nodes.adoc b/modules/ai-oda-create-nodes.adoc new file mode 100644 index 0000000000..ba130d3115 --- /dev/null +++ b/modules/ai-oda-create-nodes.adoc @@ -0,0 +1,14 @@ +:_mod-docs-content-type: PROCEDURE +[id="abi-oda-create-nodes_{context}"] += Creating nodes in the {oda} environment + +[role="_abstract"] +After generating and downloading the Discovery ISO to your {oda-first} environment, create control plane nodes and worker nodes in the environment. + +.Procedure + +. Run the script to create control plane nodes as described in section 3.4 of the link:https://www.oracle.com/a/otn/docs/red-hat-openshift-container-platform-4-19.pdf[Red{nbsp}Hat {product-title} on {oda} Deployment Guide] (Oracle documentation). + +. Run the script to create worker nodes as described in section 3.5 of the "Red{nbsp}Hat {product-title} on {oda} Deployment Guide". + +. Update the MAC address for each node as described in section 3.6 of the "Red{nbsp}Hat {product-title} on {oda} Deployment Guide". diff --git a/modules/ai-oda-discovery.adoc b/modules/ai-oda-discovery.adoc new file mode 100644 index 0000000000..889fb12bce --- /dev/null +++ b/modules/ai-oda-discovery.adoc @@ -0,0 +1,76 @@ +:_mod-docs-content-type: PROCEDURE +[id="abi-oda-discovery-iso_{context}"] += Beginning the cluster installation and generating the Discovery ISO + +[role="_abstract"] +Begin installing the {product-title} cluster in the {oda-first} environment by using the {hybrid-console}. + +.Procedure + +. Log in to the link:https://console.redhat.com/openshift/cluster-list[{hybrid-console}]. + +. On the *Cluster List* page, click *Create cluster*. + +. Click the *Datacenter* tab. + +. Under *Assisted Installer*, click *Create cluster*. + +. Configure your cluster on the *Cluster details* page: + +.. Enter a name for the cluster in the *Cluster name* field. + +.. Enter a base domain for the cluster in the *Base domain* field. +All subdomains for the cluster will use this base domain. ++ +[NOTE] +==== +The base domain must be a valid DNS name. +You must not have a wildcard domain set up for the base domain. +==== + +.. Select a version from the *OpenShift version* dropdown list. +By default, the dropdown list displays the latest version. + +.. Optional: In the *Number of control plane nodes* field, select the number of control plane nodes for your installation from the dropdown menu. +The default value is `3`. + +.. Optional: Select the *Include custom manifests* checkbox if you want to upload custom manifests to further configure your cluster. +This option adds an additional page for custom manifests that you use later in the configuration process. ++ +[IMPORTANT] +==== +If you have already added custom manifests, clearing the *Include custom manifests* checkbox automatically deletes them all. +You must confirm the deletion. +==== + +.. Click *Next* to continue. +Once you proceed to the next page, you cannot go back to change any of these cluster details. + +. Choose additional Operators to install on the *Operators* page: + +.. If you want to install an Operator bundle, select an option in the *Bundles* section. + +.. If you want to install only some Operators, select the individual Operators from the *Single Operators* section. + +.. Click *Next* to continue. + +. Upload an SSH public key and generate the Discovery ISO: + +.. Click the *Add Hosts* button in the *Host Discovery* page. + +.. Upload an SSH public key in the *SSH public key* section so that you can connect to the cluster nodes as the `core` user. +If you do not already have an SSH public key, see "Generating a key pair for cluster node SSH access" for more information. + +.. Select *Show proxy settings*. + +.. Enter values for the *HTTP proxy URL*, *HTTPS URL proxy*, and *No proxy domains* fields. + +.. Click *Generate Discovery ISO*. + +. Copy the command from the *Command to download the ISO* field and run the command as a root user in the {oda-short} environment. ++ +.Example command +[source,terminal] +---- +# wget -O discovery_image_example.iso 'https://api.openshift.com/api/assisted-images/bytoken/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3Njg0Mjc3MDIsInN1YiI6ImNhMzZjZWU1LTQ3ZWEtNDc0Ny05OTg5LTVhZTYyMmMzMjZlNSJ9.jl-HvaxBR-WX73vpxO-Fy65bmY-RE5iL6AqL0wbWCmE/4.20/x86_64/minimal.iso' +---- \ No newline at end of file diff --git a/modules/ai-oda-environment.adoc b/modules/ai-oda-environment.adoc new file mode 100644 index 0000000000..3f17d330d9 --- /dev/null +++ b/modules/ai-oda-environment.adoc @@ -0,0 +1,16 @@ +:_mod-docs-content-type: PROCEDURE +[id="ai-oda-env_{context}"] += Preparing the {oda} environment + +[role="_abstract"] +Before you can deploy an {product-title} cluster on {oda-first}, you must prepare the {oda-short} environment. + +.Prerequisites + +* You have reviewed the requirements and additional prerequisites described in section 1 of the link:https://www.oracle.com/a/otn/docs/red-hat-openshift-container-platform-4-19.pdf[Red{nbsp}Hat {product-title} on {oda} Deployment Guide] (Oracle documentation). + +.Procedure + +. Complete the pre-deployment tasks as described in section 2 of the "Red{nbsp}Hat {product-title} on {oda} Deployment Guide". + +. Complete the final environment preparations as described in sections 3.1 and 3.2 of the "Red{nbsp}Hat {product-title} on {oda} Deployment Guide". \ No newline at end of file diff --git a/modules/ai-oda-start-install.adoc b/modules/ai-oda-start-install.adoc new file mode 100644 index 0000000000..30a8aa3080 --- /dev/null +++ b/modules/ai-oda-start-install.adoc @@ -0,0 +1,40 @@ +:_mod-docs-content-type: PROCEDURE +[id="abi-oda-start-install_{context}"] += Completing host discovery and starting cluster installation + +[role="_abstract"] +After preparing control plane and worker nodes in the {oda-first} environment, complete host discovery and initiate the cluster installation. + +As you create hosts using the provided scripts, the hosts begin to appear in the table of the **Host Discovery** page, where you can configure the hosts as needed. + +.Procedure + +. Go to the **Host Discovery** page. + +. Assign host roles in the **Host Inventory** table: + +.. In the **Role** column of the table, expand the **Auto-Assign** arrow for the host. + +.. Assign the host with either a **Control Plane node** or a **Worker** role. + +.. Repeat this process for each host in the table. + +. Click **Next**. + +. On the *Storage* page, verify storage details and configure host storage as needed. + +. Click **Next**. + +. Configure networking details on the **Networking** page: + +.. Select **User-Managed Networking** as the **Network Management** type. + +.. Select **Host SSH Public Key for troubleshooting after installation** to connect to hosts using a public SSH key for troubleshooting after installation. + +. Click **Next**. + +. Validate cluster details on the **Review and create** page. + +. Click **Install cluster** to begin the installation. + +. Monitor installation progress and wait for all nodes to reach a `Ready` state. \ No newline at end of file