openstack/openstack-manuals
Code Issues Proposed changes

Merge "[install] remove the :file: RST directive"

Browse Source
This commit is contained in:
Jenkins
2015-10-08 22:56:30 +00:00
committed by Gerrit Code Review
parent f573698d5a effb91b8ae
commit 08e47792b8
17 changed files with 47 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -9,7 +9,7 @@ Perform these steps on the controller and storage nodes.
To configure prerequisites
~~~~~~~~~~~~~~~~~~~~~~~~~~
Edit the :file:`/etc/cinder/cinder.conf` file and complete the
Edit the ``/etc/cinder/cinder.conf`` file and complete the
following actions:
1. In the ``[DEFAULT]`` section, configure notifications:

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

@@ -67,7 +67,7 @@ create a MongoDB database, service credentials, and API endpoint.
.. only:: obs
2. Edit the :file:`/etc/mongodb.conf` file and complete the following
2. Edit the ``/etc/mongodb.conf`` file and complete the following
actions:
a. Configure the ``bind_ip`` key to use the management interface
@@ -78,7 +78,7 @@ create a MongoDB database, service credentials, and API endpoint.
bind_ip = 10.0.0.11
b. By default, MongoDB creates several 1 GB journal files
in the :file:`/var/lib/mongodb/journal` directory.
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
@@ -102,7 +102,7 @@ create a MongoDB database, service credentials, and API endpoint.
.. The use of mongod, and not mongodb, in the below screen is intentional.
2. Edit the :file:`/etc/mongod.conf` file and complete the following
2. Edit the ``/etc/mongod.conf`` file and complete the following
actions:
a. Configure the ``bind_ip`` key to use the management interface
@@ -113,7 +113,7 @@ create a MongoDB database, service credentials, and API endpoint.
bind_ip = 10.0.0.11
b. By default, MongoDB creates several 1 GB journal files
in the :file:`/var/lib/mongodb/journal` directory.
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
@@ -135,7 +135,7 @@ create a MongoDB database, service credentials, and API endpoint.
.. only:: ubuntu
2. Edit the :file:`/etc/mongodb.conf` file and complete the following
2. Edit the ``/etc/mongodb.conf`` file and complete the following
actions:
a. Configure the ``bind_ip`` key to use the management interface
@@ -146,7 +146,7 @@ create a MongoDB database, service credentials, and API endpoint.
bind_ip = 10.0.0.11
b. By default, MongoDB creates several 1 GB journal files
in the :file:`/var/lib/mongodb/journal` directory.
in the ``/var/lib/mongodb/journal`` directory.
If you want to reduce the size of each journal file to
128 MB and limit total journal space consumption to 512 MB,
assert the ``smallfiles`` key:
@@ -363,7 +363,7 @@ To install and configure the Telemetry module components
$ openssl rand -hex 10
3. Edit the :file:`/etc/ceilometer/ceilometer.conf` file and complete
3. Edit the ``/etc/ceilometer/ceilometer.conf`` file and complete
the following actions:
a. In the ``[database]`` section, configure database access:

4
doc/install-guide/source/ceilometer-glance.rst
View File

@@ -6,8 +6,8 @@ To retrieve image-oriented events and samples, configure
the Image service to send notifications to the message bus.
Perform these steps on the controller node.
Edit the :file:`/etc/glance/glance-api.conf` and
:file:`/etc/glance/glance-registry.conf` files and
Edit the ``/etc/glance/glance-api.conf`` and
``/etc/glance/glance-registry.conf`` files and
complete the following actions:
1. In the ``[DEFAULT]`` section, configure notifications

6
doc/install-guide/source/ceilometer-nova.rst
View File

@@ -32,7 +32,7 @@ To install and configure the agent
# apt-get install ceilometer-agent-compute
2. Edit the :file:`/etc/ceilometer/ceilometer.conf` file and
2. Edit the ``/etc/ceilometer/ceilometer.conf`` file and
complete the following actions:
a. In the ``[publisher]`` section, configure the telemetry secret:
@@ -117,7 +117,7 @@ To configure notifications
Configure the Compute service to send notifications to the message bus.
Edit the :file:`/etc/nova/nova.conf` file and configure
Edit the ``/etc/nova/nova.conf`` file and configure
notifications in the ``[DEFAULT]`` section:
.. code-block:: ini
@@ -150,7 +150,7 @@ example message format.
Notification messages are placed on the OpenStack messaging system,
which recruits AMQP to send information when an event triggers alerts.
The :file:`nova.conf` file uses the nova_notification driver by defualt.
The ``nova.conf`` file uses the nova_notification driver by defualt.
.. warning::

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

@@ -50,7 +50,7 @@ To configure notifications
Perform these steps on the controller and any other nodes that
run the Object Storage proxy service.
1. Edit the :file:`/etc/swift/proxy-server.conf` file
1. Edit the ``/etc/swift/proxy-server.conf`` file
and complete the following actions:
a. In the ``[filter:keystoneauth]`` section, add the

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

