openstack/horizon
Code Issues Proposed changes

Updated install.rst to follow doc conventions

Browse Source 
changed service and project names per doc conventions
when referring to the services, use Compute
Image Service and Identity instead of nova glance
and keystone
changed horizon to lowercase throughout doc
http://wiki.opensstack.org/wiki/Documentation/Conventions
Partial-bug: 1446253

Change-Id: I5f3d8a086b38860bb77e6e71e91714fd49f5e1c6
This commit is contained in:
Shilla Saebi 2015-04-15 15:29:11 -04:00
parent b81e9f63e6
commit 2ee182ecbc
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/source/topics/install.rst
View File

@ -2,7 +2,7 @@
Installing Horizon Installing Horizon
================== ==================
This page covers the basic installation of Horizon. This page covers the basic installation of horizon, the OpenStack dashboard.
.. _system-requirements-label: .. _system-requirements-label:
@ -13,22 +13,22 @@ System Requirements
* Django 1.6 (1.4 and 1.5 are supported too) * Django 1.6 (1.4 and 1.5 are supported too)
* Minimum required set of running OpenStack services are: * Minimum required set of running OpenStack services are:
* Nova * nova: OpenStack Compute
* Keystone * keystone: OpenStack Identity
* Glance * glance: OpenStack Image service
* Neutron (unless nova-network is used) * neutron: OpenStack Networking (unless nova-network is used)
* All other services are optional. * All other services are optional.
Horizon supports the following services in Juno release. Horizon supports the following services in the Juno release.
If Keystone endpoint for a service is configured, If the keystone endpoint for a service is configured,
Horizon detects it and enables its support automatically. horizon detects it and enables its support automatically.
* Swift * swift: OpenStack Object Storage
* Cinder * cinder: OpenStack Block Storage
* Heat * heat: Orchestration
* Ceilometer * ceilometer: Telemetry
* Trove * trove: Database service for OpenStack
* Sahara * sahara: Data processing service for OpenStack
Installation Installation
============ ============
@ -45,7 +45,7 @@ Installation
virtualenv named ``.venv``. After this step, you can remove virtualenv named ``.venv``. After this step, you can remove
``.venv`` directory safely. ``.venv`` directory safely.
2. Install Horizon python module into your system. Run the following 2. Install the horizon python module into your system. Run the following
in the top directory:: in the top directory::
$ sudo pip install . $ sudo pip install .
@ -60,7 +60,7 @@ Installation
For more details, please refer to :doc:`deployment` and :doc:`settings`. For more details, please refer to :doc:`deployment` and :doc:`settings`.
4. Optional: Django has a Compressor feature that performs many enhancements 4. Optional: Django has a compressor feature that performs many enhancements
for the delivery of static files, including standardization and for the delivery of static files, including standardization and
minification/uglification. This processing can be run either online or minification/uglification. This processing can be run either online or
offline (pre-processed). Letting the compression process occur at runtime offline (pre-processed). Letting the compression process occur at runtime
@ -80,7 +80,7 @@ Installation
$ sudo apt-get install apache2 libapache2-mod-wsgi $ sudo apt-get install apache2 libapache2-mod-wsgi
Then configure the web server to host OpenStack Dashboard via WSGI. Then configure the web server to host OpenStack dashboard via WSGI.
For apache2 web server, you may need to create For apache2 web server, you may need to create
``/etc/apache2/sites-available/horizon.conf``. ``/etc/apache2/sites-available/horizon.conf``.
The template in devstack is a good example of the file. The template in devstack is a good example of the file.
@ -95,6 +95,6 @@ Next Steps
========== ==========
* :doc:`deployment` covers some common questions, concerns and pitfalls you * :doc:`deployment` covers some common questions, concerns and pitfalls you
may encounter when deploying Horizon in a production environment. may encounter when deploying horizon in a production environment.
* :doc:`settings` lists the available settings for Horizon. * :doc:`settings` lists the available settings for horizon.
* :doc:`customizing` describes how to customizing Horizon as you want. * :doc:`customizing` describes how to customizing horizon as you want.