[common] remove the :file: RST directive

Change-Id: I9cdb018e45969c7380ac09e2cd976f1caf8cb15a
This commit is contained in:
Christian Berendt
2015-10-08 09:39:47 +02:00
committed by Christian Berendt
parent cd19c606f1
commit 4c92e1fbfd
6 changed files with 46 additions and 46 deletions

View File

@@ -258,5 +258,5 @@ What's next
~~~~~~~~~~~
Before you can run client commands, you must create and source the
:file:`PROJECT-openrc.sh` file to set environment variables. See
``PROJECT-openrc.sh`` file to set environment variables. See
:doc:`../common/cli_set_environment_variables_using_openstack_rc`.

View File

@@ -291,5 +291,5 @@ creation process.
later. Earlier versions of qemu result in an ``unknown option -s``
error message in the ``nova-compute.log`` file.
- Examine the :file:`/var/log/nova-api.log` and
:file:`/var/log/nova-compute.log` log files for error messages.
- Examine the ``/var/log/nova-api.log`` and
``/var/log/nova-compute.log`` log files for error messages.

View File

@@ -4,7 +4,7 @@ Set environment variables using the OpenStack RC file
To set the required environment variables for the OpenStack command-line
clients, you must create an environment file called an OpenStack rc
file, or :file:`openrc.sh` file. If your OpenStack installation provides
file, or ``openrc.sh`` file. If your OpenStack installation provides
it, you can download the file from the OpenStack dashboard as an
administrative user or any other user. This project-specific environment
file contains the credentials that all OpenStack services use.
@@ -28,34 +28,34 @@ to download the OpenStack RC file, on the :guilabel:`Project` tab, open
the :guilabel:`Compute` tab and click :guilabel:`Access & Security`.
On the :guilabel:`API Access` tab, click :guilabel:`Download OpenStack RC File`
and save the file. The filename will be of the form :file:`PROJECT-openrc.sh`
and save the file. The filename will be of the form ``PROJECT-openrc.sh``
where ``PROJECT`` is the name of the project for which you downloaded the
file.
Copy the :file:`PROJECT-openrc.sh` file to the computer from which you
Copy the ``PROJECT-openrc.sh`` file to the computer from which you
want to run OpenStack commands.
For example, copy the file to the computer from which you want to upload
an image with a ``glance`` client command.
On any shell from which you want to run OpenStack commands, source the
:file:`PROJECT-openrc.sh` file for the respective project.
``PROJECT-openrc.sh`` file for the respective project.
In the following example, the :file:`demo-openrc.sh` file is sourced for
In the following example, the ``demo-openrc.sh`` file is sourced for
the demo project::
$ source demo-openrc.sh
When you are prompted for an OpenStack password, enter the password for
the user who downloaded the :file:`PROJECT-openrc.sh` file.
the user who downloaded the ``PROJECT-openrc.sh`` file.
Create and source the OpenStack RC file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Alternatively, you can create the :file:`PROJECT-openrc.sh` file from
Alternatively, you can create the ``PROJECT-openrc.sh`` file from
scratch, if you cannot download the file from the dashboard.
In a text editor, create a file named :file:`PROJECT-openrc.sh` and add
In a text editor, create a file named ``PROJECT-openrc.sh`` and add
the following authentication information::
export OS_USERNAME=username
@@ -68,8 +68,8 @@ the following authentication information::
export OS_CACERT=/path/to/cacertFile
On any shell from which you want to run OpenStack commands, source the
:file:`PROJECT-openrc.sh` file for the respective project. In this
example, you source the :file:`admin-openrc.sh` file for the admin
``PROJECT-openrc.sh`` file for the respective project. In this
example, you source the ``admin-openrc.sh`` file for the admin
project::
$ source admin-openrc.sh
@@ -77,7 +77,7 @@ project::
.. note::
You are not prompted for the password with this method. The password
lives in clear text format in the :file:`PROJECT-openrc.sh` file.
lives in clear text format in the ``PROJECT-openrc.sh`` file.
Restrict the permissions on this file to avoid security problems.
You can also remove the ``OS_PASSWORD`` variable from the file, and
use the ``--password`` parameter with OpenStack client commands
@@ -98,7 +98,7 @@ When you run OpenStack client commands, you can override some
environment variable settings by using the options that are listed at
the end of the ``help`` output of the various client commands. For
example, you can override the ``OS_PASSWORD`` setting in the
:file:`PROJECT-openrc.sh` file by specifying a password on a
``PROJECT-openrc.sh`` file by specifying a password on a
:command:`openstack` command, as follows::
$ openstack --os-password PASSWORD service list

