Prerequisites

Before installing an OpenShift Container Platform cluster on Oracle Cloud Infrastructure (OCI), ensure you have completed the necessary prerequisites. The accounts, resources, and configurations needed for a successful installation are outlined in this document.

Cloud Accounts and Resources

To install an OpenShift Container Platform cluster on OCI, you need:

You also need the following resources:
  1. An internet domain to serve the OpenShift Container Platform console that runs on cluster resources in OCI.
  2. An SSH key pair for cluster installation.
  3. A pull secret provided from the Red Hat Hybrid Cloud Console. See Using image pull secrets in the Red Hat documentation details.
  4. (Optional) A dedicated compartment for the cluster resources. You can also use an existing compartment. See Understanding Compartments and Creating a Compartment for more information.
  5. (Optional) An Object Storage bucket to store the discovery ISO image. You can also use an existing bucket. See Creating an Object Storage Bucket for more information.
Note

  • For Agent-based Installer users: If you use a firewall in your OCI environment and plan to use a Telemetry service, ensure the firewall allows OpenShift Container Platform to access the sites required. See Configuring your firewall for OpenShift Container Platform in the Red Hat documentation for details on setting up your firewall's allowlist for OpenShift.
  • Before creating an OCI instance for your cluster, refer to the Cloud instance types on the Red Hat Ecosystem Catalog portal for supported Red Hat Enterprise Linux (RHEL)-certified OCI VM and bare metal shapes.
  • To run OpenShift, the application requires manage permissions to perform CRUD operations on Instances, Volumes, and Networking resources. We recommend that customers deploy OpenShift in a dedicated compartment to avoid potential conflicts with other applications that might be running in the same compartment.

Resource Attribution Tags

Before installing an OpenShift cluster on OCI, download and run the create-resource-attribution-tags-vX.X.X.zip stack from the OpenShift on OCI Releases page on GitHub. This stack creates a tag namespace and associated defined-tags (openshift-tags and openshift-resource) that are essential for all subsequent stacks to function correctly.

See the following topics for more information on tagging: Creating a Tag Namespace, Creating a Tag Key Definition and Using Cost-Tracking Tags for more information on tagging.

Important

  • Ensure to run the create-resource-attribution-tags stack before running the create-cluster stack to avoid cluster installation failure.
  • The create-resource-attribution-tags stack only needs to be run once. If the tag namespace and defined-tags are already created, you can directly proceed with cluster installation.

Configuration Files

The required configuration files are available in the OpenShift on OCI Releases page on GitHub. Navigate to this page and select the link for the latest release (for example, for release v1.0.0, select the link for "v1.0.0"). From the Assets section, download the create-cluster-vX.X.X.zip file.

The create-cluster-vX.X.X.zip file includes:

  • Custom Manifests: The manifest files needed for the installation of Red Hat OpenShift clusters on OCI. For more information about each manifest and when to use them, see Custom Manifests.
  • Terraform Stacks: The Terraform stack code for provisioning OCI resources to create and manage OpenShift clusters on OCI. For more information, see Terraform Defined Resources for OpenShift.
    Note

    To make any edits to the manifests, you can clone the entire oracle-quickstart / oci-openshift repository and access the custom_manifests and terraform-stacks directories directly.