openstack/nova
Code Issues Proposed changes

Merge "doc: fix and clarify --block-device usage in user docs"

Browse Source
This commit is contained in:
Zuul 2019-02-21 00:29:11 +00:00 committed by Gerrit Code Review
commit 34e595f2a7
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/source/user/launch-instance-from-volume.rst
View File

@ -214,13 +214,14 @@ the volume to boot an instance.
Note the ID of the flavor that you want to use to create a volume.
#. To create a bootable volume from an image and launch an instance from
this volume, use the ``--block-device`` parameter.
this volume, use the ``--block-device`` parameter with the ``nova boot``
command.
For example:
.. code-block:: console
$ openstack server create --flavor FLAVOR --block-device \
$ nova boot --flavor FLAVOR --block-device \
source=SOURCE,id=ID,dest=DEST,size=SIZE,shutdown=PRESERVE,bootindex=INDEX \
NAME
@ -256,7 +257,14 @@ the volume to boot an instance.
- ``NAME``. The name for the server.
See :doc:`block-device-mapping` for more details on these parameters.
See the `nova boot`_ command documentation and :doc:`block-device-mapping`
for more details on these parameters.
.. note:: As of the Stein release, the ``openstack server create`` command
does not support creating a volume-backed server from a source image like
the ``nova boot`` command. The next steps will show how to create a
bootable volume from an image and then create a server from that boot
volume using the ``openstack server create`` command.
#. Create a bootable volume from an image. Cinder makes a volume bootable
when ``--image`` parameter is passed.
@ -306,11 +314,14 @@ the volume to boot an instance.
#. Create a VM from previously created bootable volume. The volume is not
deleted when the instance is terminated.
.. note:: The example here uses the ``--volume`` option for simplicity. The
``--block-device`` option could also be used for more granular control
over the parameters. See the `openstack server create`_ documentation for
details.
.. code-block:: console
$ openstack server create --flavor 2 --volume VOLUME_ID \
--block-device source=volume,id=$VOLUME_ID,dest=volume,size=10,shutdown=preserve,bootindex=0 \
myInstanceFromVolume
$ openstack server create --flavor 2 --volume VOLUME_ID myInstanceFromVolume
+--------------------------------------+--------------------------------+
| Field | Value |
+--------------------------------------+--------------------------------+
@ -359,6 +370,9 @@ the volume to boot an instance.
| b7d4-0fee2fe1da0c | | | | on /dev/vda |
+---------------------+-----------------+--------+------+---------------------------------+
.. _nova boot: https://docs.openstack.org/python-novaclient/latest/cli/nova.html#nova-boot
.. _openstack server create: https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/server.html#server-create
.. _Attach_swap_or_ephemeral_disk_to_an_instance:
Attach swap or ephemeral disk to an instance