x/vmtp
Code Issues Proposed changes

Update vmtp doc

Browse Source 
Change-Id: If82ad844438b9c6fff1dbfdd979e00e3d1ad187f
This commit is contained in:
Stefano Chiesa 2016-12-12 12:26:01 -08:00
parent 3d5769f7c0
commit 70985819cd
4 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/quickstart_docker.rst
View File

@ -69,7 +69,7 @@ Now that the RC file is available from the container, you can run any OpenStack
4.1. Verify flavor names
^^^^^^^^^^^^^^^^^^^^^^^^
We will check the flavor names available as we will have to select one flavor that VMTP should use to launch VM instances.
If you are planning to reuse an existing flavor, we will have to check the flavor names available to select one flavor that VMTP should use to launch VM instances.
List the flavors (results may be different):
.. code-block:: bash
@ -167,7 +167,8 @@ Edit the vmtp.cfg file and make sure the following parameters are set properly:
- "image_name" must be the image name to use by VMTP ('Ubuntu Server 14.04' in the above example)
- "ssh_vm_username" must be a valid user name for the Linux image ("ubuntu" for Ubuntu images)
- "flavor_type" must be an appropriate flavor name (step 4.1 above)
- "flavor_type" must be either an appropriate flavor name (step 4.1 above) or a custom flavor will be created with "flavor_type" name and specification declared in "flavor" config.
- "flavor" must be the specification of a custom flavor that will be created in case "flavor_type" is non-existing in OpenStack.
- "public_key_file" must point to your public key (see below)
- "private_key_file" must point to your private key (see below)

6
doc/source/quickstart_git.rst
View File

@ -106,7 +106,7 @@ In the VMTP virtual environment, you can run any OpenStack CLI command (since th
4.1. Verify flavor names
^^^^^^^^^^^^^^^^^^^^^^^^
We will check the flavor names available as we will have to select one flavor that VMTP should use to launch VM instances.
If you are planning to reuse an existing flavor, we will have to check the flavor names available to select one flavor that VMTP should use to launch VM instances.
List the flavors (results may be different):
.. code-block:: bash
@ -123,6 +123,7 @@ List the flavors (results may be different):
+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
$
Otherwise, a temporary flavor can be created for you from the config file specification (Step 5).
4.2. Upload any Linux VM image to OpenStack
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -203,7 +204,8 @@ Edit the vmtp.cfg file and make sure the following parameters are set properly:
- "image_name" must be the image name to use by VMTP ('Ubuntu Server 14.04' in the above example)
- "ssh_vm_username" must be a valid user name for the Linux image ("ubuntu" for Ubuntu images)
- "flavor_type" must be an appropriate flavor name (step 4.1 above)
- "flavor_type" must be either an appropriate flavor name (step 4.1 above) or a custom flavor will be created with "flavor_type" name and specification declared in "flavor" config.
- "flavor" must be the specification of a custom flavor that will be created in case "flavor_type" is non-existing in OpenStack.
6. Run VMTP
-----------

6
doc/source/quickstart_pip.rst
View File

@ -96,7 +96,7 @@ In the VMTP virtual environment, you can run any OpenStack CLI command (since th
4.1. Verify flavor names
^^^^^^^^^^^^^^^^^^^^^^^^
We will check the flavor names available as we will have to select one flavor that VMTP should use to launch VM instances.
If you are planning to reuse an existing flavor, we will have to check the flavor names available to select one flavor that VMTP should use to launch VM instances.
List the flavors (results may be different):
.. code-block:: bash
@ -113,6 +113,7 @@ List the flavors (results may be different):
+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
$
Otherwise, a temporary flavor can be created for you from the config file specification (Step 5).
4.2. Upload any Linux VM image to OpenStack
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -192,7 +193,8 @@ Edit the vmtp.cfg file and make sure the following parameters are set properly:
- "image_name" must be the image name to use by VMTP ('Ubuntu Server 14.04' in the above example)
- "ssh_vm_username" must be a valid user name for the Linux image ("ubuntu" for Ubuntu images)
- "flavor_type" must be an appropriate flavor name (step 4.1 above)
- "flavor_type" must be either an appropriate flavor name (step 4.1 above) or a custom flavor will be created with "flavor_type" name and specification declared in "flavor" config.
- "flavor" must be the specification of a custom flavor that will be created in case "flavor_type" is non-existing in OpenStack.
6. Run VMTP
-----------

10
vmtp/cfg.default.yaml
View File

@ -19,12 +19,16 @@ image_name: 'Ubuntu Server 14.04'
ssh_vm_username: 'ubuntu'
#ssh_vm_username: fedora
# Name of the flavor to use for the test VMs
# This name must be an exact match to a flavor name known by the target
# OpenStack deployment (as shown from 'nova flavor-list')
# Flavor name to use for all VMs created by VMTP.
# If this flavor is unspecified, flavor name will be set to default name "vmtp".
# If this flavor exists it will be re-used as-is by VMTP.
# Otherwise, a flavor with attributes specified in flavor property will be created.
flavor_type: 'vmtp'
# Custom flavor attributes
# This flavor attributes is used to create a new flavor
# if flavor_type is unspecified or doesn't exist in openstack.
# Any created flavor will be deleted after vmtp ends.
flavor:
# Number of vCPUs for the flavor
vcpus: 1