Chapter 1. Installing Red Hat Developer Hub on OpenShift Container Platform with the Operator
You can install Red Hat Developer Hub on OpenShift Container Platform by using the Red Hat Developer Hub Operator in the OpenShift Container Platform console.
1.1. Installing the Red Hat Developer Hub Operator
As an administrator, you can install the Red Hat Developer Hub Operator. Authorized users can use the Operator to install Red Hat Developer Hub on the following platforms:
- Red Hat OpenShift Container Platform (OpenShift Container Platform)
- Amazon Elastic Kubernetes Service (EKS)
- Microsoft Azure Kubernetes Service (AKS)
For more information on OpenShift Container Platform supported versions, see the Red Hat Developer Hub Life Cycle.
Containers are available for the following CPU architectures:
-
AMD64 and Intel 64 (
x86_64
)
Prerequisites
- You are logged in as an administrator on the OpenShift Container Platform web console.
- You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the Red Hat OpenShift Container Platform documentation on Building applications.
For enhanced security, better control over the Operator lifecycle, and preventing potential privilege escalation, install the Red Hat Developer Hub Operator in a dedicated default rhdh-operator
namespace. You can restrict other users' access to the Operator resources through role bindings or cluster role bindings.
You can also install the Operator in another namespace by creating the necessary resources, such as an Operator group. For more information, see Installing global Operators in custom namespaces.
However, if the Red Hat Developer Hub Operator shares a namespace with other Operators, then it shares the same update policy as well, preventing the customization of the update policy. For example, if one Operator is set to manual updates, the Red Hat Developer Hub Operator update policy is also set to manual. For more information, see Colocation of Operators in a namespace.
Procedure
- In the Administrator perspective of the OpenShift Container Platform web console, click Operators > OperatorHub.
- In the Filter by keyword box, enter Developer Hub and click the Red Hat Developer Hub Operator card.
- On the Red Hat Developer Hub Operator page, click Install.
On the Install Operator page, use the Update channel drop-down menu to select the update channel that you want to use:
The fast channel provides y-stream (x.y) and z-stream (x.y.z) updates, for example, updating from version 1.1 to 1.2, or from 1.1.0 to 1.1.1.
ImportantThe
fast
channel includes all of the updates available for a particular version. Any update might introduce unexpected changes in your Red Hat Developer Hub deployment. Check the release notes for details about any potentially breaking changes.- The fast-1.1 channel only provides z-stream updates, for example, updating from version 1.1.1 to 1.1.2. If you want to update the Red Hat Developer Hub y-version in the future, for example, updating from 1.1 to 1.2, you must switch to the fast channel manually.
On the Install Operator page, choose the Update approval strategy for the Operator:
- If you choose the Automatic option, the Operator is updated without requiring manual confirmation.
- If you choose the Manual option, a notification opens when a new update is released in the update channel. The update must be manually approved by an administrator before installation can begin.
- Click Install.
Verification
- To view the installed Red Hat Developer Hub Operator, click View Operator.
1.2. Deploying Red Hat Developer Hub on OpenShift Container Platform with the Operator
As a developer, you can deploy a Red Hat Developer Hub instance on OpenShift Container Platform by using the Developer Catalog in the Red Hat OpenShift Container Platform web console. This deployment method uses the Red Hat Developer Hub Operator.
Prerequisites
- A cluster administrator has installed the Red Hat Developer Hub Operator. For more information, see Section 1.1, “Installing the Red Hat Developer Hub Operator”.
- You have added a custom configuration file to OpenShift Container Platform. For more information, see Adding a custom configuration file to OpenShift Container Platform.
Procedure
Create a project in OpenShift Container Platform for your Red Hat Developer Hub instance, or select an existing project.
TipFor more information about creating a project in OpenShift Container Platform, see Creating a project by using the web console in the Red Hat OpenShift Container Platform documentation.
- From the Developer perspective on the OpenShift Container Platform web console, click +Add.
- From the Developer Catalog panel, click Operator Backed.
- In the Filter by keyword box, enter Developer Hub and click the Red Hat Developer Hub card.
- Click Create.
- Add custom configurations for the Red Hat Developer Hub instance.
- On the Create Backstage page, click Create
Verification
After the pods are ready, you can access the Red Hat Developer Hub platform by opening the URL.
- Confirm that the pods are ready by clicking the pod in the Topology view and confirming the Status in the Details panel. The pod status is Active when the pod is ready.
From the Topology view, click the Open URL icon on the Developer Hub pod.
Additional resources