Configure the Red Hat OpenShift connector

Learn how to set up and configure the OpenShift connector.

Prerequisites

• A Red Hat OpenShift environment deployed using the IPI (Installer-Provisioned Infrastructure) method. While the connector may also function with UPI (User-Provisioned Infrastructure) deployments, this setup has not yet been fully validated.

  See the reference: https://docs.redhat.com/en/documentation/openshift_container_platform

  The connector uses the OpenShift Container Platform APIs to collect cluster and environment details.

  See the reference: https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/api_overview/index

• The Red Hat OpenShift environment must have the KubeVirt virtualization add-on deployed and configured.

  The connector uses the KubeVirt APIs to collect the details about the virtual machines.

  See the reference: https://kubevirt.io/api-reference/

• You require Administrator access to a Self-managed OpenShift platform to retrieve the cluster API data and Organization access to the Red Hat account.

• For the required versions of the products, refer to Compatibility Matrix and Product Dependencies.

Get the subscription token

An offline subscription token is required to get the organization level subscription API details.

1. Login to your Red Hat OpenShift service and navigate to the Red Hat Subscription Manager API Tokens page.

2. Select the Generate Token button.

3. Copy and save the generated token to use later when configuring the connector.

note

It is recommended that you save the token somewhere safe, as these are not stored by the vendor. If the token expires after 30 days of inactivity, you must regenerate a new token using the steps described in this section.

Procedure

In Snow Integration Manager, add the Red Hat OpenShift connector and then configure the settings:

1. Enter a Site name for the collection of OpenShift clusters.

   This setting will override the Global site name.

2. To set up a proxy server, select the desired proxy in Proxy. Proxies can be configured in the Proxy Profiles tab in the Snow Integration Manager main interface.

3. To get organization level subscription details, paste the Offline Token as saved in Get the subscription token.

4. To add one or more Red Hat OpenShift servers to scan for virtual machines, select Add.

5. On the OpenShift Cluster window, enter the Name of your connection cluster.

6. To get the access token for your cluster, initiate OAuth authentication:

   1. Enter the OAuth URL and then select Get Token.

   2. In the browser that opens, enter your service account credentials with access to the cluster APIs. This initiates the authentication process.

   3. Select the Display Token option that appears in the browser.

   4. Copy and save the API token that is displayed.

7. In Auth Token, paste the API token obtained from the authentication.

8. In the API URL, enter the API base URL of the OpenShift server.

9. To verify the connection, select Test Connection.

   Once a connection is established, the connector is ready to fetch the data.