Migrate Heat relevant docs to Heat Dashboard
To slit out Heat support from Horizon, migrate Heat relevant docs from Horizon repo to Heat Dashboard repo. Change-Id: Ie0334b8af060a8251a649a49d982086709472190
This commit is contained in:
kaz_shinohara
parent
5220939cc8
commit
1590bfeb12
@ -37,13 +37,14 @@ source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'openstack'
|
||||
project = u'Heat Dashboard'
|
||||
copyright = u'2017, OpenStack Developers'
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/openstack'
|
||||
bug_project = '../horizon'
|
||||
bug_tag = ''
|
||||
repository_name = 'openstack/heat-dashboard'
|
||||
bug_project = 'heat-dashboard'
|
||||
bug_tag = 'doc'
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
add_function_parentheses = True
|
||||
@ -77,5 +78,12 @@ latex_documents = [
|
||||
u'OpenStack Developers', 'manual'),
|
||||
]
|
||||
|
||||
man_pages = [
|
||||
('index', u'Heat Dashboard Documentation',
|
||||
'Documentation for Heat Dashboard plugin to Openstack\
|
||||
Dashboard (Horizon)',
|
||||
[u'OpenStack'], 1)
|
||||
]
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
# intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
|
||||
@ -2,9 +2,28 @@
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Heat Dashboard has no configuration option.
|
||||
Heat Dashboard has configuration option as below.
|
||||
|
||||
For more configurations, see
|
||||
`Configuration Guide <https://docs.openstack.org/horizon/latest/configuration/index.html>`_
|
||||
in the Horizon documentation.
|
||||
|
||||
OPENSTACK_HEAT_STACK
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. versionadded:: 9.0.0(Mitaka)
|
||||
|
||||
Default:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
{
|
||||
'enable_user_pass': True
|
||||
}
|
||||
|
||||
A dictionary of settings to use with heat stacks. Currently, the only setting
|
||||
available is "enable_user_pass", which can be used to disable the password
|
||||
field while launching the stack. Currently HEAT API needs user password to
|
||||
perform all the heat operations because in HEAT API trusts is not enabled by
|
||||
default. So, this setting can be set as "False" in-case HEAT uses trusts by
|
||||
default otherwise it needs to be set as "True".
|
||||
@ -1,5 +1,5 @@
|
||||
==================================
|
||||
heat-dashboard configuration guide
|
||||
Heat Dashboard configuration guide
|
||||
==================================
|
||||
|
||||
.. toctree::
|
||||
|
||||
@ -16,6 +16,7 @@ Contents:
|
||||
install/index
|
||||
contributor/index
|
||||
configuration/index
|
||||
user/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
8
doc/source/user/index.rst
Normal file
8
doc/source/user/index.rst
Normal file
@ -0,0 +1,8 @@
|
||||
=================================
|
||||
Heat Dashboard User Documentation
|
||||
=================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
stacks.rst
|
||||
149
doc/source/user/stacks.rst
Normal file
149
doc/source/user/stacks.rst
Normal file
@ -0,0 +1,149 @@
|
||||
========================
|
||||
Launch and manage stacks
|
||||
========================
|
||||
|
||||
OpenStack Orchestration is a service that you can use to
|
||||
orchestrate multiple composite cloud applications. This
|
||||
service supports the use of both the Amazon Web Services (AWS)
|
||||
CloudFormation template format through both a Query API that
|
||||
is compatible with CloudFormation and the native OpenStack
|
||||
Heat Orchestration Template (HOT) format through a REST API.
|
||||
|
||||
These flexible template languages enable application
|
||||
developers to describe and automate the deployment of
|
||||
infrastructure, services, and applications. The templates
|
||||
enable creation of most OpenStack resource types, such as
|
||||
instances, floating IP addresses, volumes, security groups,
|
||||
and users. Once created, the resources are referred to as
|
||||
stacks.
|
||||
|
||||
The template languages are described in the `Template Guide
|
||||
<https://docs.openstack.org/heat/latest/template_guide/>`_.
|
||||
|
||||
Launch a stack
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
#. Log in to the dashboard.
|
||||
#. Select the appropriate project from the drop down menu at the top left.
|
||||
#. On the :guilabel:`Project` tab, open the :guilabel:`Orchestration` tab and
|
||||
click :guilabel:`Stacks` category.
|
||||
#. Click :guilabel:`Launch Stack`.
|
||||
#. In the :guilabel:`Select Template` dialog box, specify the
|
||||
following values:
|
||||
|
||||
+---------------------------------------+-------------------------------+
|
||||
| :guilabel:`Template Source` | Choose the source of the |
|
||||
| | template from the list. |
|
||||
+---------------------------------------+-------------------------------+
|
||||
| :guilabel:`Template URL/File/Data` | Depending on the source that |
|
||||
| | you select, enter the URL, |
|
||||
| | browse to the file location, |
|
||||
| | or directly include the |
|
||||
| | template. |
|
||||
+---------------------------------------+-------------------------------+
|
||||
| :guilabel:`Environment Source` | Choose the source of the |
|
||||
| | environment from the list. |
|
||||
| | The environment files contain |
|
||||
| | additional settings for the |
|
||||
| | stack. |
|
||||
+---------------------------------------+-------------------------------+
|
||||
| :guilabel:`Environment File/Data` | Depending on the source that |
|
||||
| | you select, browse to the |
|
||||
| | file location, directly |
|
||||
| | include the environment |
|
||||
+---------------------------------------+-------------------------------+
|
||||
|
||||
#. Click :guilabel:`Next`.
|
||||
#. In the :guilabel:`Launch Stack` dialog box, specify the
|
||||
following values:
|
||||
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`Stack Name` | Enter a name to identify |
|
||||
| | the stack. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`Creation Timeout` | Specify the number of minutes |
|
||||
| :guilabel:`(minutes)` | that can elapse before the |
|
||||
| | launch of the stack times out. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`Rollback On Failure` | Select this check box if you |
|
||||
| | want the service to roll back |
|
||||
| | changes if the stack fails to |
|
||||
| | launch. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`Password for user` | Specify the password that |
|
||||
| :guilabel:`"demo"` | the default user uses when the |
|
||||
| | stack is created. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`DBUsername` | Specify the name of the |
|
||||
| | database user. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`LinuxDistribution` | Specify the Linux distribution |
|
||||
| | that is used in the stack. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`DBRootPassword` | Specify the root password for |
|
||||
| | the database. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`KeyName` | Specify the name of the key pair|
|
||||
| | to use to log in to the stack. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`DBName` | Specify the name of the |
|
||||
| | database. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`DBPassword` | Specify the password of the |
|
||||
| | database. |
|
||||
+---------------------------------+---------------------------------+
|
||||
| :guilabel:`InstanceType` | Specify the flavor for the |
|
||||
| | instance. |
|
||||
+---------------------------------+---------------------------------+
|
||||
|
||||
#. Click :guilabel:`Launch` to create a stack. The :guilabel:`Stacks`
|
||||
tab shows the stack.
|
||||
|
||||
After the stack is created, click on the stack name to see the
|
||||
following details:
|
||||
|
||||
Topology
|
||||
The topology of the stack.
|
||||
|
||||
Overview
|
||||
The parameters and details of the stack.
|
||||
|
||||
Resources
|
||||
The resources used by the stack.
|
||||
|
||||
Events
|
||||
The events related to the stack.
|
||||
|
||||
Template
|
||||
The template for the stack.
|
||||
|
||||
Manage a stack
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
#. Log in to the dashboard.
|
||||
#. Select the appropriate project from the drop down menu at the top left.
|
||||
#. On the :guilabel:`Project` tab, open the :guilabel:`Orchestration` tab and
|
||||
click :guilabel:`Stacks` category.
|
||||
#. Select the stack that you want to update.
|
||||
#. Click :guilabel:`Change Stack Template`.
|
||||
#. In the :guilabel:`Select Template` dialog box, select the
|
||||
new template source or environment source.
|
||||
#. Click :guilabel:`Next`.
|
||||
|
||||
The :guilabel:`Update Stack Parameters` window appears.
|
||||
#. Enter new values for any parameters that you want to update.
|
||||
#. Click :guilabel:`Update`.
|
||||
|
||||
Delete a stack
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
When you delete a stack, you cannot undo this action.
|
||||
|
||||
#. Log in to the dashboard.
|
||||
#. Select the appropriate project from the drop down menu at the top left.
|
||||
#. On the :guilabel:`Project` tab, open the :guilabel:`Orchestration` tab and
|
||||
click :guilabel:`Stacks` category.
|
||||
#. Select the stack that you want to delete.
|
||||
#. Click :guilabel:`Delete Stack`.
|
||||
#. In the confirmation dialog box, click :guilabel:`Delete Stack`
|
||||
to confirm the deletion.
|
||||
Loading…
Reference in New Issue
Block a user