View File

@@ -20,8 +20,8 @@ and feels to suit your own needs.
# apt-get remove --auto-remove openstack-dashboard-ubuntu-theme
.. note::
This guide focuses on the :file:`local_settings.py` file, stored in
:file:`/openstack-dashboard/openstack_dashboard/local/`.
This guide focuses on the ``local_settings.py`` file, stored in
``/openstack-dashboard/openstack_dashboard/local/``.
This guide is adapted from `How To Custom Brand The OpenStack "Horizon"
Dashboard <http://www.prestonlee.com/2012/05/09/how-to-custom-brand-the-openstack-horizon-dashboard/>`__.
@@ -35,10 +35,10 @@ Logo and site colors
- Logged in banner: 216 x 35
#. Upload your new images to
:file:`/usr/share/openstack-dashboard/openstack_dashboard/static/dashboard/img/`.
``/usr/share/openstack-dashboard/openstack_dashboard/static/dashboard/img/``.
#. Create a CSS style sheet in
:file:`/usr/share/openstack-dashboard/openstack_dashboard/static/dashboard/scss/`.
``/usr/share/openstack-dashboard/openstack_dashboard/static/dashboard/scss/``.
#. Change the colors and image file names as appropriate, though the
relative directory paths should be the same. The following example file
@@ -83,7 +83,7 @@ Logo and site colors
/usr/share/openstack-dashboard/openstack_dashboard/templates/_stylesheets.html
#. Add a line to include your newly created style sheet. For example
:file:`custom.css`::
``custom.css``::
<link href='{{ STATIC_URL }}bootstrap/css/bootstrap.min.css' media='screen' rel='stylesheet' />
<link href='{{ STATIC_URL }}dashboard/css/{% choose_css %}' media='screen' rel='stylesheet' />
@@ -109,7 +109,7 @@ Logo and site colors
HTML title
~~~~~~~~~~
#. Set the HTML title, which appears at the top of the browser window, by
adding the following line to :file:`local_settings.py`::
adding the following line to ``local_settings.py``::
SITE_BRANDING = "Example, Inc. Cloud"
@@ -119,7 +119,7 @@ Logo link
~~~~~~~~~
#. The logo also acts as a hyperlink. The default behavior is to redirect
to ``horizon:user_home``. To change this, add the following attribute to
:file:`local_settings.py`::
``local_settings.py``::
SITE_BRANDING_LINK = "http://example.com"
@@ -129,7 +129,7 @@ Help URL
~~~~~~~~
#. By default the help URL points to http://docs.openstack.org. Change this
by editing the following attribute to the URL of your choice in
:file:`local_settings.py`::
``local_settings.py``::
'help_url': "http://openstack.mycompany.org"

View File

@@ -97,9 +97,9 @@ OpenStack Compute consists of the following areas and their components:
In Debian, a unique nova-consoleproxy package provides the
nova-novncproxy, nova-spicehtml5proxy, and nova-xvpvncproxy packages. To
select packages, edit the :file:`/etc/default/nova-consoleproxy` file or use
select packages, edit the ``/etc/default/nova-consoleproxy`` file or use
the debconf interface. You can also manually edit the
:file:`/etc/default/nova-consoleproxy` file, and stop and start the console
``/etc/default/nova-consoleproxy`` file, and stop and start the console
daemons.
nova-objectstore daemon

View File

