From b33b598a993a3db4b47ec121d21b0d5eeb56b39e Mon Sep 17 00:00:00 2001 From: Joseph Robinson Date: Wed, 3 Jun 2015 13:20:02 +1000 Subject: [PATCH] Dashboard system requirements for the install guide Because horizon is deployed on the controller node from Juno and Kilo onwards, this patch removes the system requirements section, which has documentation for deploying horizon on a server other than the controller node. It moves any important information from the system requirements chapter to the introduction and concluding paragraphs of the Horizon chapter. Change-Id: I653c12c3e895111d08ecf8fef017e82fca2f909d backport: juno kilo Closes-Bug: #1426451 --- doc/install-guide/ch_horizon.xml | 17 +++++- .../section_dashboard-install.xml | 11 ++-- .../section_dashboard-system-reqs.xml | 60 ------------------- 3 files changed, 21 insertions(+), 67 deletions(-) delete mode 100644 doc/install-guide/section_dashboard-system-reqs.xml diff --git a/doc/install-guide/ch_horizon.xml b/doc/install-guide/ch_horizon.xml index 8c2f49b492..f49e0302df 100644 --- a/doc/install-guide/ch_horizon.xml +++ b/doc/install-guide/ch_horizon.xml @@ -17,7 +17,6 @@ Horizon provides a set of core classes and reusable templates and tools. This example deployment uses an Apache web server. -
@@ -28,6 +27,12 @@ After you install and configure the dashboard, you can complete the following tasks: + + Provide users with a public IP address, a username, and a password + so they can access the dashboard through a web browser. In case of + any SSL certificate connection problems, point the server + IP address to a domain name, and give users access. + Customize your dashboard. See section Customize the dashboard in the OpenStack Cloud Administrator Guide for information on user session data. + + To use the VNC client with the dashboard, the browser + must support HTML5 Canvas and HTML5 WebSockets. + For details about browsers that support noVNC, see + https://github.com/kanaka/noVNC/blob/master/README.md, + and + https://github.com/kanaka/noVNC/wiki/Browser-support, + respectively. +
diff --git a/doc/install-guide/section_dashboard-install.xml b/doc/install-guide/section_dashboard-install.xml index cc132c6a12..3717b03f8b 100644 --- a/doc/install-guide/section_dashboard-install.xml +++ b/doc/install-guide/section_dashboard-install.xml @@ -8,12 +8,11 @@ Install and configure This section describes how to install and configure the dashboard on the controller node. - Before you proceed, verify that your system meets the requirements - in . Also, the dashboard - relies on functional core services including Identity, Image service, - Compute, and either Networking (neutron) or legacy networking - (nova-network). Environments with stand-alone services such as Object - Storage cannot use the dashboard. For more information, see the + The dashboard relies on functional core services including + Identity, Image service, Compute, and either Networking (neutron) + or legacy networking (nova-network). Environments with + stand-alone services such as Object Storage cannot use the + dashboard. For more information, see the developer documentation. This section assumes proper installation, configuration, and operation of the Identity service using the Apache HTTP server and diff --git a/doc/install-guide/section_dashboard-system-reqs.xml b/doc/install-guide/section_dashboard-system-reqs.xml deleted file mode 100644 index 55389aacc7..0000000000 --- a/doc/install-guide/section_dashboard-system-reqs.xml +++ /dev/null @@ -1,60 +0,0 @@ - -
- System requirements - Before you install the OpenStack dashboard, you must meet - the following system requirements: - - - OpenStack Compute installation. Enable the Identity - Service for user and project management. - Note the URLs of the Identity Service and Compute - endpoints. - - - Identity Service user with sudo privileges. Because - Apache does not serve content from a root user, users - must run the dashboard as an Identity Service user - with sudo privileges. - - - Python 2.7. - The Python version must support - Django. The Python version should run on any - system, including Mac OS X. Installation prerequisites - might differ by platform. - - - Then, install and configure the dashboard on a node that - can contact the Identity Service. - Provide users with the following information so that they - can access the dashboard through a web browser on their local - machine: - - - The public IP address from which they can access the - dashboard - - - The user name and password with which they can - access the dashboard - - - Your web browser, and that of your users, - must support HTML5 and have cookies and - JavaScript enabled. - - To use the VNC client with the dashboard, the browser - must support HTML5 Canvas and HTML5 WebSockets. - For details about browsers that support noVNC, see https://github.com/kanaka/noVNC/blob/master/README.md, - and https://github.com/kanaka/noVNC/wiki/Browser-support, - respectively. - -