@@ -64,7 +64,7 @@ This section describes how to verify operation of the Telemetry module.
| 60 | 2015-04-21T12:21:45 | 2015-04-21T12:22:45 | 13200896.0 | 13200896.0 | 13200896.0 | 13200896.0 | 1 | 0.0 | 2015-04-21T12:22:12.983000 | 2015-04-21T12:22:12.983000 |
+--------+---------------------+---------------------+------------+------------+------------+------------+-------+----------+----------------------------+----------------------------+
#. Remove the previously downloaded image file :file:`/tmp/cirros.img`:
#. Remove the previously downloaded image file ``/tmp/cirros.img``:
.. code-block:: console

6
doc/install-guide/source/cinder-controller-node.rst
View File

@@ -192,8 +192,8 @@ To install and configure Block Storage controller components
.. Workaround for https://bugzilla.redhat.com/show_bug.cgi?id=1212900.
Copy the :file:`/usr/share/cinder/cinder-dist.conf` file
to :file:`/etc/cinder/cinder.conf`.
Copy the ``/usr/share/cinder/cinder-dist.conf`` file
to ``/etc/cinder/cinder.conf``.
.. code-block:: console
@@ -202,7 +202,7 @@ To install and configure Block Storage controller components
Edit the :file:`/etc/cinder/cinder.conf` file and complete the
Edit the ``/etc/cinder/cinder.conf`` file and complete the
following actions:
a. In the ``[database]`` section, configure database access:

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

