Web Console

    You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see

    The OKD 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.

    The web console runs as a pod on the . The static assets required to run the web console are served by the pod. Administrators can also customize the web console using extensions, which let you run scripts and load custom stylesheets when the web console loads.

    When you access the web console from a browser, it first loads all required static assets. It then makes requests to the OKD APIs using the values defined from the option --public-master, or from the related parameter masterPublicURL in the webconsole-config config map defined in the openshift-web-console namespace. The web console uses WebSockets to maintain a persistent connection with the API server and receive updated information as soon as it is available.

    Figure 1. Web Console Request Architecture

    The configured host names and IP addresses for the web console are whitelisted to access the API server safely even when the browser would consider the requests to be . To access the API server from a web application using a different host name, you must whitelist that host name by specifying the option on openshift start or from the related master configuration file parameter corsAllowedOrigins.

    The corsAllowedOrigins parameter is controlled by the configuration field. No pinning or escaping is done to the value. The following is an example of how you can pin a host name and escape dots:

    • The pins to the beginning of the domain (and matches the double slash following http: or https:).

    • The \. escapes dots in the domain name.

    You can access CLI downloads from the Help icon in the web console:

    CLI dropdown from Help icon

    Cluster administrators can .

    Review the tested integrations for OKD.

    After , the web console provides developers with an overview for the currently selected project:

    Web Console Project Overview

    Figure 2. Web Console Project Overview

    For pods based on Java images, the web console also exposes access to a -based JVM console for viewing and managing any relevant integration components. A Connect link is displayed in the pod’s details on the Browse → Pods page, provided the container has a port named jolokia.

    Figure 3. Pod with a Link to the JVM Console

    After connecting to the JVM console, different pages are displayed depending on which components are relevant to the connected pod.

    Figure 4. JVM Console

    The following pages are available: