heat/doc/source/man/heat-manage.rst
Ala Rezmerita 61836dbf42 Purge deleted stacks for specific project
Add project-id argument to heat-manage purge_deleted command in order
to be able to hard delete DB entries for a specific project.

Change-Id: Ifffe5657a40ce97db9d059ff1516b8e1eb801132
Implements: bp heat-manage-purge-deleted-tenant
2016-07-20 17:02:12 +00:00

70 lines
1.5 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}] [-p project_id] [age]``
Purge db entries marked as deleted and older than [age]. When project_id
argument is provided, only entries belonging to this project will be purged.
``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>`__