diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000000..6438f1c050 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,2 @@ +target/ +build/ diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000000..5e5f8ff187 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Heat.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Heat.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Heat" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Heat" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/README.rst b/doc/README.rst new file mode 100644 index 0000000000..9188b2149a --- /dev/null +++ b/doc/README.rst @@ -0,0 +1,35 @@ +=========================== +Building the developer docs +=========================== + +For user and admin docs, go to the directory `doc/docbkx`. + +Dependencies +============ + +Sphinx_ + You'll need sphinx (the python one) and if you are + using the virtualenv you'll need to install it in the virtualenv + specifically so that it can load the cinder modules. + + :: + + sudo yum install python-sphinx + sudo pip-python install sphinxcontrib-httpdomain + +Use `make` +========== + +Just type make:: + + make + +Look in the Makefile for more targets. + +To build the man pages: + + make man + +To build the developer documentation as HTML: + + make html \ No newline at end of file diff --git a/doc/docbkx/README.rst b/doc/docbkx/README.rst new file mode 100644 index 0000000000..4286b29f99 --- /dev/null +++ b/doc/docbkx/README.rst @@ -0,0 +1,35 @@ +================================ +Building the user and admin docs +================================ + +This documentation should eventually end up in the OpenStack documentation +repositories `api-site` and `openstack-manuals`. + +Dependencies +============ + +on Ubuntu: + + sudo apt-get install maven + +on Fedora Core: + + sudo yum install maven + +Use `mvn` +========= + +Build the REST API reference manual: + + cd api-ref + mvn clean generate-sources + +Build the Heat admin guide: + + cd heat-admin + mvn clean generate-sources + +Build the Heat CLI guide: + + cd heat-cli-guide + mvn clean generate-sources \ No newline at end of file diff --git a/doc/docbkx/api-ref/pom.xml b/doc/docbkx/api-ref/pom.xml new file mode 100644 index 0000000000..3147fce7ef --- /dev/null +++ b/doc/docbkx/api-ref/pom.xml @@ -0,0 +1,76 @@ + + + 4.0.0 + + org.openstack.identity + docs + 1.0 + jar + OpenStack API Page Project + + + Rackspace Research Repositories + + true + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + always + + + + + + + UTF-8 + 1.5.1 + + + + + com.rackspace.cloud.api + clouddocs-maven-plugin + ${doctools.version} + + + g1 + + generate-html + + generate-sources + + false + 1 + UA-17511903-1 + + + + + + true + src/docbkx + + api-ref.xml + + reviewer + openstack + 1 + true + + + + + diff --git a/doc/docbkx/api-ref/src/docbkx/api-ref.xml b/doc/docbkx/api-ref/src/docbkx/api-ref.xml new file mode 100644 index 0000000000..ab1ca4aef8 --- /dev/null +++ b/doc/docbkx/api-ref/src/docbkx/api-ref.xml @@ -0,0 +1,24 @@ + + + + Heat API + + 2012 + + + + + + + Heat + + + + + diff --git a/doc/docbkx/api-ref/src/wadls/heat-api/src/heat-api-1.0.wadl b/doc/docbkx/api-ref/src/wadls/heat-api/src/heat-api-1.0.wadl new file mode 100644 index 0000000000..4fe4e31b69 --- /dev/null +++ b/doc/docbkx/api-ref/src/wadls/heat-api/src/heat-api-1.0.wadl @@ -0,0 +1,13 @@ + + + + + + + + + + + diff --git a/doc/docbkx/heat-admin/app_core.xml b/doc/docbkx/heat-admin/app_core.xml new file mode 100644 index 0000000000..e1901b176e --- /dev/null +++ b/doc/docbkx/heat-admin/app_core.xml @@ -0,0 +1,16 @@ + + + + + + + +]> + + Core Configuration File Options + TODO + diff --git a/doc/docbkx/heat-admin/bk-heat-admin-guide.xml b/doc/docbkx/heat-admin/bk-heat-admin-guide.xml new file mode 100644 index 0000000000..23fd7dde46 --- /dev/null +++ b/doc/docbkx/heat-admin/bk-heat-admin-guide.xml @@ -0,0 +1,69 @@ + + + + + + + +]> + + + Heat Administration Guide + + + + + + + + + 2012 + OpenStack + + Grizzly (2013.1) + Heat + 2012-12-14 + + + Copyright details are filled in by the template. + + + + This document is intended for administrators interested in running the Heat Service. + + + + + + 2012-12-14 + + + + First edition of this document. + + + + + + + + + + + + + + + + + diff --git a/doc/docbkx/heat-admin/ch_install.xml b/doc/docbkx/heat-admin/ch_install.xml new file mode 100644 index 0000000000..e3f675e39a --- /dev/null +++ b/doc/docbkx/heat-admin/ch_install.xml @@ -0,0 +1,19 @@ + + + + + + + +]> + + Heat Installation + This chapter describes how to install the Heat Service + and get it up and running. + diff --git a/doc/docbkx/heat-admin/ch_limitations.xml b/doc/docbkx/heat-admin/ch_limitations.xml new file mode 100644 index 0000000000..b057431f42 --- /dev/null +++ b/doc/docbkx/heat-admin/ch_limitations.xml @@ -0,0 +1,43 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + +'> + + + + + + + + +'> +]> + + Limitations + TODO + diff --git a/doc/docbkx/heat-admin/ch_overview.xml b/doc/docbkx/heat-admin/ch_overview.xml new file mode 100644 index 0000000000..49382311a1 --- /dev/null +++ b/doc/docbkx/heat-admin/ch_overview.xml @@ -0,0 +1,57 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + +'> + + + + + + + + +'> + + + + + + +powered by OpenStack'> +powered by OpenStack'> +]> + + Overview + This chapter describes the high-level concepts and + components of a Heat deployment. + + diff --git a/doc/docbkx/heat-admin/ch_preface.xml b/doc/docbkx/heat-admin/ch_preface.xml new file mode 100644 index 0000000000..2da1812991 --- /dev/null +++ b/doc/docbkx/heat-admin/ch_preface.xml @@ -0,0 +1,68 @@ + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + +'> + + + + + + + + +'> + + + + + + +powered by OpenStack'> +powered by OpenStack'> +]> + + Preface +
+ Intended Audience + TODO +
+
+ Document Change History + The most recent changes are described in the table + below: + +
+
+ Resources + TODO +
+ + diff --git a/doc/docbkx/heat-admin/ch_using.xml b/doc/docbkx/heat-admin/ch_using.xml new file mode 100644 index 0000000000..354dd60fff --- /dev/null +++ b/doc/docbkx/heat-admin/ch_using.xml @@ -0,0 +1,43 @@ + + + + + + + + +GET'> +PUT'> +POST'> +DELETE'> + + + + + + + + +'> + + + + + + + + +'> +]> + + Using Heat + TODO + diff --git a/doc/docbkx/heat-admin/pom.xml b/doc/docbkx/heat-admin/pom.xml new file mode 100644 index 0000000000..4cd7ae587a --- /dev/null +++ b/doc/docbkx/heat-admin/pom.xml @@ -0,0 +1,151 @@ + + + + 4.0.0 + + org.openstack.docs + openstack-guide + 1.0.0-SNAPSHOT + jar + OpenStack Guides + + + + local + 1 + + + + + + + + Rackspace Research Repositories + + true + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + + + + + + + + target/docbkx/pdf + + **/*.fo + + + + + + + com.rackspace.cloud.api + clouddocs-maven-plugin + 1.5.1 + + + goal1 + + generate-pdf + + generate-sources + + false + + 0 + 0 + + + + goal2 + + generate-webhelp + + generate-sources + + + ${comments.enabled} + 1 + os-heat-guides + 1 + UA-17511903-1 + + appendix toc,title + article/appendix nop + article toc,title + book title,figure,table,example,equation + chapter toc,title + part toc,title + preface toc,title + qandadiv toc + qandaset toc + reference toc,title + set toc,title + + + 0 + 0 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + . + + bk-heat-admin-guide.xml + + http://docs.openstack.org/${release.path.name}/heat-admin/content/ + reviewer + openstack + + + + + + diff --git a/doc/docbkx/heat-cli-guide/pom.xml b/doc/docbkx/heat-cli-guide/pom.xml new file mode 100644 index 0000000000..fc74cc7f30 --- /dev/null +++ b/doc/docbkx/heat-cli-guide/pom.xml @@ -0,0 +1,132 @@ + + + 4.0.0 + + org.openstack.docs + openstack-cli-guide + 1.0.0-SNAPSHOT + jar + OpenStack CLI Guides + + + + + + + Rackspace Research Repositories + + true + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + + + + rackspace-research + Rackspace Research Repository + http://maven.research.rackspacecloud.com/content/groups/public/ + + + + + + + + + target/docbkx/pdf + + **/*.fo + + + + + + + com.rackspace.cloud.api + clouddocs-maven-plugin + 1.5.1 + + + goal1 + + generate-pdf + + generate-sources + + + false + + 0 + 0 + + + + goal2 + + generate-webhelp + + generate-sources + + + cli-guide.pdf + 1 + os-cliguide + 1 + UA-17511903-1 + + appendix toc,title + article/appendix nop + article toc,title + book title,figure,table,example,equation + chapter toc,title + part toc,title + preface toc,title + qandadiv toc + qandaset toc + reference toc,title + set toc,title + + + 0 + 0 + + + + + + + + + + + + + + + + + + true + src + + bk-cli-guide.xml + + + reviewer + openstack + + + + + + diff --git a/doc/docbkx/heat-cli-guide/src/bk-cli-guide.xml b/doc/docbkx/heat-cli-guide/src/bk-cli-guide.xml new file mode 100644 index 0000000000..0e47555b7a --- /dev/null +++ b/doc/docbkx/heat-cli-guide/src/bk-cli-guide.xml @@ -0,0 +1,15 @@ + + + OpenStack CLI Guide + Each OpenStack project has a Command-Line-Interface (CLI) + that interacts with the service's REST API. + + + + + diff --git a/doc/docbkx/heat-cli-guide/src/heat_cli_commands.xml b/doc/docbkx/heat-cli-guide/src/heat_cli_commands.xml new file mode 100644 index 0000000000..7d5f9b3e81 --- /dev/null +++ b/doc/docbkx/heat-cli-guide/src/heat_cli_commands.xml @@ -0,0 +1,22 @@ + +
+ Command List for heat CLI + + event-list List events for a stack + event-show Describe the event + resource-list Show list of resources belonging to a stack + resource-metadata List resource metadata + resource-show Describe the resource + stack-create Create the stack + stack-delete Delete the stack + stack-list List the user's stacks + stack-show Describe the stack + stack-update Update the stack + template-show Get the template for the specified stack + template-validate Validate a template with parameters + help Display help about this program or one of its subcommands. + +
diff --git a/doc/docbkx/heat-cli-guide/src/heat_cli_howto.xml b/doc/docbkx/heat-cli-guide/src/heat_cli_howto.xml new file mode 100644 index 0000000000..c4f697a1e8 --- /dev/null +++ b/doc/docbkx/heat-cli-guide/src/heat_cli_howto.xml @@ -0,0 +1,13 @@ + +
+ + OpenStack Heat CLI Guide + This section describes heat commands + +
diff --git a/doc/docbkx/heat-cli-guide/src/heat_cli_install.xml b/doc/docbkx/heat-cli-guide/src/heat_cli_install.xml new file mode 100644 index 0000000000..d05f12b0f6 --- /dev/null +++ b/doc/docbkx/heat-cli-guide/src/heat_cli_install.xml @@ -0,0 +1,84 @@ + +
+ Install OpenStack heat CLI + This example walks through installing the heat client. After + you install a client, you must configure environment variables + for authentication. + + To install the heat client: + + Install Python + Install Python 2.6 or later. Currently, the heat + client does not support Python 3. + + + Install the heat client package + Choose one of the following methods to install the + heat client package. + + Recommended + method: + pip + Install pip through + the package manager for your + system: + + + + + System + Command + + + + + Mac OS X + + $ sudo easy_install pip + + + + Ubuntu + + $ aptitude install python-pip + + + + RHEL, CentOS, or Fedora: + + $ yum install python-pip + + + + + Run the following command to install the heat client package: + $ sudo pip install python-heatclient + + + + easy_install + Run the following command to install the + heat client package: + $ sudo easy_install python-heatclient + + + + + Get help for heat client commands + To get help for heat client commands, run the + following command: + $ heat -h + Depending on your user credentials, you may not have + permissions to use every command that is listed. The + heat client was written for use with recent + development versions of OpenStack. + To get help for a specific command, type the command + name after the help parameter, + as follows: + $ heat help <command_name> + +
diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000000..87a91e44e0 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,259 @@ +# -*- coding: utf-8 -*- +# +# Heat documentation build configuration file, created by +# sphinx-quickstart on Thu Dec 13 11:23:35 2012. +# +# This file is execfile()d with the current directory set to its containing +# dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import os +import sys + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../../')) + +# -- General configuration ---------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +#templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Heat' +copyright = u'2012, Heat Developers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. + +from heat.version import version_info as heat_version +release = heat_version.version_string_with_vcs() +version = heat_version.canonical_version_string() + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Heatdoc' + + +# -- Options for LaTeX output ------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]) +latex_documents = [ + ('index', 'Heat.tex', u'Heat Documentation', + u'Heat Developers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output ------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('man/heat-cfn', 'heat-cfn', + u'Command line utility to run heat actions over the CloudFormation API', + [u'Heat Developers'], 1), + ('man/heat-api', 'heat-api', + u'REST API service to the heat project.', + [u'Heat Developers'], 1), + ('man/heat-api-cfn', 'heat-api-cfn', + u'CloudFormation compatible API service to the heat project.', + [u'Heat Developers'], 1), + ('man/heat-api-cloudwatch', 'heat-api-cloudwatch', + u'CloudWatch alike API service to the heat project', + [u'Heat Developers'], 1), + ('man/heat-engine', 'heat-engine', + u'Service which performs the actions from the API calls made by the user', + [u'Heat Developers'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ----------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Heat', u'Heat Documentation', + u'Heat Developers', 'Heat', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000000..5a193afad4 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,25 @@ +.. Heat documentation master file, created by + sphinx-quickstart on Thu Dec 13 11:23:35 2012. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to the Heat developer documentation! +================================ + +This documentation offers information on how Heat works and how to contribute to the project. + +Contents: + +.. toctree:: + :maxdepth: 2 + + GettingStarted.rst + man/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/source/man/heat-api-cfn.rst b/doc/source/man/heat-api-cfn.rst new file mode 100644 index 0000000000..57760a3834 --- /dev/null +++ b/doc/source/man/heat-api-cfn.rst @@ -0,0 +1,40 @@ +============ +heat-api-cfn +============ + +.. program:: heat-api-cfn + +SYNOPSIS +======== +``heat-api-cfn [options]`` + +DESCRIPTION +=========== +heat-api-cfn is a CloudFormation compatible API service to the heat project. + +INVENTORY +========= +heat-api-cfn is a service that exposes an external REST based api to the +heat-engine service. The communication between the heat-api-cfn 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-api-cfn.conf +* /etc/heat/heat-api-cfn-paste.ini \ No newline at end of file diff --git a/doc/source/man/heat-api-cloudwatch.rst b/doc/source/man/heat-api-cloudwatch.rst new file mode 100644 index 0000000000..488cbebd91 --- /dev/null +++ b/doc/source/man/heat-api-cloudwatch.rst @@ -0,0 +1,34 @@ +=================== +heat-api-cloudwatch +=================== + +.. program:: heat-api-cloudwatch + +SYNOPSIS +======== +``heat-api-cloudwatch [options]`` + +DESCRIPTION +=========== +heat-api-cloudwatch is a CloudWatch alike 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. + +FILES +======== + +* /etc/heat/heat-api-cloudwatch.conf +* /etc/heat/heat-api-cloudwatch-paste.ini \ No newline at end of file diff --git a/doc/source/man/heat-api.rst b/doc/source/man/heat-api.rst new file mode 100644 index 0000000000..1bcf86bf94 --- /dev/null +++ b/doc/source/man/heat-api.rst @@ -0,0 +1,40 @@ +======== +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 +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-api.conf +* /etc/heat/heat-api-paste.ini \ No newline at end of file diff --git a/doc/source/man/heat-cfn.rst b/doc/source/man/heat-cfn.rst new file mode 100644 index 0000000000..602048f23b --- /dev/null +++ b/doc/source/man/heat-cfn.rst @@ -0,0 +1,199 @@ +======== +heat-cfn +======== + +.. program:: heat-cfn + +SYNOPSIS +======== + +``heat-cfn [OPTIONS] COMMAND [COMMAND_OPTIONS]`` + +DESCRIPTION +=========== +heat-cfn is a command-line utility for heat. It is simply an +interface for adding, modifying, and retrieving information about the stacks +belonging to a user. It is a convenience application that talks to the heat +CloudFormation API compatable server. + + +CONFIGURATION +============= + +heat-cfn uses keystone authentication, and expects some variables to be +set in your environment, without these heat will not be able to establish +an authenticated connection with the heat API server. + +Example: + +export ADMIN_TOKEN= + +export OS_USERNAME=admin + +export OS_PASSWORD=verybadpass + +export OS_TENANT_NAME=admin + +export OS_AUTH_URL=http://127.0.0.1:5000/v2.0/ + +export OS_AUTH_STRATEGY=keystone + + + +COMMANDS +======== + +``create`` + + Create stack as defined in template file + +``delete`` + + Delete specified stack + +``describe`` + + Provide detailed information about the specified stack, or if no arguments are given all stacks + +``estimate-template-cost`` + + Currently not implemented + +``event-list`` + + List events related to specified stacks, or if no arguments are given all stacks + +``gettemplate`` + + Get the template for a running stack + +``help`` + + Provide help/usage information + +``list`` + + List summary information for all stacks + +``resource`` + + List information about a specific resource + +``resource-list`` + + List all resources for a specified stack + +``resource-list-details`` + + List details of all resources for a specified stack or physical resource ID, optionally filtered by a logical resource ID + +``update`` + + Update a running stack with a modified template or template parameters - currently not implemented + +``validate`` + + Validate a template file syntax + + +OPTIONS +======= + +.. cmdoption:: -S, --auth_strategy + + Authentication strategy + +.. cmdoption:: -A, --auth_token + + Authentication token to use to identify the client to the heat server + +.. cmdoption:: -N, --auth_url + + Authentication URL for keystone authentication + +.. cmdoption:: -d, --debug + + Enable verbose debug level output + +.. cmdoption:: -H, --host + + Specify the hostname running the heat API service + +.. cmdoption:: -k, --insecure + + Use plain HTTP instead of HTTPS + +.. cmdoption:: -P, --parameters + + Stack input parameters + +.. cmdoption:: -K, --password + + Password used to acquire an authentication token + +.. cmdoption:: -p, --port + + Specify the port to connect to for the heat API service + +.. cmdoption:: -R, --region + + Region name. When using keystone authentication "version 2.0 or later this identifies the region + +.. cmdoption:: -f, --template-file + + Path to file containing the stack template + +.. cmdoption:: -u, --template-url + + URL to stack template + +.. cmdoption:: -T, --tenant + + Tenant name used for Keystone authentication + +.. cmdoption:: -t, --timeout + + Stack creation timeout (default is 60 minutes) + +.. cmdoption:: -U, --url + + URL of heat service + +.. cmdoption:: -I, --username + + User name used to acquire an authentication token + +.. cmdoption:: -v, --verbose + + Enable verbose output + +.. cmdoption:: -y, --yes + + Do not prompt for confirmation, assume yes + + +EXAMPLES +======== + heat-cfn -d create wordpress --template- + file=templates/WordPress_Single_Instance.template + --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpass;KeyName=${USER}_key" + + heat-cfn list + + heat-cfn describe wordpress + + heat-cfn resource-list wordpress + + heat-cfn resource-list-details wordpress + + heat-cfn resource-list-details wordpress WikiDatabase + + heat-cfn resource wordpress WikiDatabase + + heat-cfn event-list + + heat-cfn delete wordpress + +BUGS +==== +Heat bugs are managed through Launchpad \ No newline at end of file diff --git a/doc/source/man/heat-engine.rst b/doc/source/man/heat-engine.rst new file mode 100644 index 0000000000..3071acd19d --- /dev/null +++ b/doc/source/man/heat-engine.rst @@ -0,0 +1,38 @@ +=========== +heat-engine +=========== + +.. program:: heat-api-engine + +SYNOPSIS +======== +``heat-engine [options]`` + +DESCRIPTION +=========== +Heat is the heat project server with an internal api called by the heat-api. + +INVENTORY +========= +The heat engine does all the orchestration work and is the layer in which +the resource integration is implemented. + +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-engine.conf diff --git a/doc/source/man/index.rst b/doc/source/man/index.rst new file mode 100644 index 0000000000..f67e9c322a --- /dev/null +++ b/doc/source/man/index.rst @@ -0,0 +1,24 @@ +=================================== +Man pages for services and utilities +=================================== + +------------- +Heat services +------------- + +.. toctree:: + :maxdepth: 2 + + heat-engine + heat-api + heat-api-cfn + heat-api-cloudwatch + +-------------- +Heat utilities +-------------- + +.. toctree:: + :maxdepth: 2 + + heat-cfn diff --git a/docs/man/man1/heat-api-cfn.1 b/docs/man/man1/heat-api-cfn.1 deleted file mode 100644 index 9158b45fd0..0000000000 --- a/docs/man/man1/heat-api-cfn.1 +++ /dev/null @@ -1,43 +0,0 @@ -'\" t -.\" Title: heat -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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-api-cfn \- The external api to the heat engine -.SH "SYNOPSIS" -.sp -heat-engine -.SH "DESCRIPTION" -.sp -\fBHeat\fR is the external api to the heat project\&. -.RE -.PP -.SH "INVENTORY" -.sp -The heat api is a services that exposes an external api to the heat-engine service. The communication between the heat-api and heat-engine uses RPC\&. -.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/ diff --git a/docs/man/man1/heat-boto.1 b/docs/man/man1/heat-boto.1 deleted file mode 100644 index 851982befb..0000000000 --- a/docs/man/man1/heat-boto.1 +++ /dev/null @@ -1,198 +0,0 @@ -'\" t -.\" Title: heat-boto -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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-boto \- perform a heat action via the heat API -.SH "SYNOPSIS" -.sp -heat-boto COMMAND [OPTIONS] -.SH "DESCRIPTION" -.sp -\fBheat-boto\fR is a tool to orchestrate the setup of multiple cloud applications\&. - -\fBheat-boto\fR is port a of the \fBheat\fR tool to use the boto client library\&. - -.SH CONFIGURATION FILES - -heat-boto uses the boto client library, which looks for configuration in /etc/boto.cfg - -heat installs a default version of this file, but you will need to update the -aws_access_key_id and aws_secret_access_key values with your real keystone credentials\&. - -Use keystone ec2-credentials-list to retrieve your keystone ec2 access keys\&. - -.SH "COMMANDS" - -.PP -\fBcreate\fP -.RS 4 -Create stack as defined in template file -.RE -.PP -\fBdelete\fP -.RS 4 -Delete specified stack -.RE -.PP -\fBdescribe\fP -.RS 4 -Provide detailed information about the specified stack, or if no arguments are given all stacks -.RE -.PP -\fBestimate-template-cost\fP -.RS 4 -Currently not implemented -.RE -.PP -\fBevent-list\fP -.RS 4 -List events related to specified stacks, or if no arguments are given all stacks -.RE -.PP -\fBgettemplate\fP -.RS 4 -Get the template for a running stack -.RE -.PP -\fBhelp\fP -.RS 4 -Provide help/usage information -.RE -.PP -\fBlist\fP -.RS 4 -List summary information for all stacks -.RE -.PP -\fBresource\fP -.RS 4 -List information about a specific resource -.RE -.PP -\fBresource-list\fP -.RS 4 -List all resources for a specified stack -.RE -.PP -\fBresource-list-details\fP -.RS 4 -List details of all resources for a specified stack or physical resource ID, optionally filtered by a logical resource ID -.RE -.PP -\fBupdate\fP -.RS 4 -Update a running stack with a modified template or template parameters - currently not implemented -.RE -.PP -\fBvalidate\fP -.RS 4 -Validate a template file syntax -.RE - -.SH "OPTIONS" -.PP -\fB\-d\fR, \fB\-\-debug\fR -.RS 4 -Enable verbose debug level output -.RE -.PP -\fB\-H\fR, \fB\-\-host\fR -.RS 4 -Specify the hostname running the heat API service -.RE -.PP -\fB\-k\fR, \fB\-\-insecure\fR -.RS 4 -Use plain HTTP instead of HTTPS -.RE -.PP -\fB\-P\fR, \fB\-\-parameters\fR -.RS 4 -Stack input parameters -.RE -.PP -\fB\-p\fR, \fB\-\-port\fR -.RS 4 -Specify the port to connect to for the heat API service -.RE -.PP -\fB\-R\fR, \fB\-\-region\fR -.RS 4 -Region name. When using keystone authentication "version 2.0 or later this identifies the region -.RE -.PP -\fB\-f\fR, \fB\-\-template\fR-file -.RS 4 -Path to file containing the stack template -.RE -.PP -\fB\-u\fR, \fB\-\-template\fR-url -.RS 4 -URL to stack template -.RE -.PP -\fB\-t\fR, \fB\-\-timeout\fR -.RS 4 -Stack creation timeout (default is 60 minutes) -.RE -.PP -\fB\-v\fR, \fB\-\-verbose\fR -.RS 4 -Enable verbose output -.RE -.PP -\fB\-y\fR, \fB\-\-yes\fR -.RS 4 -Do not prompt for confirmation, assume yes -.RE - - -.PP -.SH "USAGE EXAMPLES" -.sp - -heat-boto -d create wordpress --template-file=templates/WordPress_Single_Instance.template --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpass;KeyName=${USER}_key" - -heat-boto list - -heat-boto describe wordpress - -heat-boto resource-list wordpress - -heat-boto resource-list-details wordpress - -heat-boto resource-list-details wordpress WikiDatabase - -heat-boto resource wordpress WikiDatabase - -heat-boto event-list - -heat-boto delete wordpress - -.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: https://heat\&-api\&.org/ diff --git a/docs/man/man1/heat-cfn.1 b/docs/man/man1/heat-cfn.1 deleted file mode 100644 index ba66108982..0000000000 --- a/docs/man/man1/heat-cfn.1 +++ /dev/null @@ -1,243 +0,0 @@ -'\" t -.\" Title: heat-cfn -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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-cfn \- perform a heat action via the heat API -.SH "SYNOPSIS" -.sp -heat-cfn COMMAND [OPTIONS] -.SH "DESCRIPTION" -.sp -\fBheat-cfn\fR is a tool to orchestrate the setup of multiple cloud applications\&. - -.SH CONFIGURATION - -heat-cfn uses keystone authentication, and expects some variables to be set in -your environment, without these heat will not be able to establish an -authenticated connection with the heat API server. - -Example: -.br -export ADMIN_TOKEN= -.br -export OS_USERNAME=admin -.br -export OS_PASSWORD=verybadpass -.br -export OS_TENANT_NAME=admin -.br -export OS_AUTH_URL=http://127.0.0.1:5000/v2.0/ -.br -export OS_AUTH_STRATEGY=keystone -.br - -.SH "COMMANDS" - -.PP -\fBcreate\fP -.RS 4 -Create stack as defined in template file -.RE -.PP -\fBdelete\fP -.RS 4 -Delete specified stack -.RE -.PP -\fBdescribe\fP -.RS 4 -Provide detailed information about the specified stack, or if no arguments are given all stacks -.RE -.PP -\fBestimate-template-cost\fP -.RS 4 -Currently not implemented -.RE -.PP -\fBevent-list\fP -.RS 4 -List events related to specified stacks, or if no arguments are given all stacks -.RE -.PP -\fBgettemplate\fP -.RS 4 -Get the template for a running stack -.RE -.PP -\fBhelp\fP -.RS 4 -Provide help/usage information -.RE -.PP -\fBlist\fP -.RS 4 -List summary information for all stacks -.RE -.PP -\fBresource\fP -.RS 4 -List information about a specific resource -.RE -.PP -\fBresource-list\fP -.RS 4 -List all resources for a specified stack -.RE -.PP -\fBresource-list-details\fP -.RS 4 -List details of all resources for a specified stack or physical resource ID, optionally filtered by a logical resource ID -.RE -.PP -\fBupdate\fP -.RS 4 -Update a running stack with a modified template or template parameters - currently not implemented -.RE -.PP -\fBvalidate\fP -.RS 4 -Validate a template file syntax -.RE - -.SH "OPTIONS" -.PP -\fB\-S\fR, \fB\-\-auth_strategy\fR -.RS 4 -Authentication strategy -.RE -.PP -\fB\-A\fR, \fB\-\-auth_token\fR -.RS 4 -Authentication token to use to identify the client to the heat server -.RE -.PP -\fB\-N\fR, \fB\-\-auth_url\fR -.RS 4 -Authentication URL for keystone authentication -.RE -.PP -\fB\-d\fR, \fB\-\-debug\fR -.RS 4 -Enable verbose debug level output -.RE -.PP -\fB\-H\fR, \fB\-\-host\fR -.RS 4 -Specify the hostname running the heat API service -.RE -.PP -\fB\-k\fR, \fB\-\-insecure\fR -.RS 4 -Use plain HTTP instead of HTTPS -.RE -.PP -\fB\-P\fR, \fB\-\-parameters\fR -.RS 4 -Stack input parameters -.RE -.PP -\fB\-K\fR, \fB\-\-password\fR -.RS 4 -Password used to acquire an authentication token -.RE -.PP -\fB\-p\fR, \fB\-\-port\fR -.RS 4 -Specify the port to connect to for the heat API service -.RE -.PP -\fB\-R\fR, \fB\-\-region\fR -.RS 4 -Region name. When using keystone authentication "version 2.0 or later this identifies the region -.RE -.PP -\fB\-f\fR, \fB\-\-template\fR-file -.RS 4 -Path to file containing the stack template -.RE -.PP -\fB\-u\fR, \fB\-\-template\fR-url -.RS 4 -URL to stack template -.RE -.PP -\fB\-T\fR, \fB\-\-tenant\fR -.RS 4 -Tenant name used for Keystone authentication -.RE -.PP -\fB\-t\fR, \fB\-\-timeout\fR -.RS 4 -Stack creation timeout (default is 60 minutes) -.RE -.PP -\fB\-U\fR, \fB\-\-url\fR -.RS 4 -URL of heat service -.RE -.PP -\fB\-I\fR, \fB\-\-username\fR -.RS 4 -User name used to acquire an authentication token -.RE -.PP -\fB\-v\fR, \fB\-\-verbose\fR -.RS 4 -Enable verbose output -.RE -.PP -\fB\-y\fR, \fB\-\-yes\fR -.RS 4 -Do not prompt for confirmation, assume yes -.RE - - -.PP -.SH "USAGE EXAMPLES" -.sp - -heat-cfn -d create wordpress --template-file=templates/WordPress_Single_Instance.template --parameters="InstanceType=m1.xlarge;DBUsername=${USER};DBPassword=verybadpass;KeyName=${USER}_key" - -heat-cfn list - -heat-cfn describe wordpress - -heat-cfn resource-list wordpress - -heat-cfn resource-list-details wordpress - -heat-cfn resource-list-details wordpress WikiDatabase - -heat-cfn resource wordpress WikiDatabase - -heat-cfn event-list - -heat-cfn delete wordpress - -.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: https://heat\&-api\&.org/ diff --git a/docs/man/man1/heat-db-setup.1 b/docs/man/man1/heat-db-setup.1 deleted file mode 100644 index e99e6fda2b..0000000000 --- a/docs/man/man1/heat-db-setup.1 +++ /dev/null @@ -1,77 +0,0 @@ -'\" t -.\" Title: heat -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 03/31/2012 -.\" Manual: System administration commands -.\" Source: Heat 0.0.1 -.\" Language: English -.\" -.TH "HEAT" "1" "06/13/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-db-setup \- Setup and configure the Heat database -.SH "SYNOPSIS" -.sp -heat-db-setup -.SH "DESCRIPTION" -.sp -The \fBheat-db-setup\fR script creates the heat database on the system, -using MYSQL as a backend database. The script works on either RPM or DEB -based distributions. If the MYSQL server is not present, the user will -be prompted to install it. If the MYSQL server is not running, the user -will be prompted to start it. Once MYSQL is started, the appropriate -SQL commands will be run to instantiate the database on the system. - -.SH "OPTIONS" -.PP -\fB\platform_type\fR -.RS 4 -This required option can be either rpm or deb, which will use the appropriate -platform specific tools and packaging to instantiate the database. - -.PP -\fB\--help\fR -.RS 4 -Print usage information. - -.PP -\fB\--password \fR -.RS 4 -Specify the password for the 'heat' MySQL user that will use to connect to -the 'heat' MySQL database. By default, the password 'heat' will be used. - -.PP -\fB\--yes\fR -.RS 4 -In cases where the script would normally ask for confirmation before doing -something, such as installing mysql-server, just assume yes. This is useful -if you want to run the script non-interactively. - -.SH "BUGS" -.sp -Since Heat is in active development, occasionally the database may suffer -corruption during master updates. In this case, the heat-db-drop tool can -be used to drop the database tables and start from scratch. This application -is only shipped in the source tarball, since it will be unnecessary when Heat -is production quality and too heavyweight for a production deployment. - -.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: https://heat\&-api\&.org/ diff --git a/docs/man/man1/heat-engine.1 b/docs/man/man1/heat-engine.1 deleted file mode 100644 index 911b13ba7c..0000000000 --- a/docs/man/man1/heat-engine.1 +++ /dev/null @@ -1,43 +0,0 @@ -'\" t -.\" Title: heat -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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-engine \- The heat engine -.SH "SYNOPSIS" -.sp -heat-engine -.SH "DESCRIPTION" -.sp -\fBHeat\fR is the heat project server with an internal api called by the heat-api\&. -.RE -.PP -.SH "INVENTORY" -.sp -The heat engine does all the orchestration work and is the layer in which the resource integration is implemented\&. -.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/