[config-ref] Convert compute db and rpc to RST
Change-Id: I07815155e7c06282b394d288abb21620c5a28119 Implements: blueprint config-ref-rst
This commit is contained in:
parent
bd345abbe8
commit
d7dd96fc8f
@ -9,6 +9,8 @@ Compute
|
||||
compute/logging.rst
|
||||
compute/authentication-authorization.rst
|
||||
compute/resize.rst
|
||||
compute/database-connections.rst
|
||||
compute/rpc.rst
|
||||
compute/scheduler.rst
|
||||
compute/cells.rst
|
||||
compute/conductor.rst
|
||||
|
22
doc/config-ref-rst/source/compute/database-connections.rst
Normal file
22
doc/config-ref-rst/source/compute/database-connections.rst
Normal file
@ -0,0 +1,22 @@
|
||||
======================
|
||||
Database configuration
|
||||
======================
|
||||
|
||||
You can configure OpenStack Compute to use any SQLAlchemy-compatible database.
|
||||
The database name is ``nova``. The ``nova-conductor`` service is the only
|
||||
service that writes to the database. The other Compute services access
|
||||
the database through the ``nova-conductor`` service.
|
||||
|
||||
To ensure that the database schema is current, run the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# nova-manage db sync
|
||||
|
||||
If ``nova-conductor`` is not used, entries to the database are mostly
|
||||
written by the ``nova-scheduler`` service, although all services must
|
||||
be able to update entries in the database.
|
||||
|
||||
In either case, use the configuration option settings documented in
|
||||
the table :ref:`nova-database` to configure the connection string
|
||||
for the nova database.
|
106
doc/config-ref-rst/source/compute/rpc.rst
Normal file
106
doc/config-ref-rst/source/compute/rpc.rst
Normal file
@ -0,0 +1,106 @@
|
||||
=======================================
|
||||
Configure the Oslo RPC messaging system
|
||||
=======================================
|
||||
|
||||
OpenStack projects use AMQP, an open standard for messaging middleware.
|
||||
This messaging middleware enables the OpenStack services that run on
|
||||
multiple servers to talk to each other. OpenStack Oslo RPC supports
|
||||
three implementations of AMQP: ``RabbitMQ``, ``Qpid``, and ``ZeroMQ``.
|
||||
|
||||
Configure RabbitMQ
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
OpenStack Oslo RPC uses ``RabbitMQ`` by default.
|
||||
Use these options to configure the ``RabbitMQ`` message system.
|
||||
The ``rpc_backend`` option is not required as long as ``RabbitMQ``
|
||||
is the default messaging system. However, if it is included in
|
||||
the configuration, you must set it to ``rabbit``.
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
rpc_backend=rabbit
|
||||
|
||||
You can use these additional options to configure the ``RabbitMQ``
|
||||
messaging system. You can configure messaging communication for
|
||||
different installation scenarios, tune retries for RabbitMQ, and
|
||||
define the size of the RPC thread pool. To monitor notifications
|
||||
through ``RabbitMQ``, you must set the ``notification_driver`` option to
|
||||
``nova.openstack.common.notifier.rpc_notifier`` in the ``nova.conf`` file.
|
||||
The default for sending usage data is sixty seconds plus a random
|
||||
number of seconds from zero to sixty.
|
||||
|
||||
.. include:: ../tables/nova-rabbitmq.rst
|
||||
|
||||
Configure Qpid
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
Use these options to configure the ``Qpid`` messaging system for
|
||||
OpenStack Oslo RPC. ``Qpid`` is not the default messaging system,
|
||||
so you must enable it by setting the ``rpc_backend`` option in the
|
||||
``nova.conf`` file.
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
rpc_backend=qpid
|
||||
|
||||
.. warning::
|
||||
|
||||
The Qpid driver has been deprecated.
|
||||
The driver is planned to be removed during the Mitaka development cycle.
|
||||
|
||||
This critical option points the compute nodes to the ``Qpid`` broker (server).
|
||||
Set ``qpid_hostname`` to the host name where the broker runs in the
|
||||
``nova.conf`` file.
|
||||
|
||||
.. note::
|
||||
|
||||
The :option:`--qpid_hostname` parameter accepts a host name or IP address value.
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
qpid_hostname=hostname.example.com
|
||||
|
||||
If the ``Qpid`` broker listens on a port other than the AMQP default of
|
||||
``5672``, you must set the ``qpid_port`` option to that value:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
qpid_port=12345
|
||||
|
||||
If you configure the ``Qpid`` broker to require authentication,
|
||||
you must add a user name and password to the configuration:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
qpid_username=username
|
||||
qpid_password=password
|
||||
|
||||
By default, TCP is used as the transport.
|
||||
To enable SSL, set the ``qpid_protocol`` option:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
qpid_protocol=ssl
|
||||
|
||||
This table lists additional options that can be used to configure the Qpid
|
||||
messaging driver for OpenStack Oslo RPC. These options are used infrequently.
|
||||
|
||||
.. include:: ../tables/nova-qpid.rst
|
||||
|
||||
Configure ZeroMQ
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Use these options to configure the ``ZeroMQ`` messaging system for OpenStack
|
||||
Oslo RPC. ``ZeroMQ`` is not the default messaging system, so you must enable
|
||||
it by setting the ``rpc_backend`` option in the ``nova.conf`` file.
|
||||
|
||||
.. include:: ../tables/nova-zeromq.rst
|
||||
|
||||
Configure messaging
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Use these options to configure the ``RabbitMQ`` and ``Qpid``
|
||||
messaging drivers.
|
||||
|
||||
.. include:: ../tables/nova-amqp.rst
|
||||
.. include:: ../tables/nova-rpc.rst
|
Loading…
x
Reference in New Issue
Block a user