f87114a527
There are several syntax errors in docs. The patch will add missing punctuation, remove extra whitespace, and change the "heat-api-engine" to "heat-engine" in heat-engine.rst. Change-Id: I67dcad5e0e0a1f71a67ab8fc4311d96db4820c29
40 lines
913 B
ReStructuredText
40 lines
913 B
ReStructuredText
========
|
|
heat-api
|
|
========
|
|
|
|
.. program:: heat-api
|
|
|
|
SYNOPSIS
|
|
========
|
|
``heat-api [options]``
|
|
|
|
DESCRIPTION
|
|
===========
|
|
heat-api provides an external REST API to the heat project.
|
|
|
|
INVENTORY
|
|
=========
|
|
heat-api is a service that exposes an external REST based api to the
|
|
heat-engine service. The communication between the heat-api and
|
|
heat-engine uses message queue based RPC.
|
|
|
|
OPTIONS
|
|
=======
|
|
.. cmdoption:: --config-file
|
|
|
|
Path to a config file to use. Multiple config files can be specified, with
|
|
values in later files taking precedence.
|
|
|
|
|
|
.. cmdoption:: --config-dir
|
|
|
|
Path to a config directory to pull .conf files from. This file set is
|
|
sorted, so as to provide a predictable parse order if individual options are
|
|
over-ridden. The set is parsed after the file(s), if any, specified via
|
|
--config-file, hence over-ridden options in the directory take precedence.
|
|
|
|
FILES
|
|
========
|
|
|
|
* /etc/heat/heat.conf
|