+

Search Tips   |   Advanced Search


Web console

  1. Access the web console
  2. Configure the web console
  3. Disable the web console


Access the web console

The OpenShift web console is a user interface accessible from a web browser. Developers can use the web console to visualize, browse, and manage the contents of projects.

Prerequisites

  • JavaScript must be enabled to use the web console. For the best experience, use a web browser that supports WebSockets.
  • Review the OpenShift 4.x Tested Integrations page before creating the supporting infrastructure for the cluster.

The web console runs as a pod on the master. The static assets required to run the web console are served by the pod. Once OpenShift is successfully installed, find the URL for the web console and login credentials for your installed cluster in the CLI output of the installer. For example: 

INFO Install complete!
INFO Run 'export KUBECONFIG=<your working directory>/auth/kubeconfig' to manage the cluster with 'oc', the OpenShift CLI.
INFO The cluster is ready when 'oc login -u kubeadmin -p <provided>' succeeds (wait a few minutes).
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.demo1.openshift4-beta-abcorp.com
INFO Login to the console with user: kubeadmin, password: <provided>

Use those details to log in and access the web console.


Configure the web console

We can modify the OpenShift web console to set a logout redirect URL or disable the console.

Prerequisites

  • Deploy an OpenShift cluster.

We can configure the web console settings by editing the console.config.openshift.io resource.

  • Edit the console.config.openshift.io resource:

      $ oc edit console.config.openshift.io cluster

    The following example displays the sample resource definition for the console: 

    apiVersion: config.openshift.io/v1
kind: Console
metadata:
  name: cluster
spec:
  authentication:
    logoutRedirect: "" 1
status:
  consoleURL: "" 2

    1 Specify the URL of the page to load when a user logs out of the web console. If we do not specify a value, the user returns to the login page for the web console. Specifying a logoutRedirect URL allows your users to perform single logout (SLO) through the identity provider to destroy their single sign-on session.

    2 The web console URL. We cannot modify this parameter value. If we do, the cluster resets it to the default value.


Disable the web console

We can disable the OpenShift web console.

Prerequisites

  • Deploy an OpenShift cluster.

We can disable the web console by editing the console.operator.openshift.io resource.

  • Edit the console.operator.openshift.io resource:

      $ oc edit console.operator.openshift.io cluster

    The following example displays the parameters from this resource that we can modify: 

    apiVersion: config.openshift.io/v1
kind: Console
metadata:
  name: cluster
spec:
  managementState: Removed 1

    1 Set the managementState parameter value to Removed to disable the web console. The other valid values for this parameter are Managed, which enables the console under the cluster's control, and Unmanaged, which means that we are taking control of web console management.



Quick Links


Help


Site Info


Related Sites


About