Red Hat Connectivity Link

Use the OpenShift web console

The OpenShift Container Platform web console is available after your Connectivity Link installation on OpenShift Container Platform 4.19 and newer is complete, but you must enable the plugin.

OpenShift Container Platform 4.20 and newer: After you enable the web console, you can use it to see the status of your Gateway and route objects, create and manage policies, and create and manage APIs.
OpenShift Container Platform 4.19: You can use the web console to see the status of your Gateway, route objects, and policies. You can create Gateway objects, routes, and policies, but you cannot manage APIs.

Important

UI elements are either displayed or hidden, and either active or disabled, based on your Kubernetes role-based-access (RBAC) permissions. For example:

Cluster administrators are cluster-scoped and can see all of the features in the web console.
Developers and API owners are namespace-scoped. Developers and API owners must configure roles to grant access to specific workflows, such as browsing the API catalog, requesting API keys, or approving access requests.

In the navigation menu, use the Connectivity Link section to select one of the following pages as available for your role:

Overview: A dashboard showing Gateway objects, policies and their status, and HTTPRoute and GRPCRoutes across the cluster. If you have permissions, you can also create, edit, and delete custom resources (CRs), including Gateway CRs.

Policies: A tabbed list of all Connectivity Link policy types, such as AuthPolicy, RateLimitPolicy, DNSPolicy, and TLSPolicy CRs. If you have permissions, you can also create, edit, and delete policy CRs.

API Products: You can search for, create, and edit API products according to your permissions.

Policy Topology: A visual graph of the relationships between Gateway and HTTPRoute objects and the policies attached to them.

If you are on OpenShift Container Platform 4.20 or newer, on the navigation menu, use the Connectivity Link API Catalog section to select one of the following pages as available for your role:

API Key Approvals: A list of API key requests and their status.

My API Keys: A list of your approved API keys.

Enable the Connectivity Link OpenShift Container Platform console plugin

If you did not enable the Connectivity Link OpenShift Container Platform web console plugin for installation, you can enable it to access API management features later. You can skip this procedure if you enabled the OpenShift web console during Connectivity Link installation.

Prerequisites

You have installed Connectivity Link.
You have access to your OpenShift Container Platform cluster as a user with the cluster-admin role.

Procedure

In the OpenShift Container Platform web console, navigate to Administration → Cluster Settings.
Click the Configuration tab.
In the Configuration resource list, click Console operator.config.openshift.io.
Click the Console plugins tab.
In the Console plugins section, locate the kuadrant-console-plugin entry.
Click the toggle to enable the plugin.

The console reloads automatically.

Verification

In the OpenShift Container Platform web console navigation menu, verify that the Connectivity Link section is displayed.
Click Connectivity Link and verify that the following pages are available:
- API Products
- Connectivity Link API Catalog section containing:
  - API Key Approvals
  - My API Keys

Enable the Connectivity Link Red Hat Developer Hub console plugin

If you have a subscription to Red Hat Developer Hub, you can use the web console as your internal developer portal. You must enable the Connectivity Link Red Hat Developer Hub plugin in the Kuadrant custom resource (CR) you created during installation before you can use Red Hat Developer Hub.

You can skip this procedure if you enabled the Red Hat Developer Hub plugin during Connectivity Link installation.

Prerequisites

You installed Connectivity Link.
You have a Red Hat Developer Hub subscription.
You are logged into OpenShift Container Platform as a cluster administrator.
You are using a supported configuration of OpenShift Container Platform and required components.
You installed the OpenShift CLI (oc).

Procedure

If you have a Red Hat Developer Hub subscription, update your Connectivity Link CR with the Red Hat Developer Hub plugin enabled by using the following example:
```
apiVersion: kuadrant.io/v1beta1
kind: Kuadrant
metadata:
#...
spec:
  components:
    developerPortal:
      enabled: true
#...
```
Apply the CR by running the following command:
```
$ oc apply -f <kuadrant.yaml>
```
Replace <kuadrant.yaml> with the name of your Connectivity Link deployment YAML.

Verification

Check the status of the Connectivity Link CR generation by running the following command:
```
$ oc wait kuadrant/kuadrant --for="condition=Ready=true" -n <kuadrant_system> --timeout=300s
```
Replace <kuadrant_system> with the namespace you used.
Example output
```
kuadrant.kuadrant.io/kuadrant Ready
```
Check that the Red Hat Developer Hub pod is ready by running the following command:
```
$ oc wait pod -n <kuadrant_system> -l app=developer-portal-controller --for=condition=Ready --timeout=120s
```
Replace <kuadrant_system> with the namespace you used.
Example output
```
pod/developer-portal-controller-7f8d69bc7b-x4z2q condition met
```
The exact random string at the end of the pod name varies based on your deployment replica set.