@@ -5,8 +5,8 @@ Install and configure a storage node
This section describes how to install and configure storage nodes
for the Block Storage service. For simplicity, this configuration
references one storage node with an empty local block storage device
:file:`/dev/sdb` that contains a suitable partition table with
one partition :file:`/dev/sdb1` occupying the entire device.
``/dev/sdb`` that contains a suitable partition table with
one partition ``/dev/sdb1`` occupying the entire device.
The service provisions logical volumes on this device using the
:term:`LVM <Logical Volume Manager (LVM)>` driver and provides them
to instances via :term:`iSCSI` transport. You can follow these
@@ -100,7 +100,7 @@ environment. For more information, see :ref:`environment`.
Some distributions include LVM by default.
7. Create the LVM physical volume :file:`/dev/sdb1`:
7. Create the LVM physical volume ``/dev/sdb1``:
.. code-block:: console
@@ -124,16 +124,16 @@ environment. For more information, see :ref:`environment`.
9. Only instances can access Block Storage volumes. However, the
underlying operating system manages the devices associated with
the volumes. By default, the LVM volume scanning tool scans the
:file:`/dev` directory for block storage devices that
``/dev`` directory for block storage devices that
contain volumes. If projects use LVM on their volumes, the scanning
tool detects these volumes and attempts to cache them which can cause
a variety of problems with both the underlying operating system
and project volumes. You must reconfigure LVM to scan only the devices
that contain the ``cinder-volume`` volume group. Edit the
:file:`/etc/lvm/lvm.conf` file and complete the following actions:
``/etc/lvm/lvm.conf`` file and complete the following actions:
a. In the ``devices`` section, add a filter that accepts the
:file:`/dev/sdb` device and rejects all other devices::
``/dev/sdb`` device and rejects all other devices::
devices {
...
@@ -149,7 +149,7 @@ environment. For more information, see :ref:`environment`.
If your storage nodes use LVM on the operating system disk, you
must also add the associated device to the filter. For example,
if the :file:`/dev/sda` device contains the operating system:
if the ``/dev/sda`` device contains the operating system:
.. code-block:: ini
@@ -157,8 +157,8 @@ environment. For more information, see :ref:`environment`.
Similarly, if your compute nodes use LVM on the operating
system disk, you must also modify the filter in the
:file:`/etc/lvm/lvm.conf` file on those nodes to include only
the operating system disk. For example, if the :file:`/dev/sda`
``/etc/lvm/lvm.conf`` file on those nodes to include only
the operating system disk. For example, if the ``/dev/sda``
device contains the operating system:
.. code-block:: ini
@@ -196,7 +196,7 @@ Install and configure Block Storage volume components
# apt-get install cinder-volume python-mysqldb
2. Edit the :file:`/etc/cinder/cinder.conf` file
2. Edit the ``/etc/cinder/cinder.conf`` file
and complete the following actions:
a. In the ``[database]`` section, configure database access:

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

@@ -77,13 +77,13 @@ To configure the dashboard
.. only:: obs
* Edit the
:file:`/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py`
``/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py``
file and complete the following actions:
.. only:: rdo or ubuntu or debian
* Edit the
:file:`/etc/openstack-dashboard/local_settings.py`
``/etc/openstack-dashboard/local_settings.py``
file and complete the following actions:
* Configure the dashboard to use OpenStack services on the

4
doc/install-guide/source/debconf/debconf-concepts.rst
View File

@@ -63,8 +63,8 @@ package in a non-interactive way, you have found a release-critical bug
in Debian. Report it to the Debian bug tracking system.
Generally, the ``-common`` packages install the configuration files. For
example, the ``glance-common`` package installs the :file:`glance-api.conf`
and :file:`glance-registry.conf` files. So, for the Image service, you must
example, the ``glance-common`` package installs the ``glance-api.conf``
and ``glance-registry.conf`` files. So, for the Image service, you must
re-configure the ``glance-common`` package. The same applies for
``cinder-common``, ``nova-common``, and ``heat-common`` packages.

2
doc/install-guide/source/debconf/debconf-rabbitmq.rst
View File

@@ -24,7 +24,7 @@ shows configuration with the ``ceilometer-common`` package:
These debconf screens appear in: ``ceilometer-common``, ``cinder-common``,
``glance-common``, ``heat-common``, ``neutron-common``, and ``nova-common``.
This will configure the below directives (example from :file:`nova.conf`):
This will configure the below directives (example from ``nova.conf``):
.. code-block:: ini

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

@@ -291,7 +291,7 @@ Install and configure the database server
2. Choose a suitable password for the database root account.
3. Create and edit the :file:`/etc/mysql/conf.d/mysqld_openstack.cnf` file
3. Create and edit the ``/etc/mysql/conf.d/mysqld_openstack.cnf`` file
and complete the following actions:
- In the ``[mysqld]`` section, set the
@@ -321,7 +321,7 @@ Install and configure the database server
.. only:: obs or rdo
2. Create and edit the :file:`/etc/my.cnf.d/mariadb_openstack.cnf` file
2. Create and edit the ``/etc/my.cnf.d/mariadb_openstack.cnf`` file
and complete the following actions:
- In the ``[mysqld]`` section, set the

6
doc/install-guide/source/environment-networking-compute.rst
View File

@@ -25,7 +25,7 @@ Configure network interfaces
.. only:: ubuntu or debian
a. Edit the :file:`/etc/network/interfaces` file to contain the following:
a. Edit the ``/etc/network/interfaces`` file to contain the following:
.. code-block:: ini
@@ -37,7 +37,7 @@ Configure network interfaces
.. only:: rdo
a. Edit the :file:`/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME` file
a. Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file
to contain the following:
Do not change the ``HWADDR`` and ``UUID`` keys.
@@ -51,7 +51,7 @@ Configure network interfaces
.. only:: obs
a. Edit the :file:`/etc/sysconfig/network/ifcfg-INTERFACE_NAME` file to
a. Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following:
.. code-block:: ini

6
doc/install-guide/source/environment-networking-controller.rst
View File

@@ -21,7 +21,7 @@ Configure network interfaces
.. only:: ubuntu or debian
a. Edit the :file:`/etc/network/interfaces` file to contain the following:
a. Edit the ``/etc/network/interfaces`` file to contain the following:
.. code-block:: ini
@@ -33,7 +33,7 @@ Configure network interfaces
.. only:: rdo
a. Edit the :file:`/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME` file
a. Edit the ``/etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME`` file
to contain the following:
Do not change the ``HWADDR`` and ``UUID`` keys.
@@ -47,7 +47,7 @@ Configure network interfaces
.. only:: obs
a. Edit the :file:`/etc/sysconfig/network/ifcfg-INTERFACE_NAME` file to
a. Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following:
.. code-block:: ini

2
doc/install-guide/source/glance.rst
View File

@@ -21,7 +21,7 @@ systems to object-storage systems like OpenStack Object Storage.
For simplicity, this guide describes configuring the Image service to
use the ``file`` back end, which uploads and stores in a
directory on the controller node hosting the Image service. By
default, this directory is :file:`/var/lib/glance/images/`.
default, this directory is ``/var/lib/glance/images/``.
Before you proceed, ensure that the controller node has at least
several gigabytes of space available in this directory.

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

@@ -287,15 +287,15 @@ To install and configure the Orchestration components
.. Workaround for https://bugzilla.redhat.com/show_bug.cgi?id=1213476.
Copy the :file:`/usr/share/heat/heat-dist.conf` file
to :file:`/etc/heat/heat.conf`.
Copy the ``/usr/share/heat/heat-dist.conf`` file
to ``/etc/heat/heat.conf``.
.. code-block:: console
# cp /usr/share/heat/heat-dist.conf /etc/heat/heat.conf
# chown -R heat:heat /etc/heat/heat.conf
Edit the :file:`/etc/heat/heat.conf` file and complete the following
Edit the ``/etc/heat/heat.conf`` file and complete the following
actions:
* In the ``[database]`` section, configure database access:
@@ -426,7 +426,7 @@ To install and configure the Orchestration components
:doc:`service endpoint registration <debconf/debconf-api-endpoints>`,
and :doc:`message broker credentials <debconf/debconf-rabbitmq>`.
3. Edit the :file:`/etc/heat/heat.conf` file and complete the following
3. Edit the ``/etc/heat/heat.conf`` file and complete the following
actions:
* In the ``[ec2authtoken]`` section, configure Identity service access:

2
doc/install-guide/source/heat-verify.rst
View File

@@ -17,7 +17,7 @@ module (heat).
in the `Heat developer documentation
<http://docs.openstack.org/developer/heat/index.html>`__.
Create a test template in the :file:`test-stack.yml`
Create a test template in the ``test-stack.yml``
file with the following content:
.. code-block:: yaml