diff --git a/doc/install-guide-rst/source/dashboard-install.rst b/doc/install-guide-rst/source/dashboard-install.rst index f381b9e056..a9959d5ee9 100644 --- a/doc/install-guide-rst/source/dashboard-install.rst +++ b/doc/install-guide-rst/source/dashboard-install.rst @@ -1,4 +1,164 @@ Install and configure ~~~~~~~~~~~~~~~~~~~~~ -.. TODO +This section describes how to install and configure the dashboard +on the controller node. + +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 +Memcached as described in keystone-install. + +.. TODO: add link to keystone-install after creation. + +To install the dashboard components +----------------------------------- + +.. only:: obs + + * Install the packages:: + + # zypper install openstack-dashboard apache2-mod_wsgi \ + memcached python-python-memcached + +.. only:: rdo + + * Install the packages:: + + # yum install openstack-dashboard httpd mod_wsgi \ + memcached python-memcached + +.. only:: ubuntu + + * Install the packages:: + + # apt-get install openstack-dashboard + +.. only:: ubuntu + + .. note:: + + Ubuntu installs the ``openstack-dashboard-ubuntu-theme`` + package as a dependency. Some users reported issues with + this theme in previous releases. If you encounter issues, + remove this package to restore the original OpenStack theme. + +To configure the dashboard +-------------------------- + +.. only:: obs + + * Configure the web server:: + + # cp /etc/apache2/conf.d/openstack-dashboard.conf.sample \ + /etc/apache2/conf.d/openstack-dashboard.conf + # a2enmod rewrite;a2enmod ssl;a2enmod wsgi + +.. only:: obs + + * Edit the + :file:`/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py` + file and complete the following actions: + +.. only:: rdo + + * Edit the + :file:`/etc/openstack-dashboard/local_settings.py` + file and complete the following actions: + +.. only:: ubuntu + + * Edit the :file:`/etc/openstack-dashboard/local_settings` + file and complete the following actions: + +* Configure the dashboard to use OpenStack services on the + ``controller`` node:: + + OPENSTACK_HOST = "controller" + +* Allow all hosts to access the dashboard:: + + ALLOWED_HOSTS = '*' + +* Configure the ``memcached`` session storage service:: + + CACHES = { + 'default': { + 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache', + 'LOCATION': '127.0.0.1:11211', + } + } + +.. note:: + + Comment out any other session storage configuration. + +.. only:: obs + + .. note:: + + By default, SLES and openSUSE use a SQL database for session + storage. For simplicity, we recommend changing the configuration + to use ``memcached`` for session storage. + +* Configure ``user`` as the default role for + users that you create via the dashboard:: + + OPENSTACK_KEYSTONE_DEFAULT_ROLE = "user" + +* Optionally, configure the time zone:: + + TIME_ZONE = "TIME_ZONE" + + Replace ``TIME_ZONE`` with an appropriate time zone identifier. + For more information, see the `list of time zones + `__. + +To finalize installation +------------------------ + +.. only:: rdo + + On RHEL and CentOS, configure SELinux to permit the web server + to connect to OpenStack services:: + + # setsebool -P httpd_can_network_connect on + +.. only:: rdo + + Due to a packaging bug, the dashboard CSS fails to load properly. + Run the following command to resolve this issue:: + + # chown -R apache:apache /usr/share/openstack-dashboard/static + + For more information, see the `bug report + `__. + +.. only:: ubuntu + + Reload the web server configuration:: + + # service apache2 reload + +.. only:: obs + + Start the web server and session storage service and configure + them to start when the system boots:: + + # systemctl enable apache2.service memcached.service + # systemctl start apache2.service memcached.service + +.. only:: rdo + + Start the web server and session storage service and configure + them to start when the system boots:: + + # systemctl enable httpd.service memcached.service + # systemctl start httpd.service memcached.service diff --git a/doc/install-guide-rst/source/dashboard-verify.rst b/doc/install-guide-rst/source/dashboard-verify.rst index 486fe83257..e1fa7dc9d0 100644 --- a/doc/install-guide-rst/source/dashboard-verify.rst +++ b/doc/install-guide-rst/source/dashboard-verify.rst @@ -1,4 +1,21 @@ Verify operation ~~~~~~~~~~~~~~~~ -.. TODO +This section describes how to verify operation of the dashboard. + +.. only:: obs + + Access the dashboard using a web browser: + ``http://controller``. + +.. only:: rdo + + Access the dashboard using a web browser: + ``http://controller/dashboard``. + +.. only:: ubuntu + + Access the dashboard using a web browser: + ``http://controller/horizon``. + +Authenticate using ``admin`` or ``demo`` user credentials.