Web console
Getting started with the web console in OpenShift Container Platform 4.1
Abstract
Chapter 1. Accessing the web console
The OpenShift Container Platform 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 Container Platform 4.x Tested Integrations page before you create the supporting infrastructure for your cluster.
1.1. Understanding and accessing the web console
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 Container Platform 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.
Chapter 2. Configuring the web console in OpenShift Container Platform
You can modify the OpenShift Container Platform web console to set a logout redirect URL or disable the console.
Prerequisites
- Deploy an OpenShift Container Platform cluster.
2.1. Configuring the web console
You can configure the web console settings by editing the console.config.openshift.io resource.
Edit the
console.config.openshift.ioresource:$ 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 you do not specify a value, the user returns to the login page for the web console. Specifying a
logoutRedirectURL allows your users to perform single logout (SLO) through the identity provider to destroy their single sign-on session. - 2
- The web console URL. You cannot modify this parameter value. If you do, the cluster resets it to the default value.
Chapter 3. Disabling the web console in OpenShift Container Platform
You can disable the OpenShift Container Platform web console.
Prerequisites
- Deploy an OpenShift Container Platform cluster.
3.1. Disabling the web console
You can disable the web console by editing the console.operator.openshift.io resource.
Edit the
console.operator.openshift.ioresource:$ oc edit console.operator.openshift.io cluster
The following example displays the parameters from this resource that you can modify:
apiVersion: config.openshift.io/v1 kind: Console metadata: name: cluster spec: managementState: Removed 1- 1
- Set the
managementStateparameter value toRemovedto disable the web console. The other valid values for this parameter areManaged, which enables the console under the cluster’s control, andUnmanaged, which means that you are taking control of web console management.
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
