openstack/openstack-manuals
Code Issues Proposed changes

[install] use .. code-block:: instead of ::

Browse Source 
Change-Id: I2a948b37d9855c8eaee5b5e4f484101b91483d75
Implements: blueprint installguide-liberty
This commit is contained in:
Christian Berendt
2015-10-09 10:35:09 +02:00
parent e708842d7b
commit 42c357c4c6
5 changed files with 94 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/install-guide/source/ceilometer-controller-install.rst
View File

@@ -36,7 +36,7 @@ create a MongoDB database, service credentials, and API endpoint.
You should verify the fingerprint of the imported GPG key before You should verify the fingerprint of the imported GPG key before
using it. using it.
:: .. code-block:: console
Key Name: server:database OBS Project <server:database@build.opensuse.org> Key Name: server:database OBS Project <server:database@build.opensuse.org>
Key Fingerprint: 116EB86331583E47E63CDF4D562111AC05905EA8 Key Fingerprint: 116EB86331583E47E63CDF4D562111AC05905EA8

4
doc/install-guide/source/cinder-storage-node.rst
View File

@@ -133,7 +133,9 @@ environment. For more information, see :ref:`environment`.
``/etc/lvm/lvm.conf`` file and complete the following actions: ``/etc/lvm/lvm.conf`` file and complete the following actions:
* In the ``devices`` section, add a filter that accepts the * In the ``devices`` section, add a filter that accepts the
``/dev/sdb`` device and rejects all other devices:: ``/dev/sdb`` device and rejects all other devices:
.. code-block:: ini
devices { devices {
... ...

112
doc/install-guide/source/dashboard-install.rst
View File

@@ -22,29 +22,37 @@ To install the dashboard components
.. only:: obs .. only:: obs
* Install the packages:: * Install the packages:
# zypper install openstack-dashboard apache2-mod_wsgi \ .. code-block:: console
memcached python-python-memcached
# zypper install openstack-dashboard apache2-mod_wsgi \
memcached python-python-memcached
.. only:: rdo .. only:: rdo
* Install the packages:: * Install the packages:
# yum install openstack-dashboard httpd mod_wsgi \ .. code-block:: console
memcached python-memcached
# yum install openstack-dashboard httpd mod_wsgi \
memcached python-memcached
.. only:: ubuntu .. only:: ubuntu
* Install the packages:: * Install the packages:
# apt-get install openstack-dashboard .. code-block:: console
# apt-get install openstack-dashboard
.. only:: debian .. only:: debian
* Install the packages:: * Install the packages:
# apt-get install openstack-dashboard-apache .. code-block:: console
# apt-get install openstack-dashboard-apache
* Respond to prompts for web server configuration. * Respond to prompts for web server configuration.
@@ -68,11 +76,13 @@ To configure the dashboard
.. only:: obs .. only:: obs
* Configure the web server:: * Configure the web server:
# cp /etc/apache2/conf.d/openstack-dashboard.conf.sample \ .. code-block:: console
/etc/apache2/conf.d/openstack-dashboard.conf
# a2enmod rewrite;a2enmod ssl;a2enmod wsgi # cp /etc/apache2/conf.d/openstack-dashboard.conf.sample \
/etc/apache2/conf.d/openstack-dashboard.conf
# a2enmod rewrite;a2enmod ssl;a2enmod wsgi
.. only:: obs .. only:: obs
@@ -87,22 +97,28 @@ To configure the dashboard
file and complete the following actions: file and complete the following actions:
* Configure the dashboard to use OpenStack services on the * Configure the dashboard to use OpenStack services on the
``controller`` node:: ``controller`` node:
OPENSTACK_HOST = "controller" .. code-block:: ini
* Allow all hosts to access the dashboard:: OPENSTACK_HOST = "controller"
ALLOWED_HOSTS = '*' * Allow all hosts to access the dashboard:
* Configure the ``memcached`` session storage service:: .. code-block:: ini
CACHES = { ALLOWED_HOSTS = '*'
'default': {
'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache', * Configure the ``memcached`` session storage service:
'LOCATION': '127.0.0.1:11211',
} .. code-block:: ini
}
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
'LOCATION': '127.0.0.1:11211',
}
}
.. note:: .. note::
@@ -117,13 +133,17 @@ To configure the dashboard
to use ``memcached`` for session storage. to use ``memcached`` for session storage.
* Configure ``user`` as the default role for * Configure ``user`` as the default role for
users that you create via the dashboard:: users that you create via the dashboard:
OPENSTACK_KEYSTONE_DEFAULT_ROLE = "user" .. code-block:: ini
* Optionally, configure the time zone:: OPENSTACK_KEYSTONE_DEFAULT_ROLE = "user"
TIME_ZONE = "TIME_ZONE" * Optionally, configure the time zone:
.. code-block:: ini
TIME_ZONE = "TIME_ZONE"
Replace ``TIME_ZONE`` with an appropriate time zone identifier. Replace ``TIME_ZONE`` with an appropriate time zone identifier.
For more information, see the `list of time zones For more information, see the `list of time zones
@@ -135,33 +155,41 @@ To finalize installation
.. only:: rdo .. only:: rdo
On RHEL and CentOS, configure SELinux to permit the web server On RHEL and CentOS, configure SELinux to permit the web server
to connect to OpenStack services:: to connect to OpenStack services:
# setsebool -P httpd_can_network_connect on .. code-block:: console
# setsebool -P httpd_can_network_connect on
.. only:: rdo .. only:: rdo
Due to a packaging bug, the dashboard CSS fails to load properly. Due to a packaging bug, the dashboard CSS fails to load properly.
Run the following command to resolve this issue:: Run the following command to resolve this issue:
# chown -R apache:apache /usr/share/openstack-dashboard/static .. code-block:: console
# chown -R apache:apache /usr/share/openstack-dashboard/static
For more information, see the `bug report For more information, see the `bug report
<https://bugzilla.redhat.com/show_bug.cgi?id=1150678>`__. <https://bugzilla.redhat.com/show_bug.cgi?id=1150678>`__.
.. only:: ubuntu .. only:: ubuntu
Reload the web server configuration:: Reload the web server configuration:
# service apache2 reload .. code-block:: console
# service apache2 reload
.. only:: obs .. only:: obs
Start the web server and session storage service and configure Start the web server and session storage service and configure
them to start when the system boots:: them to start when the system boots:
# systemctl enable apache2.service memcached.service .. code-block:: console
# systemctl start apache2.service memcached.service
# systemctl enable apache2.service memcached.service
# systemctl start apache2.service memcached.service
.. note:: .. note::
@@ -170,10 +198,12 @@ To finalize installation
.. only:: rdo .. only:: rdo
Start the web server and session storage service and configure Start the web server and session storage service and configure
them to start when the system boots:: them to start when the system boots:
# systemctl enable httpd.service memcached.service .. code-block:: console
# systemctl start httpd.service memcached.service
# systemctl enable httpd.service memcached.service
# systemctl start httpd.service memcached.service
.. note:: .. note::

