Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions _build_cfg.yml
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,6 @@ Topics:
File: overview
- Name: Authentication
File: authentication
- Name: Management Console
File: console
- Name: Create a New Application
File: new_app
- Name: Templates
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 48 additions & 13 deletions architecture/infrastructure_components/management_console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,64 @@
toc::[]

== Overview
The OpenShift Management Console is a user interface accessible from a browser.
Developers can link:../../dev_guide/console.html[use the Management Console] to
visualize and browse the contents of their projects.
The OpenShift Management Console is a user interface accessible from a web
browser. Developers can use the Management Console to visualize, browse, and
manage the contents of link:../../dev_guide/projects.html[projects].

The Management Console is started as part of the
link:kubernetes_infrastructure.html#master[master] and by default listens one
port higher than the API server. All static assets required to run the console
are served from the `openshift` binary.

When you access the console from a web browser, it first loads all required
static assets. It then makes requests to the OpenShift and Kubernetes APIs using
the values defined from the `openshift start` options `--public-kubernetes` and
`--public-master`. The console uses WebSockets to maintain a persistent
connection with the API servers and receive updated information as soon as it is
available.
When you access the Management Console from a web browser, it first loads all
required static assets. It then makes requests to the OpenShift and Kubernetes
APIs using the values defined from the `openshift start` options
`--public-kubernetes` and `--public-master`. The Management Console uses
WebSockets to maintain a persistent connection with the API servers and receive
updated information as soon as it is available.

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

image::mgmt_console_request_arch.png["Management Console Request Architecture",align="center"]

The default host name for the console has been whitelisted to communicate with
the API server. To access the console using a different host name, you must
whitelist that host name by specifying the `--cors-allowed-origins` option
during `openshift start`.
The default host name for the Management Console has been whitelisted to
communicate with the API server. To access the Management Console using a
different host name, you must whitelist that host name by specifying the
`--cors-allowed-origins` option during `openshift start`.

== Project Overviews
After link:../../dev_guide/authentication.html[logging in], the Management
Console provides developers with an overview for the currently selected
link:../../dev_guide/projects.html[project]:

====

image::console_navigation.png["Management Console Project Overview"]
<1> The project selector allows you to
link:../../dev_guide/projects.html#view-projects[switch between projects] you
have access to.
<2> link:../../dev_guide/projects.html#filtering-by-labels[Filter] the contents
of a project page by using the
link:../core_objects/kubernetes_model.html#label[labels] of a resource.
<3> Log out of the current user.
<4> Create new applications
link:../../dev_guide/new_app.html#using-the-management-console[using a source
repository] or
link:../../dev_guide/templates.html#using-the-management-console[using a
template].
<5> The *Overview* tab visualizes the contents of your project with a high-level
view of each component.
<6> The *Browse* tab explores the different
link:../core_objects/overview.html[resource types] within your project:
link:../../dev_guide/builds.html[Builds],
link:../../dev_guide/deployments.html[Deployments],
link:../core_objects/openshift_model.html#imagerepository[Image Streams],
link:../core_objects/kubernetes_model.html#pod[Pods], and
link:../core_objects/kubernetes_model.html#service[Services].
<7> The *Settings* tab provides general information about your project, as well
as the link:../../dev_guide/quota.html[quota] and
link:../../dev_guide/limits.html[resource limits] that are set on your project.
<8> Visualization of the contents of your project.
====
11 changes: 7 additions & 4 deletions dev_guide/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@
toc::[]

== Management Console Authentication
When accessing the Management Console from a browser at
`_<master-public-addr>_:8443`, you are automatically redirected to a login page:
When accessing the
link:../architecture/infrastructure_components/management_console.html[Management
Console] from a browser at `_<master-public-addr>_:8443`, you are automatically
redirected to a login page:

image:login_page.png["Management Console Login Page"]

You can provide your login credentials on this page to obtain a token to make
API calls. After logging in, you can navigate your projects
link:console.html[using the Management Console].
API calls. After logging in, you can navigate your projects using the
link:../architecture/infrastructure_components/management_console.html[Management
Console].

