heat/doc/source/man/heat-manage.rst
tengqm 5878314987 Fix some line wrap problems in doc
According to RST doc guidelines, we should avoid line length beyond 79
characters:
http://docs.openstack.org/contributor-guide/rst-conv/gen-guidelines.html

Change-Id: I51332f92cbdfd5319e9a0209b2436df716ca2311
2015-12-02 08:47:39 -05:00

69 lines
1.4 KiB
ReStructuredText

===========
heat-manage
===========
.. program:: heat-manage
SYNOPSIS
========
``heat-manage <action> [options]``
DESCRIPTION
===========
heat-manage helps manage heat specific database operations.
OPTIONS
=======
The standard pattern for executing a heat-manage command is:
``heat-manage <command> [<args>]``
Run with -h to see a list of available commands:
``heat-manage -h``
Commands are ``db_version``, ``db_sync``, ``purge_deleted`` and ``service``.
Detailed descriptions are below.
Heat Db version
~~~~~~~~~~~~~~~
``heat-manage db_version``
Print out the db schema version.
``heat-manage db_sync``
Sync the database up to the most recent version.
``heat-manage purge_deleted [-g {days,hours,minutes,seconds}] [age]``
Purge db entries marked as deleted and older than [age].
``heat-manage service list``
Shows details for all currently running heat-engines.
``heat-manage service clean``
Clean dead engine records.
``heat-manage --version``
Shows program's version number and exit. The output could be empty if
the distribution didn't specify any version information.
FILES
=====
The /etc/heat/heat.conf file contains global options which can be
used to configure some aspects of heat-manage, for example the DB
connection and logging.
BUGS
====
* Heat issues are tracked in Launchpad so you can view or report bugs here
`OpenStack Heat Bugs <https://bugs.launchpad.net/heat>`__