Deploying the Platform UI by using the CLI

Deploying the IBM Cloud Pak Platform UI enables you to deploy and manage instances from a central location. This task must be performed by a cluster administrator. For more information see OpenShift roles and permissions.

This procedure describes how to deploy and configure a Platform UI by using the CLI. To deploy by using the OpenShift web console, see Deploying the Platform UI by using the OpenShift console.

Troubleshooting: For a list of possible errors and solutions when following these steps, see Known limitations.

Before you begin

The IBM Cloud Pak foundational services operator is installed, at the v4.6 channel, with the 4.6.8 or later fixpack.
Important: Install this operator manually. For more information, see Installing the operators by using the CLI.
If you are installing in "All namespaces on the cluster" mode, create a namespace called ibm-common-services.
If you have an online OpenShift cluster and you have not already created a secret called ibm-entitlement-key in the namespace where the instance will be created, see Finding and applying your entitlement key by using the UI (online installation).
An OpenShift cluster administrator has created one or more storage classes that support ReadWriteOnce (RWO) for IBM Cloud Pak foundational services to use. For more information, see Storage considerations.
Configure the correct storage class for IBM Cloud Pak foundational services by following the guidance in the "Storage option" section in Keycloak configuration.

Deploying with the CLI

Complete these tasks to create and get access to your instance of the Platform UI:

Creating the Platform UI instance
Getting the URL required to access the Platform UI
Getting the initial admin password

Creating the Platform UI instance

Log into your cluster, using your OpenShift user credentials:
```
oc login
```
If you installed the operators in All namespaces on the cluster mode, you will need to use a project other than openshift-operators in which to deploy the instance.
- If needed, create a new project for this purpose by running:
```
oc new-project <project_name>
```
  For example:
```
oc new-project integration
```
Create a PlatformNavigator YAML file. For example, you could create a file called platform-ui-instance.yaml with the following example configuration. Update the values as indicated:
- For metadata.namespace, enter your project (namespace) name.
- Change the value of spec.license.accept to true if you accept the Cloud Pak for Integration license agreement. For details, see Licensing.
- Change any other configuration details as required.
```
apiVersion: integration.ibm.com/v1beta1
kind: PlatformNavigator
metadata:
  name: integration-quickstart
  namespace: integration
  labels:
    backup.integration.ibm.com/component: platformnavigator        
spec:
  license:
    accept: false
    license: L-QYVA-B365MB
  replicas: 1
  version: 16.1.1
```
If you need advanced configuration options, consult Using the Platform UI.
Apply the YAML file to the OpenShift cluster:
```
oc apply -f platform-ui-instance.yaml
```
Check the status of the Platform UI instance by running the following command in the project (namespace) where it was deployed:
```
oc get platformnavigator
```

Getting the URL required to access the Platform UI

Get a list of console links for the Platform UI on the OpenShift cluster:

oc get consolelink | grep "IBM Cloud Pak for Integration"

This returns a list of URLs, one for each instance of the Platform UI on the cluster. For example:

NAME                                                           TEXT                                  URL                   
integration1-console-link-ibm-integration-platform-navigator   IBM Cloud Pak for Integration [dev]   https://integration-dev.apps.cluster.com
integration2-console-link-ibm-integration-platform-navigator   IBM Cloud Pak for Integration [uat]   https://integration-uat.apps.cluster.com
integration3-console-link-ibm-integration-platform-navigator   IBM Cloud Pak for Integration [prod]  https://integration-prod.apps.cluster.com

For the instance you want to access, copy the URL into your browser.

Next steps

After you complete other deployment tasks in the Platform UI, you can perform additional post-installation configuration:

Managing users. For more information, see Managing users and groups and the other topics in the Identity and access management section.
Configuring identity and access management, including session timeouts. For more information, see Keycloak configuration.
For additional tasks, see Administering.