@@ -21,10 +21,10 @@ Compute service logging
-----------------------
Compute stores a log file for each service in
:file:`/var/log/nova`. For example, :file:`nova-compute.log`
``/var/log/nova``. For example, ``nova-compute.log``
is the log for the ``nova-compute`` service. You can set the
following options to format log strings for the ``nova.log``
module in the :file:`nova.conf` file:
module in the ``nova.conf`` file:
* ``logging_context_format_string``
@@ -36,7 +36,7 @@ For information about what variables are available for the
formatter see http://docs.python.org/library/logging.html#formatter-objects.
You have two options for logging for OpenStack Compute based on
configuration settings. In :file:`nova.conf`, include the
configuration settings. In ``nova.conf``, include the
``logfile`` option to enable logging. Alternatively you can set
``use_syslog = 1`` so that the nova daemon logs to syslog.
@@ -58,7 +58,7 @@ resulting in the process ID 8675, you can then run::
# kill -USR1 8675
This command triggers the Guru Meditation report to be printed to
:file:`/var/log/nova/nova-api-err.log`.
``/var/log/nova/nova-api-err.log``.
The report has the following sections:
@@ -94,21 +94,21 @@ Missing credentials cause a ``403 forbidden`` error. To resolve
this issue, use one of these methods:
#. Manual method
Gets the :file:`novarc` file from the project ZIP file, saves existing
credentials in case of override, and manually sources the :file:`novarc`
Gets the ``novarc`` file from the project ZIP file, saves existing
credentials in case of override, and manually sources the ``novarc``
file.
#. Script method
Generates :file:`novarc` from the project ZIP file and sources it for you.
Generates ``novarc`` from the project ZIP file and sources it for you.
When you run ``nova-api`` the first time, it generates the certificate
authority information, including :file:`openssl.cnf`. If you
authority information, including ``openssl.cnf``. If you
start the CA services before this, you might not be
able to create your ZIP file. Restart the services.
When your CA information is available, create your ZIP file.
Also, check your HTTP proxy settings to see whether they cause problems with
:file:`novarc` creation.
``novarc`` creation.
**Instance errors**
@@ -122,26 +122,26 @@ with FlatManager network settings.
To troubleshoot other possible problems with an instance, such as
an instance that stays in a spawning state, check the directory for
the particular instance under :file:`/var/lib/nova/instances` on
the particular instance under ``/var/lib/nova/instances`` on
the ``nova-compute`` host and make sure that these files are present:
* :file:`libvirt.xml`
* :file:`disk`
* :file:`disk-raw`
* :file:`kernel`
* :file:`ramdisk`
* :file:`console.log`, after the instance starts.
* ``libvirt.xml``
* ``disk``
* ``disk-raw``
* ``kernel``
* ``ramdisk``
* ``console.log``, after the instance starts.
If any files are missing, empty, or very small, the ``nova-compute``
service did not successfully download the images from the Image service.
Also check :file:`nova-compute.log` for exceptions. Sometimes they do not
Also check ``nova-compute.log`` for exceptions. Sometimes they do not
appear in the console output.
Next, check the log file for the instance in the :file:`/var/log/libvirt/qemu`
Next, check the log file for the instance in the ``/var/log/libvirt/qemu``
directory to see if it exists and has any useful error messages in it.
Finally, from the :file:`/var/lib/nova/instances` directory for the instance,
Finally, from the ``/var/lib/nova/instances`` directory for the instance,
see if this command returns an error::
# virsh create libvirt.xml
@@ -191,7 +191,7 @@ Injection problems
If instances do not boot or boot slowly, investigate file injection as a cause.
To disable injection in libvirt, set the following in :file:`nova.conf`:
To disable injection in libvirt, set the following in ``nova.conf``:
.. code-block:: ini
:linenos:
@@ -219,7 +219,7 @@ creation of multiple snapshots.
To effectively disable the libvirt live snapshotting, until the problem
is resolved, configure the ``disable_libvirt_livesnapshot`` option.
You can turn off the live snapshotting mechanism by setting up its value to
``True`` in the ``[workarounds]`` section of the :file:`nova.conf` file:
``True`` in the ``[workarounds]`` section of the ``nova.conf`` file:
.. code-block:: ini
:linenos: