<commit_before>[[architecture-infrastructure-components-web-console]]
= Web Console
{product-author}
{product-version}
:data-uri:
:icons:
:experimental:
:toc: macro
:toc-title:

ifdef::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[]
toc::[]

== Overview
endif::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[]
The {product-title} 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 xref:../core_concepts/projects_and_users.adoc#projects[projects].

[NOTE]
====
JavaScript must be enabled to use the web console. For the best experience, use
a web browser that supports
link:http://caniuse.com/#feat=websockets[WebSockets].
====

ifdef::openshift-enterprise,openshift-origin[]
The web console is started as part of the
xref:kubernetes_infrastructure.adoc#master[master]. All static assets required
to run the web console are served from the `openshift` binary. Administrators
can also xref:../../install_config/web_console_customization.adoc#install-config-web-console-customization[customize the
web console] using extensions, which let you run scripts and load custom
stylesheets when the web console loads. You can change the look and feel of
nearly any aspect of the user interface in this way.

When you access the web console from a browser, it first loads all required
static assets. It then makes requests to the {product-title} APIs using
the values defined from the `openshift start` option
`--public-master`, or from the related
xref:../../install_config/master_node_configuration.adoc#master-configuration-files[master configuration file] parameter `masterPublicURL`.
The web console uses WebSockets to maintain a persistent connection with the API
server and receive updated information as soon as it is available.

.Web Console Request Architecture
image::web_console_request_arch.png["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 link:http://www.w3.org/TR/cors/[cross-origin]. To access the API server from a web application using a different host name, you must
whitelist that host name by specifying the `--cors-allowed-origins` option
on `openshift start` or from the related
xref:../../install_config/master_node_configuration.adoc#master-configuration-files[master
configuration file parameter `corsAllowedOrigins`].
endif::openshift-enterprise,openshift-origin[]

ifdef::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[]

[[web-console-cli-downloads]]
== CLI Downloads
You can download and unpack the CLI from the *Command Line Tools* page on the web console for
use on Linux, MacOSX, and Windows clients.
ifdef::openshift-enterprise,openshift-origin[]
Cluster administrators can
xref:../../install_config/web_console_customization.adoc#adding-or-changing-links-to-download-the-cli[customize
these links further].
endif::openshift-enterprise,openshift-origin[]

image::cli_help.png["Command Line Tools"]

[[browser-requirements]]
== Browser Requirements

ifdef::openshift-enterprise[]
Review the https://access.redhat.com/articles/2176281[tested integrations] for
{product-title}.
endif::openshift-enterprise[]
The following browser versions and operating systems can be
used to access the web console.

[cols="1,2"]
.Browser Requirements
|===
|Browser (Latest Stable) |Operating System

|Firefox
|Fedora 23, Windows 8

|Internet Explorer
|Windows 8

|Chrome
|Fedora 23, Windows 8, and MacOSX

|Safari
|MacOSX, iPad 2, iPhone 4

|===

[[project-overviews]]

== Project Overviews
After xref:../../dev_guide/authentication.adoc#dev-guide-authentication[logging in], the web console
provides developers with an overview for the currently selected
xref:../../dev_guide/projects.adoc#dev-guide-projects[project]:

====

.Web Console Project Overview
image::console_navigation.png["Web Console Project Overview"]
<1> The project selector allows you to
xref:../../dev_guide/projects.adoc#view-projects[switch between projects] you
have access to.
<2> Create new applications
xref:../../dev_guide/application_lifecycle/new_app.adoc#using-the-web-console-na[using a source
repository] or
xref:../../dev_guide/templates.adoc#creating-from-templates-using-the-web-console[using a
template].
<3> The *Overview* tab (currently selected) visualizes the contents of your
project with a high-level view of each component.
<4> *Applications* tab: Browse and perform actions on your deployments, pods, services, and routes.
<5> *Builds* tab: Browse and perform actions on your builds and image streams.
<6> *Resources* tab: View your current quota consumption and other resources.
<7> *Storage* tab: View persistent volume claims and request storage for your applications.
<8> *Monitoring* tab: View logs for builds, pods, and deployments, as well as event notifications for all objects in your project.
====