16
doc/install-guide/source/environment-dependencies.rst
View File

@@ -102,13 +102,13 @@ these procedures on all nodes.
The packages are signed by GPG key 893A90DAD85F9316. You should The packages are signed by GPG key 893A90DAD85F9316. You should
verify the fingerprint of the imported GPG key before using it. verify the fingerprint of the imported GPG key before using it.
:: .. code-block:: console
Key ID: 893A90DAD85F9316 Key ID: 893A90DAD85F9316
Key Name: Cloud:OpenStack OBS Project <Cloud:OpenStack@build.opensuse.org> Key Name: Cloud:OpenStack OBS Project <Cloud:OpenStack@build.opensuse.org>
Key Fingerprint: 35B34E18ABC1076D66D5A86B893A90DAD85F9316 Key Fingerprint: 35B34E18ABC1076D66D5A86B893A90DAD85F9316
Key Created: Tue Oct 8 13:34:21 2013 Key Created: Tue Oct 8 13:34:21 2013
Key Expires: Thu Dec 17 13:34:21 2015 Key Expires: Thu Dec 17 13:34:21 2015
.. only:: debian .. only:: debian
@@ -172,9 +172,9 @@ Finalize the installation
* Upgrade the packages on your system: * Upgrade the packages on your system:
:: .. code-block:: console
$ zypper refresh && zypper dist-upgrade # zypper refresh && zypper dist-upgrade
.. note:: .. note::

18
doc/install-guide/source/heat-install.rst
View File

@@ -22,16 +22,20 @@ Orchestration module, code-named heat, on the controller node.
$ mysql -u root -p $ mysql -u root -p
* Create the ``heat`` database:: * Create the ``heat`` database:
CREATE DATABASE heat; .. code-block:: console
* Grant proper access to the ``heat`` database:: CREATE DATABASE heat;
GRANT ALL PRIVILEGES ON heat.* TO 'heat'@'localhost' \ * Grant proper access to the ``heat`` database:
IDENTIFIED BY 'HEAT_DBPASS';
GRANT ALL PRIVILEGES ON heat.* TO 'heat'@'%' \ .. code-block:: console
IDENTIFIED BY 'HEAT_DBPASS';
GRANT ALL PRIVILEGES ON heat.* TO 'heat'@'localhost' \
IDENTIFIED BY 'HEAT_DBPASS';
GRANT ALL PRIVILEGES ON heat.* TO 'heat'@'%' \
IDENTIFIED BY 'HEAT_DBPASS';
Replace ``HEAT_DBPASS`` with a suitable password. Replace ``HEAT_DBPASS`` with a suitable password.