Add launch-instance to install-guide
This adds the launch-instance topic from the OpenStack Installation Guide to the heat install-guide per [1], as a follow-up to [2]. Includes various minor edits. [1] http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html [2] https://review.openstack.org/#/c/325389/ Change-Id: I2bdb493f08ec1e446a2c8d52e7aea58dbee3e490 Partially-Implements: blueprint projectspecificinstallguides
This commit is contained in:
parent
feb32a8a05
commit
9ed1288198
|
@ -3,10 +3,12 @@ Orchestration service
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
get_started.rst
|
get_started.rst
|
||||||
install.rst
|
install.rst
|
||||||
verify.rst
|
verify.rst
|
||||||
|
launch-instance.rst
|
||||||
next-steps.rst
|
next-steps.rst
|
||||||
|
|
||||||
The Orchestration service (heat) uses a
|
The Orchestration service (heat) uses a
|
||||||
|
|
|
@ -13,6 +13,7 @@ Compute, Image Service, Identity.
|
||||||
Note that installation and configuration vary by distribution.
|
Note that installation and configuration vary by distribution.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
install-obs.rst
|
install-obs.rst
|
||||||
install-rdo.rst
|
install-rdo.rst
|
||||||
|
|
|
@ -0,0 +1,138 @@
|
||||||
|
.. _launch-instance:
|
||||||
|
|
||||||
|
Launch an instance
|
||||||
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
In environments that include the Orchestration service, you can create a stack
|
||||||
|
that launches an instance.
|
||||||
|
|
||||||
|
Create a template
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
The Orchestration service uses templates to describe stacks.
|
||||||
|
To learn about the template language, see `the Template Guide
|
||||||
|
<http://docs.openstack.org/developer/heat/template_guide/index.html>`__
|
||||||
|
in the `Heat developer documentation
|
||||||
|
<http://docs.openstack.org/developer/heat/index.html>`__.
|
||||||
|
|
||||||
|
* Create the ``demo-template.yml`` file with the following content:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
heat_template_version: 2015-10-15
|
||||||
|
description: Launch a basic instance with CirrOS image using the
|
||||||
|
``m1.tiny`` flavor, ``mykey`` key, and one network.
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
NetID:
|
||||||
|
type: string
|
||||||
|
description: Network ID to use for the instance.
|
||||||
|
|
||||||
|
resources:
|
||||||
|
server:
|
||||||
|
type: OS::Nova::Server
|
||||||
|
properties:
|
||||||
|
image: cirros
|
||||||
|
flavor: m1.tiny
|
||||||
|
key_name: mykey
|
||||||
|
networks:
|
||||||
|
- network: { get_param: NetID }
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
instance_name:
|
||||||
|
description: Name of the instance.
|
||||||
|
value: { get_attr: [ server, name ] }
|
||||||
|
instance_ip:
|
||||||
|
description: IP address of the instance.
|
||||||
|
value: { get_attr: [ server, first_address ] }
|
||||||
|
|
||||||
|
Create a stack
|
||||||
|
--------------
|
||||||
|
|
||||||
|
Create a stack using the ``demo-template.yml`` template.
|
||||||
|
|
||||||
|
#. Source the ``demo`` credentials to perform
|
||||||
|
the following steps as a non-administrative project:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ . demo-openrc
|
||||||
|
|
||||||
|
#. Determine available networks.
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ openstack network list
|
||||||
|
+--------------------------------------+-------------+--------------------------------------+
|
||||||
|
| ID | Name | Subnets |
|
||||||
|
+--------------------------------------+-------------+--------------------------------------+
|
||||||
|
| 4716ddfe-6e60-40e7-b2a8-42e57bf3c31c | selfservice | 2112d5eb-f9d6-45fd-906e-7cabd38b7c7c |
|
||||||
|
| b5b6993c-ddf9-40e7-91d0-86806a42edb8 | provider | 310911f6-acf0-4a47-824e-3032916582ff |
|
||||||
|
+--------------------------------------+-------------+--------------------------------------+
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
This output may differ from your environment.
|
||||||
|
|
||||||
|
#. Set the ``NET_ID`` environment variable to reflect the ID of a network.
|
||||||
|
For example, using the provider network:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ export NET_ID=$(openstack network list | awk '/ provider / { print $2 }')
|
||||||
|
|
||||||
|
#. Create a stack of one CirrOS instance on the provider network:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ openstack stack create -t demo-template.yml --parameter "NetID=$NET_ID" stack
|
||||||
|
+--------------------------------------+------------+--------------------+---------------------+--------------+
|
||||||
|
| ID | Stack Name | Stack Status | Creation Time | Updated Time |
|
||||||
|
+--------------------------------------+------------+--------------------+---------------------+--------------+
|
||||||
|
| dbf46d1b-0b97-4d45-a0b3-9662a1eb6cf3 | stack | CREATE_IN_PROGRESS | 2015-10-13T15:27:20 | None |
|
||||||
|
+--------------------------------------+------------+--------------------+---------------------+--------------+
|
||||||
|
|
||||||
|
#. After a short time, verify successful creation of the stack:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ openstack stack list
|
||||||
|
+--------------------------------------+------------+-----------------+---------------------+--------------+
|
||||||
|
| ID | Stack Name | Stack Status | Creation Time | Updated Time |
|
||||||
|
+--------------------------------------+------------+-----------------+---------------------+--------------+
|
||||||
|
| dbf46d1b-0b97-4d45-a0b3-9662a1eb6cf3 | stack | CREATE_COMPLETE | 2015-10-13T15:27:20 | None |
|
||||||
|
+--------------------------------------+------------+-----------------+---------------------+--------------+
|
||||||
|
|
||||||
|
#. Show the name and IP address of the instance and compare with the output
|
||||||
|
of the OpenStack client:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ openstack stack output show --all stack
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"output_value": "stack-server-3nzfyfofu6d4",
|
||||||
|
"description": "Name of the instance.",
|
||||||
|
"output_key": "instance_name"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"output_value": "10.4.31.106",
|
||||||
|
"description": "IP address of the instance.",
|
||||||
|
"output_key": "instance_ip"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ openstack server list
|
||||||
|
+--------------------------------------+---------------------------+--------+---------------------------------+
|
||||||
|
| ID | Name | Status | Networks |
|
||||||
|
+--------------------------------------+---------------------------+--------+---------------------------------+
|
||||||
|
| 0fc2af0c-ae79-4d22-8f36-9e860c257da5 | stack-server-3nzfyfofu6d4 | ACTIVE | public=10.4.31.106 |
|
||||||
|
+--------------------------------------+---------------------------+--------+---------------------------------+
|
||||||
|
|
||||||
|
#. Delete the stack.
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ openstack stack delete --yes stack
|
|
@ -8,3 +8,5 @@ Your OpenStack environment now includes the heat service.
|
||||||
To add more services, see the
|
To add more services, see the
|
||||||
`additional documentation on installing OpenStack <http://docs.openstack.org/#install-guides>`_ .
|
`additional documentation on installing OpenStack <http://docs.openstack.org/#install-guides>`_ .
|
||||||
|
|
||||||
|
To learn more about the heat service, read the `Heat developer documentation
|
||||||
|
<http://docs.openstack.org/developer/heat/index.html>`__.
|
||||||
|
|
Loading…
Reference in New Issue