openstack/openstack-manuals
Code Issues Proposed changes

Dashboard system requirements for the install guide

Browse Source 
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
This commit is contained in:
Joseph Robinson 2015-06-03 13:20:02 +10:00
parent 019f75f9f1
commit b33b598a99
3 changed files with 21 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/install-guide/ch_horizon.xml
View File

@ -17,7 +17,6 @@
<para>Horizon provides a set of core classes and reusable templates and tools.</para>
<para>This example deployment uses an Apache web server.</para>
<xi:include href="section_dashboard-system-reqs.xml"/>
<xi:include href="section_dashboard-install.xml"/>
<xi:include href="section_dashboard-verify.xml"/>
<section xml:id="section_horizon_next_steps">
@ -28,6 +27,12 @@
<para>After you install and configure the dashboard, you can
complete the following tasks:</para>
<itemizedlist>
<listitem>
<para>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.</para>
</listitem>
<listitem>
<para>Customize your dashboard. See section <link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/ch_install-dashboard.html#dashboard-custom-brand"
>Customize the dashboard</link> in the <link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/"
@ -40,6 +45,16 @@
><citetitle>OpenStack Cloud Administrator Guide</citetitle></link> for information on user
session data.</para>
</listitem>
<listitem>
<para>To use the VNC client with the dashboard, the browser
must support HTML5 Canvas and HTML5 WebSockets.</para>
<para>For details about browsers that support noVNC, see <link
xlink:href="https://github.com/kanaka/noVNC/blob/master/README.md">
https://github.com/kanaka/noVNC/blob/master/README.md</link>,
and <link xlink:href="https://github.com/kanaka/noVNC/wiki/Browser-support">
https://github.com/kanaka/noVNC/wiki/Browser-support</link>,
respectively.</para>
</listitem>
</itemizedlist>
</section>
</chapter>

11
doc/install-guide/section_dashboard-install.xml
View File

@ -8,12 +8,11 @@
<title>Install and configure</title>
<para>This section describes how to install and configure the dashboard
on the controller node.</para>
<para>Before you proceed, verify that your system meets the requirements
in <xref linkend="dashboard-system-requirements"/>. 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
<para>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
<link xlink:href="http://docs.openstack.org/developer/horizon/topics/deployment.html">developer documentation</link>.</para>
<para>This section assumes proper installation, configuration, and
operation of the Identity service using the Apache HTTP server and

60
doc/install-guide/section_dashboard-system-reqs.xml
View File

@ -1,60 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="dashboard-system-requirements">
<title>System requirements</title>
<para>Before you install the OpenStack dashboard, you must meet
the following system requirements:</para>
<itemizedlist>
<listitem>
<para>OpenStack Compute installation. Enable the Identity
Service for user and project management.</para>
<para>Note the URLs of the Identity Service and Compute
endpoints.</para>
</listitem>
<listitem>
<para>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.</para>
</listitem>
<listitem>
<para>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.</para>
</listitem>
</itemizedlist>
<para>Then, install and configure the dashboard on a node that
can contact the Identity Service.</para>
<para>Provide users with the following information so that they
can access the dashboard through a web browser on their local
machine:</para>
<itemizedlist>
<listitem>
<para>The public IP address from which they can access the
dashboard</para>
</listitem>
<listitem>
<para>The user name and password with which they can
access the dashboard</para>
</listitem>
</itemizedlist>
<para>Your web browser, and that of your users,
must support HTML5 and have cookies and
JavaScript enabled.</para>
<note>
<para>To use the VNC client with the dashboard, the browser
must support HTML5 Canvas and HTML5 WebSockets.</para>
<para>For details about browsers that support noVNC, see <link
xlink:href="https://github.com/kanaka/noVNC/blob/master/README.md"
>https://github.com/kanaka/noVNC/blob/master/README.md</link>,
and <link
xlink:href="https://github.com/kanaka/noVNC/wiki/Browser-support"
>https://github.com/kanaka/noVNC/wiki/Browser-support</link>,
respectively.</para>
</note>
</section>