Configuring the Platform UI

There are two options for configuring certificates for the Platform UI:

• Configure the Red Hat OpenShift ingress certificates, which the Platform UI selects and uses by default. To get the available methods for updating these certificates, see 3.1. Replacing the default ingress certificate in the OpenShift documentation.

• Configure the Platform UI to use certificates that are specific to its host. To do this, follow the steps in this section.

1. Create the secret in the namespace where the Platform UI is installed. The secret must contain the server certificate (tls.crt) and the server private key (tls.key). However, it does not need to contain the CA certificate (ca.crt).

2. After the secret is created, add the following YAML to the PlatformNavigator custom resource. This can be done by using the Platform UI or by using the CLI. For secretName, enter the name of the secret. If you don't want to use the default keys from the previous step, create custom keys by specifying them here.

   spec:
     tls:
       secretName: ""
       serverCertificate: "" # optional - defaults to tls.crt
       key: "" # optional - defaults to tls.key

3. Save the PlatformNavigator custom resource. When the Platform UI status changes to Ready, refresh the Platform UI home page and confirm that the certificates are updated.

To use a custom hostname, add the following YAML to the PlatformNavigator custom resource. This can be done by using the Platform UI or the CLI. For uiHostname, enter a hostname.

spec:
  uiHostname: "example.app.acme.com"

After the spec.uiHostname value is applied, save the PlatformNavigator custom resource and wait until the Platform UI returns a status of Ready. You can now access the Platform UI on the new hostname.

1. Set the environment variables for your Platform UI instance:

   export PLATFORM_UI_NAMESPACE=<namespace_where_platform_ui_instance_is_installed>
   export PLATFORM_UI_NAME=<name_of_platform_ui_instance>

2. Delete spec.tls from the PlatformNavigator custom resource:

   oc patch platformnavigator ${PLATFORM_UI_NAME} -n ${PLATFORM_UI_NAMESPACE} --type='json' --patch '[{ "op": "remove", "path": "/spec/tls" }]'

   The Platform UI instance status changes to Pending.

When the status of the Platform UI instance changes to Ready, the OpenShift Container Platform ingress certificates are used again.

1. Set the environment variables for your Platform UI instance:

   export PLATFORM_UI_NAMESPACE=<namespace_where_platform_ui_instance_is_installed>
   export PLATFORM_UI_NAME=<name_of_platform_ui_instance>

2. Delete spec.uiHostname from the PlatformNavigator custom resource.

   oc patch platformnavigator ${PLATFORM_UI_NAME} -n ${PLATFORM_UI_NAMESPACE} --type='json' --patch '[{ "op": "remove", "path": "/spec/uiHostname" }]'

   The Platform UI instance status changes to Pending.

When the status of the Platform UI instance changes to Ready, the previous URL (from before you configured a custom hostname) should be usable again.

The following table describes the configurable parameters and default values for the custom resource.

spec.nodeSelector

Configures the nodeSelector section in the Platform UI spec to configure the nodes where the deployment will run:

spec:
  nodeSelector:
    key1: value1
    key2: value2

spec.labels

Configures the labels section in the Platform UI spec to apply labels to the deployment:

spec:
  labels:
    key1: value1
    key2: value2

spec.annotations

Configures the annotations section in the Platform UI spec to apply annotations to the deployment:

spec:
  annotations:
    key1: value1
    key2: value2

spec.resources

Configures the resources section in the Platform UI spec to allocate resource requests and limits:

spec:
  resources:
    navigator:
      imits:
        cpu: '1'
        memory: 512Mi
      requests:
        cpu: '0.25'
        memory: 256Mi
    services:
      limits:
        cpu: '1'
        memory: 512Mi
      requests:
        cpu: '0.25'
        memory: 256Mi

spec.template

Configures the template section in the Platform UI spec to customize the containers:

spec:
  template:
    pod:
      containers:
        - image: placeholder
          imagePullPolicy: IfNotPresent
          name: ibm-cp4i-prod-navigator
        - image: placeholder
          imagePullPolicy: IfNotPresent
          name: ibm-cp4i-prod-services
      imagePullSecrets:
        - ibm-entitlement-key
        - other-key

spec.loggingUrl

Configures the loggingUrl in the Platform UI spec section to enable usage of a custom logging stack:

spec:
  loggingUrl: "https://host.apps.cluster.domain.com/kibana"