Cleanup remaning doc for CloudWatch API

Change-Id: I0423dba4eb2a9ddfd7419869ac5943638786a282
Partial-Bug: #1743707
This commit is contained in:
rabi
2018-02-01 09:50:56 +05:30
committed by Rabi Mishra
parent fb79011451
commit d3ea2918a3
6 changed files with 4 additions and 53 deletions

View File

@@ -7,7 +7,7 @@ Configuration options
The following options allow configuration of the APIs that Orchestration The following options allow configuration of the APIs that Orchestration
supports. Currently this includes compatibility APIs for CloudFormation supports. Currently this includes compatibility APIs for CloudFormation
and CloudWatch and a native API. and a native API.
.. include:: ./tables/heat-api.rst .. include:: ./tables/heat-api.rst
.. include:: ./tables/heat-cfn_api.rst .. include:: ./tables/heat-cfn_api.rst

View File

@@ -73,7 +73,7 @@
* - **[heat_all]** * - **[heat_all]**
- -
* - ``enabled_services`` = ``engine, api, api_cfn`` * - ``enabled_services`` = ``engine, api, api_cfn``
- (List) Specifies the heat services that are enabled when running heat-all. Valid options are all or any combination of api, engine, api_cfn, or api_cloudwatch. - (List) Specifies the heat services that are enabled when running heat-all. Valid options are all or any combination of api, engine or api_cfn.
* - **[profiler]** * - **[profiler]**
- -
* - ``connection_string`` = ``messaging://`` * - ``connection_string`` = ``messaging://``

View File

@@ -29,9 +29,6 @@ The Orchestration service consists of the following components:
An AWS Query API that is compatible with AWS CloudFormation. It An AWS Query API that is compatible with AWS CloudFormation. It
processes API requests by sending them to the ``heat-engine`` over RPC. processes API requests by sending them to the ``heat-engine`` over RPC.
``heat-api-cloudwatch`` component
A CloudWatch-like API service to the heat project.
``heat-engine`` ``heat-engine``
Orchestrates the launching of templates and provides events back to Orchestrates the launching of templates and provides events back to
the API consumer. the API consumer.

View File

@@ -1,38 +0,0 @@
===================
heat-api-cloudwatch
===================
.. program:: heat-api-cloudwatch
SYNOPSIS
========
``heat-api-cloudwatch [options]``
DESCRIPTION
===========
heat-api-cloudwatch is a CloudWatch-like API service to the heat project.
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.
.. cmdoption:: --version
Show program's version number and exit. The output could be empty if
the distribution didn't specify any version information.
FILES
========
* /etc/heat/heat.conf

View File

@@ -12,7 +12,6 @@ Heat services
heat-engine heat-engine
heat-api heat-api
heat-api-cfn heat-api-cfn
heat-api-cloudwatch
-------------- --------------
Heat utilities Heat utilities

View File

@@ -21,13 +21,11 @@ On Debian/Ubuntu systems it is::
/etc/apache2/sites-available/heat-api.conf /etc/apache2/sites-available/heat-api.conf
/etc/apache2/sites-available/heat-api-cfn.conf /etc/apache2/sites-available/heat-api-cfn.conf
/etc/apache2/sites-available/heat-api-cloudwatch.conf
On Red Hat based systems it is:: On Red Hat based systems it is::
/etc/httpd/conf.d/uwsgi-heat-api.conf /etc/httpd/conf.d/uwsgi-heat-api.conf
/etc/httpd/conf.d/uwsgi-heat-api-cfn.conf /etc/httpd/conf.d/uwsgi-heat-api-cfn.conf
/etc/httpd/conf.d/uwsgi-heat-api-cloudwatch.conf
uwsgi uwsgi
----- -----
@@ -42,20 +40,18 @@ other services too) and just need to restart the local uwsgi daemons.
The httpd/files directory contains sample files for configuring httpd to run The httpd/files directory contains sample files for configuring httpd to run
Heat api services under uwsgi in this configuration. To use the sample configs Heat api services under uwsgi in this configuration. To use the sample configs
simply copy `uwsgi-heat-api.conf`, `uwsgi-heat-api-cfn.conf` and simply copy `uwsgi-heat-api.conf` and `uwsgi-heat-api-cfn.conf` to the
`uwsgi-heat-api-cloudwatch.conf` to the appropriate location for your web server. appropriate location for your web server.
On Debian/Ubuntu systems it is:: On Debian/Ubuntu systems it is::
/etc/apache2/sites-available/uwsgi-heat-api.conf /etc/apache2/sites-available/uwsgi-heat-api.conf
/etc/apache2/sites-available/uwsgi-heat-api-cfn.conf /etc/apache2/sites-available/uwsgi-heat-api-cfn.conf
/etc/apache2/sites-available/uwsgi-heat-api-cloudwatch.conf
On Red Hat based systems it is:: On Red Hat based systems it is::
/etc/httpd/conf.d/uwsgi-heat-api.conf /etc/httpd/conf.d/uwsgi-heat-api.conf
/etc/httpd/conf.d/uwsgi-heat-api-cfn.conf /etc/httpd/conf.d/uwsgi-heat-api-cfn.conf
/etc/httpd/conf.d/uwsgi-heat-api-cloudwatch.conf
Enable mod_proxy by running ``sudo a2enmod proxy`` Enable mod_proxy by running ``sudo a2enmod proxy``
@@ -65,7 +61,6 @@ Red Hat based systems)::
ln -s /etc/apache2/sites-available/uwsgi-heat-api.conf /etc/apache2/sites-enabled ln -s /etc/apache2/sites-available/uwsgi-heat-api.conf /etc/apache2/sites-enabled
ln -s /etc/apache2/sites-available/uwsgi-heat-api-cfn.conf /etc/apache2/sites-enabled ln -s /etc/apache2/sites-available/uwsgi-heat-api-cfn.conf /etc/apache2/sites-enabled
ln -s /etc/apache2/sites-available/uwsgi-heat-api-cloudwatch.conf /etc/apache2/sites-enabled
Start or restart httpd to pick up the new configuration. Start or restart httpd to pick up the new configuration.
@@ -74,7 +69,6 @@ files to `/etc/heat`::
heat-api-uwsgi.ini heat-api-uwsgi.ini
heat-api-cfn-uwsgi.ini heat-api-cfn-uwsgi.ini
heat-api-cloudwatch-uwsgi.ini
Update the files to match your system configuration (for example, you'll Update the files to match your system configuration (for example, you'll
want to set the number of processes and threads). want to set the number of processes and threads).
@@ -84,7 +78,6 @@ Install uwsgi and start the heat-api server using uwsgi::
sudo pip install uwsgi sudo pip install uwsgi
uwsgi --ini /etc/heat/heat-api-uwsgi.ini uwsgi --ini /etc/heat/heat-api-uwsgi.ini
uwsgi --ini /etc/heat/heat-api-cfn-uwsgi.ini uwsgi --ini /etc/heat/heat-api-cfn-uwsgi.ini
uwsgi --ini /etc/heat/heat-api-cloudwatch-uwsgi.ini
.. NOTE:: .. NOTE::