== CLI Authentication
You can authenticate from the command line using the CLI command `osc login`.
Expand Down
75 changes: 0 additions & 75 deletions dev_guide/console.adoc

This file was deleted.

Binary file added dev_guide/images/console_projects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
103 changes: 91 additions & 12 deletions dev_guide/projects.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,39 @@ Resources:: pods, services, replication controllers
Policies:: who can or cannot perform an action
Constraints:: quota for the project, limit pods in a project to a pool of nodes

== Create a Project
== Creating a Project [[create-a-project]]

To create a new project:

****
`$ osadm new-project hello-openshift --description="This is an example project to demonstrate OpenShift v3" --display-name="Hello OpenShift" --node-selector="environment=dev"`
`$ osc new-project _<project_name>_ --description="_<description>_"
--display-name="_<display_name>_" --node-selector="_<label>_"`
****

== View Projects
For example:

====

----
$ osc new-project hello-openshift --description="This is an example project to
demonstrate OpenShift v3" --display-name="Hello OpenShift"
--node-selector="environment=dev"`
----
====

== Viewing Projects [[view-projects]]

When you view projects, you are restricted to only seeing the projects you have
access to view based on policy.
access to view based on the
link:../architecture/additional_concepts/authorization.html[authorization
policy].

To view projects:
To view the list of projects:

****
`$ osc get projects`
****

== Switch Between Projects

You can change from the current project to a different project for CLI
operations. The specified project is then used in all subsequent operations that
manipulate project-scoped content:
Expand All @@ -50,7 +62,26 @@ manipulate project-scoped content:
`$ osc project _<project_name>_`
****

== Check Project Status
You can also use the
link:../architecture/infrastructure_components/management_console.html[Management
Console] to view and change between projects. After
link:authentication.html[authenticating] and logging in, you are presented with
a list of projects that you have access to:

====

image:console_projects.png["Projects Page"]
====

If you use link:../cli_reference/get_started_cli.html[the CLI] to
link:#create-a-project[create a new project], you can then refresh the page in
the browser to see the new project.

Selecting a project brings you to the
link:../architecture/infrastructure_components/management_console.html#project-overviews[project
overview] for that project.

== Checking Project Status [[check-project-status]]

The `osc status` command provides a high-level overview of the current project,
with its components and their relationships. This command takes no argument:
Expand All @@ -59,15 +90,63 @@ with its components and their relationships. This command takes no argument:
`$ osc status`
****

== Delete a Project
== Filtering by Labels
You can filter the contents of a project page in the
link:../architecture/infrastructure_components/management_console.html[Management
Console] by using the
link:../architecture/core_objects/kubernetes_model.html#label[labels] of a
resource. You can pick from a suggested label name and values, or type in your
own. Multiple filters can be added. When multiple filters are applied, resources
must match all of the filters to remain visible.

To filter by labels:

. Select a label type:
+
====

image:console_filter_step1.png["Management Console Filter Step 1"]
====

. Select one of the following:
+
[horizontal]
exists:: Verify that the label name exists, but ignore its value.
in:: Verify that the label name exists and is equal to one of the selected
values.
not in:: Verify that the label name does not exist, or is not equal to any of
the selected values.
+
====

image:console_filter_step2.png["Management Console Filter Step 2"]
====
+
.. If you selected *in* or *not in*, select a set of values then select
*Filter*:
+
====

image:console_filter_step3.png["Management Console Filter Step 3"]
====

. After adding filters, you can stop filtering by selecting *Clear all filters*
or by clicking individual filters to remove them:
+
====

image:console_filter_active.png["Management Console Filter Active"]
====

== Deleting a Project [[delete-a-project]]

When you delete a project, the server updates the project status to Terminating
from Active. The server then clears all content from a project that is
Terminating before finally removing the project. While a project is in
from Active. The server then clears all content from a project that is
Terminating before finally removing the project. While a project is in
Terminating status, a user cannot add new content to the project.

To delete a project:

****
`$ osc delete projects hello-openshift`
`$ osc delete project _<project_name>_`
****