ifdef::openshift-enterprise[]
[NOTE]
====
link:http://cockpit-project.org[Cockpit] is automatically installed and enabled in
{product-title} 3.1 and later to help you monitor your development environment.
link:https://access.redhat.com/documentation/en/red-hat-enterprise-linux-atomic-host/version-7/getting-started-with-cockpit/[Red
Hat Enterprise Linux Atomic Host: Getting Started with Cockpit] provides more
information on using Cockpit.
====
endif::openshift-enterprise[]

[[jvm-console]]

== JVM Console

ifdef::openshift-enterprise[]
[NOTE]
====
This feature is currently in Technology Preview and not intended for production use.
====
endif::openshift-enterprise[]

For pods based on Java images, the web console also exposes access to a
http://hawt.io/[hawt.io]-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*.

====
.Pod with a Link to the JVM Console
image::jvm_console_connect.png["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.

====
.JVM Console
image::jvm_console_threads.png["JVM Console"]
====

The following pages are available:

[cols="1,4",options="header"]
|===
|Page |Description

|JMX
|View and manage JMX domains and mbeans.

|Threads
|View and monitor the state of threads.

|ActiveMQ
|View and manage Apache ActiveMQ brokers.

|Camel
|View and and manage Apache Camel routes and dependencies.
|===

////
|OSGi
|View and manage the JBoss Fuse OSGi environment

|Karaf
|
////
endif::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[]

ifdef::atomic-registry[]
The web console is based on the link:http://cockpit-project.org/[Cockpit
Project]. It is deployed as a service using an {product-title} template. The web
console is an optional component.
endif::atomic-registry[]
<commit_msg>removed technology preview wording, per BZ-1419947<commit_after>[[architecture-infrastructure-components-web-console]]
= Web Console
{product-author}
{product-version}
:data-uri:
:icons:
:experimental:
:toc: macro
:toc-title:

ifdef::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[]
toc::[]

== Overview
endif::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[]
The {product-title} 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 xref:../core_concepts/projects_and_users.adoc#projects[projects].

[NOTE]
====
JavaScript must be enabled to use the web console. For the best experience, use
a web browser that supports
link:http://caniuse.com/#feat=websockets[WebSockets].
====

ifdef::openshift-enterprise,openshift-origin[]
The web console is started as part of the
xref:kubernetes_infrastructure.adoc#master[master]. All static assets required
to run the web console are served from the `openshift` binary. Administrators
can also xref:../../install_config/web_console_customization.adoc#install-config-web-console-customization[customize the
web console] using extensions, which let you run scripts and load custom
stylesheets when the web console loads. You can change the look and feel of
nearly any aspect of the user interface in this way.

When you access the web console from a browser, it first loads all required
static assets. It then makes requests to the {product-title} APIs using
the values defined from the `openshift start` option
`--public-master`, or from the related
xref:../../install_config/master_node_configuration.adoc#master-configuration-files[master configuration file] parameter `masterPublicURL`.
The web console uses WebSockets to maintain a persistent connection with the API
server and receive updated information as soon as it is available.

.Web Console Request Architecture
image::web_console_request_arch.png["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 link:http://www.w3.org/TR/cors/[cross-origin]. To access the API server from a web application using a different host name, you must
whitelist that host name by specifying the `--cors-allowed-origins` option
on `openshift start` or from the related
xref:../../install_config/master_node_configuration.adoc#master-configuration-files[master
configuration file parameter `corsAllowedOrigins`].
endif::openshift-enterprise,openshift-origin[]

ifdef::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[]

