Prerequisites
Before beginning the installation process for the OpenShift Container Platform cluster on Oracle Cloud Infrastructure (OCI), ensure you have all the necessary accounts, resources, and configurations in place for a successful installation.
Accounts and Resources
- Red Hat Account: A Red Hat account and access to either the Assisted Installer or the Agent-based Installer.
- OCI Account: An OCI account with an Identity Domain and permissions to manage the following resources:
Additional Resources
- An internet domain to serve the OpenShift Container Platform console that runs on cluster resources in OCI.
- An SSH key pair for cluster installation.
- A pull secret from the Red Hat Hybrid Cloud Console. For more information, see Using image pull secrets (Red Hat documentation).
- (Optional) A dedicated compartment for the cluster resources. You can also use an existing compartment. For more information, see Understanding Compartments and Creating a Compartment.
- (Optional) An Object Storage bucket to store the discovery ISO image. You can also use an existing bucket. For more information, see Creating an Object Storage Bucket.
- Firewall access (Agent-based Installer): If you use a firewall in your OCI environment and plan to use a Telemetry service, ensure the firewall has allowlisted OpenShift Container Platform to access the sites required. For more information, see Configuring your firewall for OpenShift Container Platform (Red Hat documentation).
- Supported instance shapes: Before creating an OCI instance for a cluster, verify which VM and bare metal shapes are certified for Red Hat Enterprise Linux (RHEL). For more information, see Cloud instance types on the Red Hat Ecosystem Catalog portal.
-
Permissions: OpenShift requires Manage permissions to perform operations on instances, volumes, and networking resources. Deploy OpenShift in a dedicated compartment to avoid 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
) required for subsequent stacks to function correctly.
See Tags and Tag Namespace Concepts for instructions. For high-level tagging details, see the Terraform Defined Resources for OpenShift on OCI page on GitHub. For specific resource definitions, access the resource_attribution_tag
folder in the shared_modules directory.
- Run the
create-resource-attribution-tags
stack before running thecreate-cluster
stack to avoid installation failure. - The
create-resource-attribution-tags
stack only needs to be run once. If the tag namespace and defined-tags already exist, you can skip this step for future installations.
Configuration Files
The latest version of the stack with the required configuration files is automatically loaded when you open the Red Hat OpenShift plugin in the OCI Console.
To access an earlier version of the stack, navigate to the OpenShift on OCI Releases GitHub page and download the create-cluster
zip file from the Assets folder.
The create-cluster
zip file includes:
- Custom Manifests: The manifest files needed for OpenShift cluster installation. For more information about the files, see Custom Manifests.
- Terraform Stacks: The Terraform stack code for provisioning OCI infrastructure to create and manage OpenShift clusters. For more information, see Terraform Defined Resources for OpenShift.Note
To make any changes to the manifests or Terraform code, you can clone the oracle-quickstart / oci-openshift GitHub repository and access thecustom_manifests
andterraform-stacks
directories directly.