diff --git a/_build_cfg.yml b/_build_cfg.yml index 91147dee46e4..42f735aacabc 100644 --- a/_build_cfg.yml +++ b/_build_cfg.yml @@ -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 diff --git a/architecture/infrastructure_components/images/console_navigation.png b/architecture/infrastructure_components/images/console_navigation.png new file mode 100644 index 000000000000..1ca7b80db645 Binary files /dev/null and b/architecture/infrastructure_components/images/console_navigation.png differ diff --git a/architecture/infrastructure_components/management_console.adoc b/architecture/infrastructure_components/management_console.adoc index 2c609031bdd4..88a5cc88f430 100644 --- a/architecture/infrastructure_components/management_console.adoc +++ b/architecture/infrastructure_components/management_console.adoc @@ -10,21 +10,21 @@ 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 @@ -32,7 +32,42 @@ 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. +==== diff --git a/dev_guide/authentication.adoc b/dev_guide/authentication.adoc index 295fe6552b08..4a92d102e73a 100644 --- a/dev_guide/authentication.adoc +++ b/dev_guide/authentication.adoc @@ -10,14 +10,17 @@ toc::[] == Management Console Authentication -When accessing the Management Console from a browser at -`__: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 `__: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`. diff --git a/dev_guide/console.adoc b/dev_guide/console.adoc deleted file mode 100644 index e38580b9065f..000000000000 --- a/dev_guide/console.adoc +++ /dev/null @@ -1,75 +0,0 @@ -= Management Console -{product-author} -{product-version} -:data-uri: -:icons: -:experimental: -:toc: macro -:toc-title: - -toc::[] - -== Overview -With the OpenShift Management Console, you can visualize and browse the contents -of your projects. - -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]. - -== Navigating -The Management Console's navigation structure is focused around projects. The -project selector allows you to switch between projects you have access to: - -image:console_navigation.png["Console Navigation"] - -Use the left tabs to navigate within a project: - -Overview:: Visualize the contents of your project with a high-level view of each component. -Browse:: Explore the different resource types within your project. -Settings:: General information about your project, as well as the link:../architecture/core_objects/kubernetes_model.html#resourcequota[quota] and link:../architecture/core_objects/kubernetes_model.html#limitrange[resource limits] that are set on your project. - -== Filtering by Labels -Filter the contents of a project page by using the 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["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["Console Filter Step 2"] -==== -+ -.. If you selected *in* or *not in*, select a set of values then select *Filter*: -+ -==== - -image:console_filter_step3.png["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["Console Filter Active"] -==== - -== Creating a Configuration From a Template -You can create many important Kubernetes and OpenShift resources from the -Management Console by utilizing link:../dev_guide/templates.html[templates]. diff --git a/dev_guide/images/console_projects.png b/dev_guide/images/console_projects.png new file mode 100644 index 000000000000..38da7f66d3e7 Binary files /dev/null and b/dev_guide/images/console_projects.png differ diff --git a/dev_guide/images/console_navigation.png b/dev_guide/images/console_services.png similarity index 100% rename from dev_guide/images/console_navigation.png rename to dev_guide/images/console_services.png diff --git a/dev_guide/projects.adoc b/dev_guide/projects.adoc index 97f3e5d3d9e0..229a76052c0a 100644 --- a/dev_guide/projects.adoc +++ b/dev_guide/projects.adoc @@ -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 __ --description="__" +--display-name="__" --node-selector="_