diff --git a/doc/config-reference/bk-config-ref.xml b/doc/config-reference/bk-config-ref.xml index 49092e0d76..b4fb770fa3 100644 --- a/doc/config-reference/bk-config-ref.xml +++ b/doc/config-reference/bk-config-ref.xml @@ -119,6 +119,8 @@ + + diff --git a/doc/config-reference/ch_config-overview.xml b/doc/config-reference/ch_config-overview.xml index b2e9e6dbc3..4b36806f3a 100644 --- a/doc/config-reference/ch_config-overview.xml +++ b/doc/config-reference/ch_config-overview.xml @@ -22,6 +22,7 @@ OpenStack Networking OpenStack Object Storage Telemetry + Orchestration diff --git a/doc/config-reference/ch_orchestrationconfigure.xml b/doc/config-reference/ch_orchestrationconfigure.xml new file mode 100644 index 0000000000..7c42d43513 --- /dev/null +++ b/doc/config-reference/ch_orchestrationconfigure.xml @@ -0,0 +1,33 @@ + + + Orchestration + 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 + /etc/heat/heat.conf file. + To install Orchestration, see the OpenStack Installation + Guide for your distribution (docs.openstack.org). + + The following tables provide a comprehensive list of the Orchestration + configuration options. + + + + + + + + + + + + + diff --git a/doc/config-reference/orchestration/section_orchestration-api.xml b/doc/config-reference/orchestration/section_orchestration-api.xml new file mode 100644 index 0000000000..059a56fabd --- /dev/null +++ b/doc/config-reference/orchestration/section_orchestration-api.xml @@ -0,0 +1,20 @@ +
+ + Configure APIs + The following options allow configuration of the APIs that + Orchestration supports. Currently this includes compatibility APIs for + CloudFormation and CloudWatch and a native API. + + + + + +
diff --git a/doc/config-reference/orchestration/section_orchestration-clients.xml b/doc/config-reference/orchestration/section_orchestration-clients.xml new file mode 100644 index 0000000000..97c28faae0 --- /dev/null +++ b/doc/config-reference/orchestration/section_orchestration-clients.xml @@ -0,0 +1,23 @@ +
+ + Configure Clients + The following options allow configuration of the clients that + Orchestration uses to talk to other services. + + + + + + + + + +
diff --git a/doc/config-reference/orchestration/section_orchestration-rpc.xml b/doc/config-reference/orchestration/section_orchestration-rpc.xml new file mode 100644 index 0000000000..24a4e17e5c --- /dev/null +++ b/doc/config-reference/orchestration/section_orchestration-rpc.xml @@ -0,0 +1,112 @@ +
+ + Configure the RPC messaging system + 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: + RabbitMQ, + Qpid, and + ZeroMQ. + +
+ Configure RabbitMQ + + OpenStack Oslo RPC uses RabbitMQ + by default. Use these options to configure the + RabbitMQ message system. The + option is optional as long as + RabbitMQ is the default messaging + system. However, if it is included in the configuration, you must + set it to + heat.openstack.common.rpc.impl_kombu. + + + rpc_backend = heat.openstack.common.rpc.impl_kombu + + Use these 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 option to + heat.notifier.rabbit_notifier in the + heat.conf file: + +
+
+ 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 + option in the + heat.conf file: + rpc_backend=heat.openstack.common.rpc.impl_qpid + This critical option points the compute nodes to the + Qpid broker (server). Set the + option to the host name where + the broker runs in the heat.conf + file. + + The option accepts a host + name or IP address value. + + qpid_hostname = hostname.example.com + + If the Qpid broker listens on a + port other than the AMQP default of 5672, you + must set the option to that + value: + + qpid_port = 12345 + + If you configure the Qpid broker + to require authentication, you must add a user name and password + to the configuration: + + qpid_username = username +qpid_password = password + By default, TCP is used as the transport. To enable SSL, set + the option: + + qpid_protocol = ssl + + Use these additional options to configure the Qpid messaging + driver for OpenStack Oslo RPC. These options are used + infrequently. + + + +
+
+ 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 + option in the + heat.conf file: + +
+
+ Configure messaging + + Use these common options to configure the + RabbitMQ, + Qpid, and + ZeroMq messaging drivers: + + + + +
+