]> review.fuel-infra Code Review - openstack-build/heat-build.git/commitdiff
Add manpage for heat-metadata
authorTomas Sedovic <tomas@sedovic.cz>
Mon, 11 Jun 2012 16:19:10 +0000 (18:19 +0200)
committerTomas Sedovic <tomas@sedovic.cz>
Thu, 14 Jun 2012 09:10:27 +0000 (11:10 +0200)
Fixes #140

Change-Id: Iafedefbf2e564760f560ca5f44a44b0cb943fede
Signed-off-by: Tomas Sedovic <tomas@sedovic.cz>
docs/man/man1/heat-metadata.1 [new file with mode: 0644]

diff --git a/docs/man/man1/heat-metadata.1 b/docs/man/man1/heat-metadata.1
new file mode 100644 (file)
index 0000000..6aa5101
--- /dev/null
@@ -0,0 +1,45 @@
+'\" t
+.\"     Title: heat
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 03/31/2012
+.\"    Manual: System administration commands
+.\"    Source: Heat 0.0.1
+.\"  Language: English
+.\"
+.TH "HEAT" "1" "03/31/2012" "HEAT 0\&.0\&.1" "System administration commands"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+heat-metadata \- API server to access and manipulate metadata of Heat stacks
+.SH "SYNOPSIS"
+.sp
+heat-metadata
+.SH "DESCRIPTION"
+.sp
+\fBHeat Metadata\fR provides a restful API to metadata of each stack and resource managed by \fBHeat\fR\&.
+.sp
+It also allows instances to send usage statistics (similar to the CloudWatch
+functionality)\&.
+.sp
+The \fBMetadata server\fR communicates with \fBHeat engine\fR which takes care of the actual database access\&.
+.RE
+.PP
+.SH "AUTHOR"
+.sp
+See the AUTHORS file for a complete list of contributors\&.
+.SH "COPYRIGHT"
+.sp
+Copyright \(co 2012, Red Hat Inc
+.sp
+Heat is released under the terms of the ASL 2 License\&.
+.sp
+Extensive documentation as well as IRC and mailing list info is available on the heat home page: http://heat\&-api\&.org/