Add stub chapter for heat to config-ref
This patch adds the previously generated tables for heat into the config reference by way of a new chapter. It is expected that this be merged as a starting point, with structure to enable further patching. Closes-Bug: 1284470 Change-Id: I715849f542c4b1c291fdc6a1c669f77cabca18ff
This commit is contained in:
Tom Fifield
parent
1994580fa4
commit
d9fffe62ea
@ -119,6 +119,8 @@
|
|||||||
<xi:include href="ch_networkingconfigure.xml"/>
|
<xi:include href="ch_networkingconfigure.xml"/>
|
||||||
<!-- Object Storage -->
|
<!-- Object Storage -->
|
||||||
<xi:include href="ch_objectstorageconfigure.xml"/>
|
<xi:include href="ch_objectstorageconfigure.xml"/>
|
||||||
|
<!-- Orchestration -->
|
||||||
|
<xi:include href="ch_orchestrationconfigure.xml"/>
|
||||||
<!-- Telemetry -->
|
<!-- Telemetry -->
|
||||||
<xi:include href="ch_telemetryconfigure.xml"/>
|
<xi:include href="ch_telemetryconfigure.xml"/>
|
||||||
<!-- Appendices -->
|
<!-- Appendices -->
|
||||||
|
|||||||
@ -22,6 +22,7 @@
|
|||||||
<listitem><para>OpenStack Networking</para></listitem>
|
<listitem><para>OpenStack Networking</para></listitem>
|
||||||
<listitem><para>OpenStack Object Storage</para></listitem>
|
<listitem><para>OpenStack Object Storage</para></listitem>
|
||||||
<listitem><para>Telemetry</para></listitem>
|
<listitem><para>Telemetry</para></listitem>
|
||||||
|
<listitem><para>Orchestration</para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
<xi:include href="../common/section_conventions.xml"/>
|
<xi:include href="../common/section_conventions.xml"/>
|
||||||
<xi:include href="../common/section_dochistory.xml"/>
|
<xi:include href="../common/section_dochistory.xml"/>
|
||||||
|
|||||||
33
doc/config-reference/ch_orchestrationconfigure.xml
Normal file
33
doc/config-reference/ch_orchestrationconfigure.xml
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<chapter version="5.0" xml:id="ch_configuring-openstack-orchestration"
|
||||||
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||||
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
|
xmlns:ns5="http://www.w3.org/1999/xhtml"
|
||||||
|
xmlns:ns4="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
||||||
|
xmlns:ns="http://docbook.org/ns/docbook">
|
||||||
|
<title>Orchestration</title>
|
||||||
|
<para>The Orchestration service is designed to manage the lifecycle of
|
||||||
|
infrastructure and applications within OpenStack clouds. Its
|
||||||
|
various agents and services are configured in the
|
||||||
|
<filename>/etc/heat/heat.conf</filename> file.</para>
|
||||||
|
<para>To install Orchestration, see the <citetitle>OpenStack Installation
|
||||||
|
Guide</citetitle> for your distribution (<link
|
||||||
|
xlink:href="docs.openstack.org" >docs.openstack.org</link>).</para>
|
||||||
|
|
||||||
|
<para>The following tables provide a comprehensive list of the Orchestration
|
||||||
|
configuration options.</para>
|
||||||
|
|
||||||
|
<xi:include href="../common/tables/heat-common.xml"/>
|
||||||
|
<xi:include href="../common/tables/heat-crypt.xml"/>
|
||||||
|
<xi:include href="../common/tables/heat-database.xml"/>
|
||||||
|
<xi:include href="../common/tables/heat-debug.xml"/>
|
||||||
|
<xi:include href="../common/tables/heat-loadbalancer.xml"/>
|
||||||
|
<xi:include href="../common/tables/heat-logging.xml"/>
|
||||||
|
<xi:include href="../common/tables/heat-quota.xml"/>
|
||||||
|
<xi:include href="../common/tables/heat-redis.xml"/>
|
||||||
|
<xi:include href="orchestration/section_orchestration-api.xml"/>
|
||||||
|
<xi:include href="orchestration/section_orchestration-clients.xml"/>
|
||||||
|
<xi:include href="orchestration/section_orchestration-rpc.xml"/>
|
||||||
|
</chapter>
|
||||||
@ -0,0 +1,20 @@
|
|||||||
|
<section xml:id="orchestration-configuring-api"
|
||||||
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||||
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
|
xmlns:ns5="http://www.w3.org/1999/xhtml"
|
||||||
|
xmlns:ns4="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
||||||
|
xmlns:ns="http://docbook.org/ns/docbook"
|
||||||
|
version="5.0">
|
||||||
|
<?dbhtml stop-chunking?>
|
||||||
|
<title>Configure APIs</title>
|
||||||
|
<para>The following options allow configuration of the APIs that
|
||||||
|
Orchestration supports. Currently this includes compatibility APIs for
|
||||||
|
CloudFormation and CloudWatch and a native API.</para>
|
||||||
|
<xi:include href="../../common/tables/heat-api.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-cfn_api.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-cloudwatch_api.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-metadata_api.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-waitcondition_api.xml"/>
|
||||||
|
</section>
|
||||||
@ -0,0 +1,23 @@
|
|||||||
|
<section xml:id="orchestration-configuring-clients"
|
||||||
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||||
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
|
xmlns:ns5="http://www.w3.org/1999/xhtml"
|
||||||
|
xmlns:ns4="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
||||||
|
xmlns:ns="http://docbook.org/ns/docbook"
|
||||||
|
version="5.0">
|
||||||
|
<?dbhtml stop-chunking?>
|
||||||
|
<title>Configure Clients</title>
|
||||||
|
<para>The following options allow configuration of the clients that
|
||||||
|
Orchestration uses to talk to other services.</para>
|
||||||
|
<xi:include href="../../common/tables/heat-clients.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-clients_backends.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-clients_ceilometer.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-clients_cinder.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-clients_heat.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-clients_keystone.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-clients_nova.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-clients_swift.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-clients_trove.xml"/>
|
||||||
|
</section>
|
||||||
112
doc/config-reference/orchestration/section_orchestration-rpc.xml
Normal file
112
doc/config-reference/orchestration/section_orchestration-rpc.xml
Normal file
@ -0,0 +1,112 @@
|
|||||||
|
<section xml:id="orchestration-configuring-rpc"
|
||||||
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||||
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
|
xmlns:ns5="http://www.w3.org/1999/xhtml"
|
||||||
|
xmlns:ns4="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
||||||
|
xmlns:ns="http://docbook.org/ns/docbook"
|
||||||
|
version="5.0">
|
||||||
|
<?dbhtml stop-chunking?>
|
||||||
|
<title>Configure the RPC messaging system</title>
|
||||||
|
<para>OpenStack projects use an open standard for messaging
|
||||||
|
middleware known as AMQP. 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:
|
||||||
|
<application>RabbitMQ</application>,
|
||||||
|
<application>Qpid</application>, and
|
||||||
|
<application>ZeroMQ</application>.</para>
|
||||||
|
|
||||||
|
<section xml:id="orchestration-configuration-rabbitmq">
|
||||||
|
<title>Configure RabbitMQ</title>
|
||||||
|
|
||||||
|
<para>OpenStack Oslo RPC uses <application>RabbitMQ</application>
|
||||||
|
by default. Use these options to configure the
|
||||||
|
<application>RabbitMQ</application> message system. The
|
||||||
|
<option>rpc_backend</option> option is optional as long as
|
||||||
|
<application>RabbitMQ</application> is the default messaging
|
||||||
|
system. However, if it is included in the configuration, you must
|
||||||
|
set it to
|
||||||
|
<literal>heat.openstack.common.rpc.impl_kombu</literal>.</para>
|
||||||
|
|
||||||
|
|
||||||
|
<programlisting language="ini">rpc_backend = heat.openstack.common.rpc.impl_kombu</programlisting>
|
||||||
|
|
||||||
|
<para>Use these options to configure the
|
||||||
|
<application>RabbitMQ</application> 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 <option>notification_driver</option> option to
|
||||||
|
<literal>heat.notifier.rabbit_notifier</literal> in the
|
||||||
|
<filename>heat.conf</filename> file:</para>
|
||||||
|
<xi:include href="../../common/tables/heat-rabbitmq.xml"/>
|
||||||
|
</section>
|
||||||
|
<section xml:id="orchestration-configuration-qpid">
|
||||||
|
<title>Configure Qpid</title>
|
||||||
|
<para>Use these options to configure the
|
||||||
|
<application>Qpid</application> messaging system for OpenStack
|
||||||
|
Oslo RPC. <application>Qpid</application> is not the default
|
||||||
|
messaging system, so you must enable it by setting the
|
||||||
|
<option>rpc_backend</option> option in the
|
||||||
|
<filename>heat.conf</filename> file:</para>
|
||||||
|
<programlisting language="ini">rpc_backend=heat.openstack.common.rpc.impl_qpid</programlisting>
|
||||||
|
<para>This critical option points the compute nodes to the
|
||||||
|
<application>Qpid</application> broker (server). Set the
|
||||||
|
<option>qpid_hostname</option> option to the host name where
|
||||||
|
the broker runs in the <filename>heat.conf</filename>
|
||||||
|
file.</para>
|
||||||
|
<note>
|
||||||
|
<para>The <option>qpid_hostname</option> option accepts a host
|
||||||
|
name or IP address value.</para>
|
||||||
|
</note>
|
||||||
|
<programlisting language="ini">qpid_hostname = hostname.example.com</programlisting>
|
||||||
|
|
||||||
|
<para>If the <application>Qpid</application> broker listens on a
|
||||||
|
port other than the AMQP default of <literal>5672</literal>, you
|
||||||
|
must set the <option>qpid_port</option> option to that
|
||||||
|
value:</para>
|
||||||
|
|
||||||
|
<programlisting language="ini">qpid_port = 12345</programlisting>
|
||||||
|
|
||||||
|
<para>If you configure the <application>Qpid</application> broker
|
||||||
|
to require authentication, you must add a user name and password
|
||||||
|
to the configuration:</para>
|
||||||
|
|
||||||
|
<programlisting language="ini">qpid_username = username
|
||||||
|
qpid_password = password</programlisting>
|
||||||
|
<para>By default, TCP is used as the transport. To enable SSL, set
|
||||||
|
the <option>qpid_protocol</option> option:</para>
|
||||||
|
|
||||||
|
<programlisting language="ini">qpid_protocol = ssl</programlisting>
|
||||||
|
|
||||||
|
<para>Use these additional options to configure the Qpid messaging
|
||||||
|
driver for OpenStack Oslo RPC. These options are used
|
||||||
|
infrequently.</para>
|
||||||
|
|
||||||
|
<xi:include href="../../common/tables/heat-qpid.xml"/>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section xml:id="orchestration-configuration-zeromq">
|
||||||
|
<title>Configure ZeroMQ</title>
|
||||||
|
<para>Use these options to configure the
|
||||||
|
<application>ZeroMQ</application> messaging system for
|
||||||
|
OpenStack Oslo RPC. <application>ZeroMQ</application> is not the
|
||||||
|
default messaging system, so you must enable it by setting the
|
||||||
|
<option>rpc_backend</option> option in the
|
||||||
|
<filename>heat.conf</filename> file:</para>
|
||||||
|
<xi:include href="../../common/tables/heat-zeromq.xml"/>
|
||||||
|
</section>
|
||||||
|
<section xml:id="orchestration-common-messaging-configuration">
|
||||||
|
<title>Configure messaging</title>
|
||||||
|
|
||||||
|
<para>Use these common options to configure the
|
||||||
|
<application>RabbitMQ</application>,
|
||||||
|
<application>Qpid</application>, and
|
||||||
|
<application>ZeroMq</application> messaging drivers:</para>
|
||||||
|
|
||||||
|
<xi:include href="../../common/tables/heat-amqp.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-rpc.xml"/>
|
||||||
|
<xi:include href="../../common/tables/heat-notification.xml"/>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
Loading…
Reference in New Issue
Block a user