[[web-console-cli-downloads]]
== CLI Downloads
You can download and unpack the CLI from the *Command Line Tools* page on the web console for
use on Linux, MacOSX, and Windows clients.
ifdef::openshift-enterprise,openshift-origin[]
Cluster administrators can
xref:../../install_config/web_console_customization.adoc#adding-or-changing-links-to-download-the-cli[customize
these links further].
endif::openshift-enterprise,openshift-origin[]

image::cli_help.png["Command Line Tools"]

[[browser-requirements]]
== Browser Requirements

ifdef::openshift-enterprise[]
Review the https://access.redhat.com/articles/2176281[tested integrations] for
{product-title}.
endif::openshift-enterprise[]
The following browser versions and operating systems can be
used to access the web console.

[cols="1,2"]
.Browser Requirements
|===
|Browser (Latest Stable) |Operating System

|Firefox
|Fedora 23, Windows 8

|Internet Explorer
|Windows 8

|Chrome
|Fedora 23, Windows 8, and MacOSX

|Safari
|MacOSX, iPad 2, iPhone 4

|===

[[project-overviews]]

== Project Overviews
After xref:../../dev_guide/authentication.adoc#dev-guide-authentication[logging in], the web console
provides developers with an overview for the currently selected
xref:../../dev_guide/projects.adoc#dev-guide-projects[project]:

====

.Web Console Project Overview
image::console_navigation.png["Web Console Project Overview"]
<1> The project selector allows you to
xref:../../dev_guide/projects.adoc#view-projects[switch between projects] you
have access to.
<2> Create new applications
xref:../../dev_guide/application_lifecycle/new_app.adoc#using-the-web-console-na[using a source
repository] or
xref:../../dev_guide/templates.adoc#creating-from-templates-using-the-web-console[using a
template].
<3> The *Overview* tab (currently selected) visualizes the contents of your
project with a high-level view of each component.
<4> *Applications* tab: Browse and perform actions on your deployments, pods, services, and routes.
<5> *Builds* tab: Browse and perform actions on your builds and image streams.
<6> *Resources* tab: View your current quota consumption and other resources.
<7> *Storage* tab: View persistent volume claims and request storage for your applications.
<8> *Monitoring* tab: View logs for builds, pods, and deployments, as well as event notifications for all objects in your project.
====

ifdef::openshift-enterprise[]
[NOTE]
====
link:http://cockpit-project.org[Cockpit] is automatically installed and enabled in
{product-title} 3.1 and later to help you monitor your development environment.
link:https://access.redhat.com/documentation/en/red-hat-enterprise-linux-atomic-host/version-7/getting-started-with-cockpit/[Red
Hat Enterprise Linux Atomic Host: Getting Started with Cockpit] provides more
information on using Cockpit.
====
endif::openshift-enterprise[]

[[jvm-console]]

== JVM Console

For pods based on Java images, the web console also exposes access to a
http://hawt.io/[hawt.io]-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*.

====
.Pod with a Link to the JVM Console
image::jvm_console_connect.png["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.

====
.JVM Console
image::jvm_console_threads.png["JVM Console"]
====

The following pages are available:

[cols="1,4",options="header"]
|===
|Page |Description

|JMX
|View and manage JMX domains and mbeans.

|Threads
|View and monitor the state of threads.

|ActiveMQ
|View and manage Apache ActiveMQ brokers.

|Camel
|View and and manage Apache Camel routes and dependencies.
|===

////
|OSGi
|View and manage the JBoss Fuse OSGi environment

|Karaf
|
////
endif::openshift-origin,openshift-online,openshift-enterprise,openshift-dedicated[]

ifdef::atomic-registry[]
The web console is based on the link:http://cockpit-project.org/[Cockpit
Project]. It is deployed as a service using an {product-title} template. The web
console is an optional component.
endif::atomic-registry[]

{'fraction_non_alphanumeric': 0.10104107244723332, 'fraction_numerical': 0.005062749572162008, 'mean_word_length': 5.532370749883558, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 21, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 10, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1083156', 'n_tokens_mistral': 4133, 'n_tokens_neox': 3869, 'n_words': 1465}