Increase dashboard installation introduction clarity
Moved content associated with the administration guide to the "next steps" section of the Horizon install guide. Added content to the Horizon installation introduction to increase clarity, and match the OpenStack installation documents. Unified xml file header. Change-Id: I3a1f9fc1e1515d22a6b3e7ddc19df1db3ecfd884 backport: none Implements: blueprint installation-guide-improvements
This commit is contained in:
Joseph Robinson
Diane Fleming
parent
4ba9387bc5
commit
3489d19410
@ -13,32 +13,33 @@
|
|||||||
<para>The dashboard enables web-based interactions with the
|
<para>The dashboard enables web-based interactions with the
|
||||||
OpenStack Compute cloud controller through the OpenStack
|
OpenStack Compute cloud controller through the OpenStack
|
||||||
APIs.</para>
|
APIs.</para>
|
||||||
<para>These instructions show an example deployment configured with
|
<para>Horizon enables you to customize the brand of the dashboard.</para>
|
||||||
an Apache web server.</para>
|
<para>Horizon provides a set of core classes and reusable templates and tools.</para>
|
||||||
<para>After you <link linkend="install_dashboard">install and
|
<para>This example deployment uses an Apache web server.</para>
|
||||||
configure the dashboard</link>, you can complete the following
|
|
||||||
tasks:</para>
|
|
||||||
<itemizedlist>
|
|
||||||
<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/"
|
|
||||||
><citetitle>OpenStack Cloud Administrator
|
|
||||||
Guide</citetitle></link>.</para>
|
|
||||||
</listitem>
|
|
||||||
<listitem>
|
|
||||||
<para>Set up session storage for the dashboard. See <xref
|
|
||||||
linkend="dashboard-sessions"/>.</para>
|
|
||||||
</listitem>
|
|
||||||
</itemizedlist>
|
|
||||||
<xi:include href="section_dashboard-system-reqs.xml"/>
|
<xi:include href="section_dashboard-system-reqs.xml"/>
|
||||||
<xi:include href="section_dashboard-install.xml"/>
|
<xi:include href="section_dashboard-install.xml"/>
|
||||||
<xi:include href="../common/section_dashboard_sessions.xml"/>
|
|
||||||
<section xml:id="section_horizon_next_steps">
|
<section xml:id="section_horizon_next_steps">
|
||||||
<title>Next steps</title>
|
<title>Next steps</title>
|
||||||
<para>Your OpenStack environment now includes the dashboard. You can
|
<para>Your OpenStack environment now includes the dashboard. You can
|
||||||
<link linkend="launch-instance">launch an instance</link> or add more
|
<link linkend="launch-instance">launch an instance</link> or add
|
||||||
services to your environment in the following chapters.</para>
|
more services to your environment in the following chapters.</para>
|
||||||
|
<para>After you install and configure the dashboard, you can
|
||||||
|
complete the following tasks:</para>
|
||||||
|
<itemizedlist>
|
||||||
|
<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/"
|
||||||
|
><citetitle>OpenStack Cloud Administrator Guide</citetitle></link>
|
||||||
|
for information on setting up colors, logos, and site titles.</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Set up session storage. See section <link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/dashboard-sessions.html#dashboard-sessions">Set up session storage for the dashboard</link>
|
||||||
|
in the <link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/"
|
||||||
|
><citetitle>OpenStack Cloud Administrator Guide</citetitle></link> for information on user
|
||||||
|
session data.</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
</section>
|
</section>
|
||||||
</chapter>
|
</chapter>
|
||||||
|
|||||||
@ -6,96 +6,74 @@
|
|||||||
xml:id="install_dashboard">
|
xml:id="install_dashboard">
|
||||||
<?dbhtml stop-chunking?>
|
<?dbhtml stop-chunking?>
|
||||||
<title>Install the dashboard</title>
|
<title>Install the dashboard</title>
|
||||||
<para>Before you can install and configure the dashboard, meet the
|
<para>Before you can install and configure the dashboard, meet the requirements in <xref
|
||||||
requirements in <xref linkend="dashboard-system-requirements"
|
linkend="dashboard-system-requirements"/>.</para>
|
||||||
/>.</para>
|
|
||||||
<note>
|
<note>
|
||||||
<para>When you install only Object Storage and the Identity
|
<para>When you install the dashboard with only OpenStack Object Storage and Identity, the
|
||||||
Service, even if you install the dashboard, it does not
|
dashboard does not show projects and is unusable.</para>
|
||||||
pull up projects and is unusable.</para>
|
|
||||||
</note>
|
</note>
|
||||||
<para>For more information about how to deploy the dashboard, see
|
<para>For more information about how to deploy the dashboard, see <link
|
||||||
<link
|
|
||||||
xlink:href="http://docs.openstack.org/developer/horizon/topics/deployment.html"
|
xlink:href="http://docs.openstack.org/developer/horizon/topics/deployment.html"
|
||||||
>deployment topics in the developer
|
>deployment topics in the developer documentation</link>.</para>
|
||||||
documentation</link>.</para>
|
|
||||||
<procedure>
|
<procedure>
|
||||||
<step>
|
<step>
|
||||||
<para>Install the dashboard on the node that can contact
|
<para>Install the dashboard on the node that can contact the Identity service as
|
||||||
the Identity Service as root:</para>
|
root:</para>
|
||||||
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install apache2 memcached libapache2-mod-wsgi openstack-dashboard</userinput></screen>
|
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install apache2 memcached libapache2-mod-wsgi openstack-dashboard</userinput></screen>
|
||||||
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install memcached python-memcached mod_wsgi openstack-dashboard</userinput></screen>
|
<screen os="rhel;centos;fedora"><prompt>#</prompt> <userinput>yum install memcached python-memcached mod_wsgi openstack-dashboard</userinput></screen>
|
||||||
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install memcached python-python-memcached apache2-mod_wsgi openstack-dashboard openstack-dashboard-test</userinput></screen>
|
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install memcached python-python-memcached apache2-mod_wsgi openstack-dashboard openstack-dashboard-test</userinput></screen>
|
||||||
<note os="ubuntu">
|
<note os="ubuntu">
|
||||||
<title>Note for Ubuntu users</title>
|
<title>Note for Ubuntu users</title>
|
||||||
|
<para>The <package>openstack-dashboard-ubuntu-theme</package> package prevents
|
||||||
<para>Remove the
|
translations, several menus, and the network map from rendering correctly.
|
||||||
<literal>openstack-dashboard-ubuntu-theme</literal>
|
Remove this package:</para>
|
||||||
package. This theme prevents translations, several
|
|
||||||
menus as well as the network map from rendering
|
|
||||||
correctly:
|
|
||||||
<screen><prompt>#</prompt> <userinput>apt-get remove --purge openstack-dashboard-ubuntu-theme</userinput></screen>
|
<screen><prompt>#</prompt> <userinput>apt-get remove --purge openstack-dashboard-ubuntu-theme</userinput></screen>
|
||||||
</para>
|
|
||||||
</note>
|
</note>
|
||||||
<note os="debian">
|
<note os="debian">
|
||||||
<title>Note for Debian users</title>
|
<title>Note for Debian users</title>
|
||||||
<para>To install the Apache package:</para>
|
<para>To install the Apache package:</para>
|
||||||
<screen><prompt>#</prompt> <userinput>apt-get install openstack-dashboard-apache</userinput></screen>
|
<screen><prompt>#</prompt> <userinput>apt-get install openstack-dashboard-apache</userinput></screen>
|
||||||
<para>This command installs and configures Apache
|
<para>This command installs and configures Apache correctly, provided that the user
|
||||||
correctly, provided that the user asks for it
|
asks for it during the <package>debconf</package> prompts. The default SSL
|
||||||
during the <package>debconf</package> prompts. The
|
certificate is self-signed, and it is probably wise to have it signed by a root
|
||||||
default SSL certificate is self-signed, and it is
|
|
||||||
probably wise to have it signed by a root
|
|
||||||
Certificate Authority (CA).</para>
|
Certificate Authority (CA).</para>
|
||||||
</note>
|
</note>
|
||||||
</step>
|
</step>
|
||||||
<step>
|
<step>
|
||||||
<para>Modify the value of
|
<para>Modify the value of <literal>CACHES['default']['LOCATION']</literal> in <filename
|
||||||
<literal>CACHES['default']['LOCATION']</literal>
|
os="ubuntu;debian"
|
||||||
in <filename os="ubuntu;debian"
|
|
||||||
>/etc/openstack-dashboard/local_settings.py</filename><filename
|
>/etc/openstack-dashboard/local_settings.py</filename><filename
|
||||||
os="centos;fedora;rhel"
|
os="centos;fedora;rhel"
|
||||||
>/etc/openstack-dashboard/local_settings</filename><filename
|
>/etc/openstack-dashboard/local_settings</filename><filename os="opensuse;sles"
|
||||||
os="opensuse;sles"
|
|
||||||
>/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py</filename>
|
>/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py</filename>
|
||||||
to match the ones set in <filename os="ubuntu;debian"
|
to match the ones set in <filename os="ubuntu;debian"
|
||||||
>/etc/memcached.conf</filename><filename
|
>/etc/memcached.conf</filename><filename os="centos;fedora;rhel;opensuse;sles"
|
||||||
os="centos;fedora;rhel;opensuse;sles"
|
|
||||||
>/etc/sysconfig/memcached</filename>.</para>
|
>/etc/sysconfig/memcached</filename>.</para>
|
||||||
<para>Open <filename os="ubuntu;debian"
|
<para>Open <filename os="ubuntu;debian"
|
||||||
>/etc/openstack-dashboard/local_settings.py</filename>
|
>/etc/openstack-dashboard/local_settings.py</filename>
|
||||||
<filename os="centos;fedora;rhel"
|
<filename os="centos;fedora;rhel">/etc/openstack-dashboard/local_settings</filename>
|
||||||
>/etc/openstack-dashboard/local_settings</filename>
|
|
||||||
and look for this line:</para>
|
and look for this line:</para>
|
||||||
<programlisting language="python" linenumbering="unnumbered"><?db-font-size 75%?>CACHES = {
|
<programlisting language="python" linenumbering="unnumbered"><?db-font-size 75%?>CACHES = \
|
||||||
'default': {
|
{'default': {'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
|
||||||
'BACKEND' : 'django.core.cache.backends.memcached.MemcachedCache',
|
'LOCATION': '127.0.0.1:11211'}}</programlisting>
|
||||||
'LOCATION' : '127.0.0.1:11211'
|
|
||||||
}
|
|
||||||
}</programlisting>
|
|
||||||
<note>
|
<note>
|
||||||
<title>Notes</title>
|
<title>Notes</title>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>The address and port must match the ones
|
<para>The address and port must match the ones set in <filename
|
||||||
set in <filename os="ubuntu;debian"
|
os="ubuntu;debian">/etc/memcached.conf</filename><filename
|
||||||
>/etc/memcached.conf</filename><filename
|
|
||||||
os="centos;fedora;rhel;opensuse;sles"
|
os="centos;fedora;rhel;opensuse;sles"
|
||||||
>/etc/sysconfig/memcached</filename>.</para>
|
>/etc/sysconfig/memcached</filename>.</para>
|
||||||
<para>If you change the memcached settings,
|
<para>If you change the memcached settings, you must restart the Apache web
|
||||||
you must restart the Apache web server for
|
server for the changes to take effect.</para>
|
||||||
the changes to take effect.</para>
|
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>You can use options other than memcached
|
<para>You can use options other than memcached option for session storage.
|
||||||
option for session storage. Set the
|
Set the session back-end through the
|
||||||
session back-end through the
|
<parameter>SESSION_ENGINE</parameter> option.</para>
|
||||||
<parameter>SESSION_ENGINE</parameter>
|
|
||||||
option.</para>
|
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>To change the timezone, use the
|
<para>To change the timezone, use the dashboard or edit the <filename
|
||||||
dashboard or edit the <filename
|
|
||||||
os="centos;fedora;rhel"
|
os="centos;fedora;rhel"
|
||||||
>/etc/openstack-dashboard/local_settings</filename><filename
|
>/etc/openstack-dashboard/local_settings</filename><filename
|
||||||
os="ubuntu;debian"
|
os="ubuntu;debian"
|
||||||
@ -103,64 +81,64 @@
|
|||||||
os="opensuse;sles"
|
os="opensuse;sles"
|
||||||
>/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py</filename>
|
>/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py</filename>
|
||||||
file.</para>
|
file.</para>
|
||||||
<para>Change the following parameter:
|
<para>Change the following parameter: <code>TIME_ZONE = "UTC"</code></para>
|
||||||
<code>TIME_ZONE = "UTC"</code></para>
|
|
||||||
</listitem>
|
</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</note>
|
</note>
|
||||||
</step>
|
</step>
|
||||||
<step>
|
<step>
|
||||||
<para>Update the <literal>ALLOWED_HOSTS</literal> in
|
<para>Update the <literal>ALLOWED_HOSTS</literal> in
|
||||||
<filename>local_settings.py</filename> to include
|
<filename>local_settings.py</filename> to include the addresses from which you
|
||||||
the addresses you wish to access the dashboard
|
want to access the dashboard.</para>
|
||||||
from.</para>
|
|
||||||
<para>Edit <filename os="centos;fedora;rhel"
|
<para>Edit <filename os="centos;fedora;rhel"
|
||||||
>/etc/openstack-dashboard/local_settings</filename><filename
|
>/etc/openstack-dashboard/local_settings</filename><filename os="ubuntu;debian"
|
||||||
os="ubuntu;debian"
|
|
||||||
>/etc/openstack-dashboard/local_settings.py</filename><filename
|
>/etc/openstack-dashboard/local_settings.py</filename><filename
|
||||||
os="opensuse;sles"
|
os="opensuse;sles"
|
||||||
>/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py</filename>:</para>
|
>/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py</filename>:</para>
|
||||||
<programlisting language="python" linenumbering="unnumbered"><?db-font-size 75%?>ALLOWED_HOSTS = ['localhost', 'my-desktop']
|
<programlisting language="python" linenumbering="unnumbered"><?db-font-size 75%?>ALLOWED_HOSTS = ['localhost', 'my-desktop']</programlisting>
|
||||||
</programlisting>
|
|
||||||
</step>
|
</step>
|
||||||
<step>
|
<step>
|
||||||
<para>This guide assumes that you are running the
|
<para>This guide assumes that you are running the dashboard on the controller node. You
|
||||||
Dashboard on the controller node. You can easily run
|
can easily run the dashboard on a separate server by changing the appropriate
|
||||||
the dashboard on a separate server, by changing the
|
settings in <filename>local_settings.py</filename>.</para>
|
||||||
appropriate settings in
|
|
||||||
<filename>local_settings.py</filename>.</para>
|
|
||||||
<para>Edit <filename os="centos;fedora;rhel"
|
<para>Edit <filename os="centos;fedora;rhel"
|
||||||
>/etc/openstack-dashboard/local_settings</filename><filename
|
>/etc/openstack-dashboard/local_settings</filename><filename os="ubuntu;debian"
|
||||||
os="ubuntu;debian"
|
|
||||||
>/etc/openstack-dashboard/local_settings.py</filename><filename
|
>/etc/openstack-dashboard/local_settings.py</filename><filename
|
||||||
os="opensuse;sles"
|
os="opensuse;sles"
|
||||||
>/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py</filename>
|
>/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py</filename>
|
||||||
and change <literal>OPENSTACK_HOST</literal> to the
|
and change <literal>OPENSTACK_HOST</literal> to the host name of your Identity
|
||||||
hostname of your Identity Service:</para>
|
service:</para>
|
||||||
<programlisting language="python" linenumbering="unnumbered"><?db-font-size 75%?>OPENSTACK_HOST = "controller"
|
<programlisting language="python" linenumbering="unnumbered"><?db-font-size 75%?>OPENSTACK_HOST = "controller"</programlisting>
|
||||||
</programlisting>
|
|
||||||
</step>
|
</step>
|
||||||
<step os="opensuse;sles">
|
<step os="opensuse;sles">
|
||||||
<para>Setup Apache configuration:
|
<para>Configure Apache:</para>
|
||||||
<screen><prompt>#</prompt> <userinput>cp /etc/apache2/conf.d/openstack-dashboard.conf.sample \
|
<screen><prompt>#</prompt> <userinput>cp /etc/apache2/conf.d/openstack-dashboard.conf.sample \
|
||||||
/etc/apache2/conf.d/openstack-dashboard.conf</userinput>
|
/etc/apache2/conf.d/openstack-dashboard.conf</userinput>
|
||||||
<prompt>#</prompt> <userinput>a2enmod rewrite;a2enmod ssl;a2enmod wsgi</userinput></screen>
|
<prompt>#</prompt> <userinput>a2enmod rewrite;a2enmod ssl;a2enmod wsgi</userinput></screen>
|
||||||
</para>
|
|
||||||
</step>
|
</step>
|
||||||
<step os="opensuse;sles">
|
<step os="opensuse;sles">
|
||||||
<para>By default, the
|
<para>By default, the <package>openstack-dashboard</package> package enables a database
|
||||||
<systemitem>openstack-dashboard</systemitem>
|
as a session store.</para>
|
||||||
package enables a database as session store. Before
|
<para>Before you continue, you can either:</para>
|
||||||
you continue, either change the session store set up
|
<itemizedlist>
|
||||||
as described in <xref linkend="dashboard-sessions"/>
|
<listitem>
|
||||||
or finish the setup of the database session store as
|
<para>Change the session store. See <link
|
||||||
explained in <xref
|
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/dashboard-sessions.html"
|
||||||
linkend="dashboard-session-database"/>.</para>
|
><citetitle pubwork="chapter">Set up session
|
||||||
|
storage</citetitle></link> in the <citetitle>Cloud Administrator
|
||||||
|
Guide</citetitle>.</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>Complete the database session store set up. See <link
|
||||||
|
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/dashboard-session-database.html">
|
||||||
|
<citetitle pubwork="chapter">Initialize and configure the
|
||||||
|
database</citetitle></link>.</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
</step>
|
</step>
|
||||||
<step os="centos;fedora;rhel">
|
<step os="centos;fedora;rhel">
|
||||||
<para>Ensure that the SELinux policy of the system is
|
<para>Ensure that the SELinux policy of the system is configured to allow network
|
||||||
configured to allow network connections to the HTTP
|
connections to the HTTP server:</para>
|
||||||
server.</para>
|
|
||||||
<screen><prompt>#</prompt> <userinput>setsebool -P httpd_can_network_connect on</userinput></screen>
|
<screen><prompt>#</prompt> <userinput>setsebool -P httpd_can_network_connect on</userinput></screen>
|
||||||
</step>
|
</step>
|
||||||
<step>
|
<step>
|
||||||
@ -180,12 +158,10 @@
|
|||||||
<para>You can now access the dashboard at <uri os="ubuntu"
|
<para>You can now access the dashboard at <uri os="ubuntu"
|
||||||
>http://controller/horizon</uri>
|
>http://controller/horizon</uri>
|
||||||
<uri os="debian">https://controller/</uri>
|
<uri os="debian">https://controller/</uri>
|
||||||
<uri os="centos;fedora;rhel"
|
<uri os="centos;fedora;rhel">http://controller/dashboard</uri>
|
||||||
>http://controller/dashboard</uri>
|
<uri os="opensuse;sles">http://controller</uri>.</para>
|
||||||
<uri os="opensuse;sles"
|
<para>Log in with credentials for any user that you created with OpenStack
|
||||||
>http://controller</uri>.</para>
|
Identity.</para>
|
||||||
<para>Login with credentials for any user that you created
|
|
||||||
with the OpenStack Identity Service.</para>
|
|
||||||
</step>
|
</step>
|
||||||
</procedure>
|
</procedure>
|
||||||
</section>
|
</section>
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user