openstack/openstack-manuals
Code Issues Proposed changes

[user-guide] Fix rst markups for user-guide files

Browse Source 
Implements: blueprint user-guides-reorganised

Change-Id: I6e777be1e22f99f839657f25962ff0eb65ead698
This commit is contained in:
venkatamahesh 2015-12-16 12:51:17 +05:30
parent 96d208e736
commit 808235cab3
23 changed files with 1182 additions and 925 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/user-guide/source/cli_access_instance_through_a_console.rst
View File

@ -25,25 +25,25 @@ Example:
To access an instance through a remote console, run the following
command:
.. code::
.. code-block:: console
$ nova get-vnc-console INSTANCE_NAME VNC_TYPE
$ nova get-vnc-console INSTANCE_NAME VNC_TYPE
The command returns a URL from which you can access your instance:
.. code::
.. code-block:: console
+--------+------------------------------------------------------------------------------+
| Type | Url |
+--------+------------------------------------------------------------------------------+
| xvpvnc | http://192.168.5.96:6081/console?token=c83ae3a3-15c4-4890-8d45-aefb494a8d6c |
+--------+------------------------------------------------------------------------------+
+--------+------------------------------------------------------------------------------+
| Type | Url |
+--------+------------------------------------------------------------------------------+
| xvpvnc | http://192.168.5.96:6081/console?token=c83ae3a3-15c4-4890-8d45-aefb494a8d6c |
+--------+------------------------------------------------------------------------------+
VNC\_TYPE can be replaced by any of the above values as connection
types.
When using SPICE to view the console of an instance, a browser plugin
can be used directly on the instance page, or the ``get-vnc-console``
can be used directly on the instance page, or the :command:`get-vnc-console`
command can be used with it, as well, by returning a token-authenticated
address, as in the example above.

129
doc/user-guide/source/cli_change_the_size_of_your_server.rst
View File

@ -5,60 +5,66 @@ Change the size of your server
Change the size of a server by changing its flavor.
#. Show information about your server, including its size, which is shown
as the value of the flavor property::
as the value of the flavor property:
$ nova show myCirrosServer
+-------------------------------------+-------------------------------------+
| Property | Value |
+-------------------------------------+-------------------------------------+
| status | ACTIVE |
| updated | 2013-07-18T15:08:20Z |
| OS-EXT-STS:task_state | None |
| OS-EXT-SRV-ATTR:host | devstack |
| key_name | None |
| image | cirros-0.3.2-x86_64-uec (397e71... |
| private network | 10.0.0.3 |
| hostId | 6e1e69b71ac9b1e6871f91e2dfc9a9b9... |
| OS-EXT-STS:vm_state | active |
| OS-EXT-SRV-ATTR:instance_name | instance-00000005 |
| OS-EXT-SRV-ATTR:hypervisor_hostname | devstack |
| flavor | m1.small (2) |
| id | 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5|
| security_groups | [{u'name': u'default'}] |
| user_id | 376744b5910b4b4da7d8e6cb483b06a8 |
| name | myCirrosServer |
| created | 2013-07-18T15:07:59Z |
| tenant_id | 66265572db174a7aa66eba661f58eb9e |
| OS-DCF:diskConfig | MANUAL |
| metadata | {u'description': u'Small test ima...|
| accessIPv4 | |
| accessIPv6 | |
| progress | 0 |
| OS-EXT-STS:power_state | 1 |
| OS-EXT-AZ:availability_zone | nova |
| config_drive | |
+-------------------------------------+-------------------------------------+
.. code-block:: console
$ nova show myCirrosServer
+-------------------------------------+-------------------------------------+
| Property | Value |
+-------------------------------------+-------------------------------------+
| status | ACTIVE |
| updated | 2013-07-18T15:08:20Z |
| OS-EXT-STS:task_state | None |
| OS-EXT-SRV-ATTR:host | devstack |
| key_name | None |
| image | cirros-0.3.2-x86_64-uec (397e71... |
| private network | 10.0.0.3 |
| hostId | 6e1e69b71ac9b1e6871f91e2dfc9a9b9... |
| OS-EXT-STS:vm_state | active |
| OS-EXT-SRV-ATTR:instance_name | instance-00000005 |
| OS-EXT-SRV-ATTR:hypervisor_hostname | devstack |
| flavor | m1.small (2) |
| id | 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5|
| security_groups | [{u'name': u'default'}] |
| user_id | 376744b5910b4b4da7d8e6cb483b06a8 |
| name | myCirrosServer |
| created | 2013-07-18T15:07:59Z |
| tenant_id | 66265572db174a7aa66eba661f58eb9e |
| OS-DCF:diskConfig | MANUAL |
| metadata | {u'description': u'Small test ima...|
| accessIPv4 | |
| accessIPv6 | |
| progress | 0 |
| OS-EXT-STS:power_state | 1 |
| OS-EXT-AZ:availability_zone | nova |
| config_drive | |
+-------------------------------------+-------------------------------------+
The size (flavor) of the server is ``m1.small (2)``.
#. List the available flavors with the following command::
#. List the available flavors with the following command:
$ nova flavor-list
+-----+-----------+-----------+------+-----------+------+-------+-------------+----------+
| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public|
+-----+-----------+-----------+------+-----------+------+-------+-------------+----------+
| 1 | m1.tiny | 512 | 1 | 0 | | 1 | 1.0 | True |
| 2 | m1.small | 2048 | 20 | 0 | | 1 | 1.0 | True |
| 3 | m1.medium | 4096 | 40 | 0 | | 2 | 1.0 | True |
| 4 | m1.large | 8192 | 80 | 0 | | 4 | 1.0 | True |
| 5 | m1.xlarge | 16384 | 160 | 0 | | 8 | 1.0 | True |
+-----+-----------+-----------+------+-----------+------+-------+-------------+----------+
.. code-block:: console
#. To resize the server, use the ``nova resize`` command and add the server
ID or name and the new flavor. Include the ``--poll`` parameter to display
the resize progress. For example::
$ nova flavor-list
+-----+-----------+-----------+------+-----------+------+-------+-------------+----------+
| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public|
+-----+-----------+-----------+------+-----------+------+-------+-------------+----------+
| 1 | m1.tiny | 512 | 1 | 0 | | 1 | 1.0 | True |
| 2 | m1.small | 2048 | 20 | 0 | | 1 | 1.0 | True |
| 3 | m1.medium | 4096 | 40 | 0 | | 2 | 1.0 | True |
| 4 | m1.large | 8192 | 80 | 0 | | 4 | 1.0 | True |
| 5 | m1.xlarge | 16384 | 160 | 0 | | 8 | 1.0 | True |
+-----+-----------+-----------+------+-----------+------+-------+-------------+----------+
$ nova resize myCirrosServer 4 --poll
#. To resize the server, use the :command:`nova resize` command and add
the server ID or name and the new flavor. Include the :option:`--poll`
parameter to display the resize progress. For example:
.. code-block:: console
$ nova resize myCirrosServer 4 --poll
Instance resizing... 100% complete
Finished
@ -70,7 +76,7 @@ Change the size of a server by changing its flavor.
is powered off and the instance is resized.
The shutdown behavior is configured by the
``shutdown_timeout`` parameter that can be set in the
:file:`nova.conf` file. Its value stands for the overall
``nova.conf`` file. Its value stands for the overall
period (in seconds) a guest operation system is allowed
to complete the shutdown. The default timeout is 60 seconds.
See `Description of Compute configuration options
@ -82,27 +88,32 @@ Change the size of a server by changing its flavor.
setting allowing different types of operating systems to specify
how much time they need to shut down cleanly.
#. Show the status for your server::
#. Show the status for your server.
$ nova list
+----------------------+----------------+--------+-----------------------------------------+
| ID | Name | Status | Networks |
+----------------------+----------------+--------+-----------------------------------------+
| 84c6e57d-a6b1-44b... | myCirrosServer | RESIZE | private=172.16.101.6, public=10.4.113.6 |
+----------------------+----------------+--------+-----------------------------------------+
.. code-block:: console
$ nova list
+----------------------+----------------+--------+-----------------------------------------+
| ID | Name | Status | Networks |
+----------------------+----------------+--------+-----------------------------------------+
| 84c6e57d-a6b1-44b... | myCirrosServer | RESIZE | private=172.16.101.6, public=10.4.113.6 |
+----------------------+----------------+--------+-----------------------------------------+
When the resize completes, the status becomes VERIFY\_RESIZE.
#. Confirm the resize,for example::
#. Confirm the resize,for example:
$ nova resize-confirm 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5
.. code-block:: console
$ nova resize-confirm 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5
The server status becomes ACTIVE.
#. If the resize fails or does not work as expected, you can revert the
resize. For example::
resize. For example:
.. code-block:: console
$ nova resize-revert 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5
$ nova resize-revert 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5
The server status becomes ACTIVE.

60
doc/user-guide/source/cli_config_drive.rst
View File

@ -80,7 +80,9 @@ Enable and access the configuration drive
The following example enables the configuration drive and passes user
data, two files, and two key/value metadata pairs, all of which are
accessible from the configuration drive::
accessible from the configuration drive:
.. code-block:: console
$ nova boot --config-drive true --image my-image-name --key-name mykey \
--flavor 1 --user-data ./my-user-data.txt myinstance \
@ -90,7 +92,9 @@ Enable and access the configuration drive
You can also configure the Compute service to always create a
configuration drive by setting the following option in the
:file:`/etc/nova/nova.conf` file::
``/etc/nova/nova.conf`` file:
.. code-block:: console
force_config_drive=true
@ -104,7 +108,9 @@ Enable and access the configuration drive
can mount the configuration drive as the
``/dev/disk/by-label/configurationDriveVolumeLabel`` device. In the
following example, the configuration drive has the ``config-2``
volume label::
volume label:
.. code-block:: console
# mkdir -p /mnt/config
# mount /dev/disk/by-label/config-2 /mnt/config
@ -122,21 +128,23 @@ Enable and access the configuration drive
the CirrOS image with the ``m1.tiny`` flavor, the device is
``/dev/vdb``:
.. code::
.. code-block:: console
# blkid -t LABEL="config-2" -odevice
.. code::
.. code-block:: console
/dev/vdb
Once identified, you can mount the device::
Once identified, you can mount the device:
.. code-block:: console
# mkdir -p /mnt/config
# mount /dev/vdb /mnt/config
Configuration drive contents
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------------------
In this example, the contents of the configuration drive are as follows::
@ -156,14 +164,14 @@ The files that appear on the configuration drive depend on the arguments
that you pass to the :command:`nova boot` command.
OpenStack metadata format
^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------
The following example shows the contents of the
:file:`openstack/2012-08-10/meta_data.json` and
:file:`openstack/latest/meta_data.json` files. These files are identical.
``openstack/2012-08-10/meta_data.json`` and
``openstack/latest/meta_data.json`` files. These files are identical.
The file contents are formatted for readability.
.. code::
.. code-block:: json
{
"availability_zone": "nova",
@ -193,19 +201,19 @@ The file contents are formatted for readability.
Note the effect of the
``--file /etc/network/interfaces=/home/myuser/instance-interfaces``
argument that was passed to the :command:`nova boot` command. The contents of
this file are contained in the :file:`openstack/content/0000` file on the
this file are contained in the ``openstack/content/0000`` file on the
configuration drive, and the path is specified as
:file:`/etc/network/interfaces` in the :file:`meta_data.json` file.
``/etc/network/interfaces`` in the ``meta_data.json`` file.
EC2 metadata format
^^^^^^^^^^^^^^^^^^^
-------------------
The following example shows the contents of the
:file:`ec2/2009-04-04/meta-data.json` and the :file:`ec2/latest/meta-data.json`
``ec2/2009-04-04/meta-data.json`` and the ``ec2/latest/meta-data.json``
files. These files are identical. The file contents are formatted to
improve readability.
.. code::
.. code-block:: json
{
"ami-id": "ami-00000001",
@ -242,25 +250,29 @@ improve readability.
}
User data
^^^^^^^^^
---------
The :file:`openstack/2012-08-10/user_data`, :file:`openstack/latest/user_data`,
:file:`ec2/2009-04-04/user-data`, and :file:`ec2/latest/user-data` file are
The ``openstack/2012-08-10/user_data``, ``openstack/latest/user_data``,
``ec2/2009-04-04/user-data``, and ``ec2/latest/user-data`` file are
present only if the ``--user-data`` flag and the contents of the user
data file are passed to the :command:`nova boot` command.
Configuration drive format
^^^^^^^^^^^^^^^^^^^^^^^^^^
--------------------------
The default format of the configuration drive as an ISO 9660 file
system. To explicitly specify the ISO 9660 format, add the following
line to the :file:`/etc/nova/nova.conf` file::
line to the ``/etc/nova/nova.conf`` file:
.. code-block:: console
config_drive_format=iso9660
By default, you cannot attach the configuration drive image as a CD
drive instead of as a disk drive. To attach a CD drive, add the
following line to the :file:`/etc/nova/nova.conf` file::
following line to the ``/etc/nova/nova.conf`` file:
.. code-block:: console
config_drive_cdrom=true
@ -268,7 +280,9 @@ For legacy reasons, you can configure the configuration drive to use
VFAT format instead of ISO 9660. It is unlikely that you would require
VFAT format because ISO 9660 is widely supported across operating
systems. However, to use the VFAT format, add the following line to the
:file:`/etc/nova/nova.conf` file::
``/etc/nova/nova.conf`` file:
.. code-block:: console
config_drive_format=vfat

313
doc/user-guide/source/cli_create_and_manage_networks.rst
View File

@ -4,78 +4,84 @@ Create and manage networks
Before you run commands, set the following environment variables:
.. code:: bash
.. code-block:: bash
export OS_USERNAME=admin
export OS_PASSWORD=password
export OS_TENANT_NAME=admin
export OS_AUTH_URL=http://localhost:5000/v2.0
export OS_USERNAME=admin
export OS_PASSWORD=password
export OS_TENANT_NAME=admin
export OS_AUTH_URL=http://localhost:5000/v2.0
Create networks
~~~~~~~~~~~~~~~
#. List the extensions of the system::
#. List the extensions of the system:
$ neutron ext-list -c alias -c name
.. code-block:: console
+-----------------+--------------------------+
| alias | name |
+-----------------+--------------------------+
| agent_scheduler | Agent Schedulers |
| binding | Port Binding |
| quotas | Quota management support |
| agent | agent |
| provider | Provider Network |
| router | Neutron L3 Router |
| lbaas | LoadBalancing service |
| extraroute | Neutron Extra Route |
+-----------------+--------------------------+
$ neutron ext-list -c alias -c name
#. Create a network::
+-----------------+--------------------------+
| alias | name |
+-----------------+--------------------------+
| agent_scheduler | Agent Schedulers |
| binding | Port Binding |
| quotas | Quota management support |
| agent | agent |
| provider | Provider Network |
| router | Neutron L3 Router |
| lbaas | LoadBalancing service |
| extraroute | Neutron Extra Route |
+-----------------+--------------------------+
$ neutron net-create net1
#. Create a network:
Created a new network:
+---------------------------+--------------------------------------+
| Field | Value |
+---------------------------+--------------------------------------+
| admin_state_up | True |
| id | 2d627131-c841-4e3a-ace6-f2dd75773b6d |
| name | net1 |
| provider:network_type | vlan |
| provider:physical_network | physnet1 |
| provider:segmentation_id | 1001 |
| router:external | False |
| shared | False |
| status | ACTIVE |
| subnets | |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+---------------------------+--------------------------------------+
.. code-block:: console
$ neutron net-create net1
Created a new network:
+---------------------------+--------------------------------------+
| Field | Value |
+---------------------------+--------------------------------------+
| admin_state_up | True |
| id | 2d627131-c841-4e3a-ace6-f2dd75773b6d |
| name | net1 |
| provider:network_type | vlan |
| provider:physical_network | physnet1 |
| provider:segmentation_id | 1001 |
| router:external | False |
| shared | False |
| status | ACTIVE |
| subnets | |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+---------------------------+--------------------------------------+
.. note::
Some fields of the created network are invisible to non-admin users.
Some fields of the created network are invisible to non-admin users.
#. Create a network with specified provider network type::
#. Create a network with specified provider network type.
$ neutron net-create net2 --provider:network-type local
.. code-block:: console
Created a new network:
+---------------------------+--------------------------------------+
| Field | Value |
+---------------------------+--------------------------------------+
| admin_state_up | True |
| id | 524e26ea-fad4-4bb0-b504-1ad0dc770e7a |
| name | net2 |
| provider:network_type | local |
| provider:physical_network | |
| provider:segmentation_id | |
| router:external | False |
| shared | False |
| status | ACTIVE |
| subnets | |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+---------------------------+--------------------------------------+
$ neutron net-create net2 --provider:network-type local
Created a new network:
+---------------------------+--------------------------------------+
| Field | Value |
+---------------------------+--------------------------------------+
| admin_state_up | True |
| id | 524e26ea-fad4-4bb0-b504-1ad0dc770e7a |
| name | net2 |
| provider:network_type | local |
| provider:physical_network | |
| provider:segmentation_id | |
| router:external | False |
| shared | False |
| status | ACTIVE |
| subnets | |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+---------------------------+--------------------------------------+
Just as shown previously, the unknown option ``--provider:network-type``
is used to create a ``local`` provider network.
@ -83,26 +89,28 @@ Create networks
Create subnets
~~~~~~~~~~~~~~
Create a subnet::
Create a subnet:
$ neutron subnet-create net1 192.168.2.0/24 --name subnet1
.. code-block:: console
Created a new subnet:
+------------------+--------------------------------------------------+
| Field | Value |
+------------------+--------------------------------------------------+
| allocation_pools | {"start": "192.168.2.2", "end": "192.168.2.254"} |
| cidr | 192.168.2.0/24 |
| dns_nameservers | |
| enable_dhcp | True |
| gateway_ip | 192.168.2.1 |
| host_routes | |
| id | 15a09f6c-87a5-4d14-b2cf-03d97cd4b456 |
| ip_version | 4 |
| name | subnet1 |
| network_id | 2d627131-c841-4e3a-ace6-f2dd75773b6d |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+------------------+--------------------------------------------------+
$ neutron subnet-create net1 192.168.2.0/24 --name subnet1
Created a new subnet:
+------------------+--------------------------------------------------+
| Field | Value |
+------------------+--------------------------------------------------+
| allocation_pools | {"start": "192.168.2.2", "end": "192.168.2.254"} |
| cidr | 192.168.2.0/24 |
| dns_nameservers | |
| enable_dhcp | True |
| gateway_ip | 192.168.2.1 |
| host_routes | |
| id | 15a09f6c-87a5-4d14-b2cf-03d97cd4b456 |
| ip_version | 4 |
| name | subnet1 |
| network_id | 2d627131-c841-4e3a-ace6-f2dd75773b6d |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+------------------+--------------------------------------------------+
The ``subnet-create`` command has the following positional and optional
parameters:
@ -129,35 +137,41 @@ Guide <http://docs.openstack.org/admin-guide-cloud/networking_use.html#advanced-
Create routers
~~~~~~~~~~~~~~
#. Create a router::
#. Create a router:
$ neutron router-create router1
.. code-block:: console
Created a new router:
+-----------------------+--------------------------------------+
| Field | Value |
+-----------------------+--------------------------------------+
| admin_state_up | True |
| external_gateway_info | |
| id | 6e1f11ed-014b-4c16-8664-f4f615a3137a |
| name | router1 |
| status | ACTIVE |
| tenant_id | 7b5970fbe7724bf9b74c245e66b92abf |
+-----------------------+--------------------------------------+
$ neutron router-create router1
Created a new router:
+-----------------------+--------------------------------------+
| Field | Value |
+-----------------------+--------------------------------------+
| admin_state_up | True |
| external_gateway_info | |
| id | 6e1f11ed-014b-4c16-8664-f4f615a3137a |
| name | router1 |
| status | ACTIVE |
| tenant_id | 7b5970fbe7724bf9b74c245e66b92abf |
+-----------------------+--------------------------------------+
Take note of the unique router identifier returned, this will be
required in subsequent steps.
#. Link the router to the external provider network::
#. Link the router to the external provider network:
$ neutron router-gateway-set ROUTER NETWORK
.. code-block:: console
$ neutron router-gateway-set ROUTER NETWORK
Replace ROUTER with the unique identifier of the router, replace NETWORK
with the unique identifier of the external provider network.
#. Link the router to the subnet::
#. Link the router to the subnet:
$ neutron router-interface-add ROUTER SUBNET
.. code-block:: console
$ neutron router-interface-add ROUTER SUBNET
Replace ROUTER with the unique identifier of the router, replace SUBNET
with the unique identifier of the subnet.
@ -165,31 +179,33 @@ Create routers
Create ports
~~~~~~~~~~~~
#. Create a port with specified IP address::
#. Create a port with specified IP address:
$ neutron port-create net1 --fixed-ip ip_address=192.168.2.40
.. code-block:: console
Created a new port:
+----------------------+----------------------------------------------------------------------+
| Field | Value |
+----------------------+----------------------------------------------------------------------+
| admin_state_up | True |
| binding:capabilities | {"port_filter": false} |
| binding:vif_type | ovs |
| device_id | |
| device_owner | |
| fixed_ips | {"subnet_id": "15a09f6c-87a5-4d14-b2cf-03d97cd4b456", "ip_address... |
| id | f7a08fe4-e79e-4b67-bbb8-a5002455a493 |
| mac_address | fa:16:3e:97:e0:fc |
| name | |
| network_id | 2d627131-c841-4e3a-ace6-f2dd75773b6d |
| status | DOWN |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+----------------------+----------------------------------------------------------------------+
$ neutron port-create net1 --fixed-ip ip_address=192.168.2.40
Created a new port:
+----------------------+----------------------------------------------------------------------+
| Field | Value |
+----------------------+----------------------------------------------------------------------+
| admin_state_up | True |
| binding:capabilities | {"port_filter": false} |
| binding:vif_type | ovs |
| device_id | |
| device_owner | |
| fixed_ips | {"subnet_id": "15a09f6c-87a5-4d14-b2cf-03d97cd4b456", "ip_address... |
| id | f7a08fe4-e79e-4b67-bbb8-a5002455a493 |
| mac_address | fa:16:3e:97:e0:fc |
| name | |
| network_id | 2d627131-c841-4e3a-ace6-f2dd75773b6d |
| status | DOWN |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+----------------------+----------------------------------------------------------------------+
In the previous command, ``net1`` is the network name, which is a
positional argument. ``--fixed-ip ip_address=192.168.2.40`` is an option,
which specifies the port's fixed IP address we wanted.
positional argument. :option:`--fixed-ip ip_address=192.168.2.40` is
an option which specifies the port's fixed IP address we wanted.
.. note::
@ -197,49 +213,54 @@ Create ports
subnet even if the address is not in a pre-defined pool of allocated
IP addresses (set by your cloud provider).
#. Create a port without specified IP address::
#. Create a port without specified IP address:
$ neutron port-create net1
.. code-block:: console
Created a new port:
+----------------------+----------------------------------------------------------------------+
| Field | Value |
+----------------------+----------------------------------------------------------------------+
| admin_state_up | True |
| binding:capabilities | {"port_filter": false} |
| binding:vif_type | ovs |
| device_id | |
| device_owner | |
| fixed_ips | {"subnet_id": "15a09f6c-87a5-4d14-b2cf-03d97cd4b456", "ip_address... |
| id | baf13412-2641-4183-9533-de8f5b91444c |
| mac_address | fa:16:3e:f6:ec:c7 |
| name | |
| network_id | 2d627131-c841-4e3a-ace6-f2dd75773b6d |
| status | DOWN |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+----------------------+----------------------------------------------------------------------+
$ neutron port-create net1
Created a new port:
+----------------------+----------------------------------------------------------------------+
| Field | Value |
+----------------------+----------------------------------------------------------------------+
| admin_state_up | True |
| binding:capabilities | {"port_filter": false} |
| binding:vif_type | ovs |
| device_id | |
| device_owner | |
| fixed_ips | {"subnet_id": "15a09f6c-87a5-4d14-b2cf-03d97cd4b456", "ip_address... |
| id | baf13412-2641-4183-9533-de8f5b91444c |
| mac_address | fa:16:3e:f6:ec:c7 |
| name | |
| network_id | 2d627131-c841-4e3a-ace6-f2dd75773b6d |
| status | DOWN |
| tenant_id | 3671f46ec35e4bbca6ef92ab7975e463 |
+----------------------+----------------------------------------------------------------------+
.. note::
Note that the system allocates one IP address if you do not specify
an IP address in the ``neutron port-create`` command.
Note that the system allocates one IP address if you do not specify
an IP address in the :command:`neutron port-create` command.
#. Query ports with specified fixed IP addresses::
#. Query ports with specified fixed IP addresses:
$ neutron port-list --fixed-ips ip_address=192.168.2.2 \
ip_address=192.168.2.40
.. code-block:: console
+----------------+------+-------------------+-------------------------------------------------+
| id | name | mac_address | fixed_ips |
+----------------+------+-------------------+-------------------------------------------------+
| baf13412-26... | | fa:16:3e:f6:ec:c7 | {"subnet_id"... ..."ip_address": "192.168.2.2"} |
| f7a08fe4-e7... | | fa:16:3e:97:e0:fc | {"subnet_id"... ..."ip_address": "192.168.2.40"}|
+----------------+------+-------------------+-------------------------------------------------+
$ neutron port-list --fixed-ips ip_address=192.168.2.2 \
ip_address=192.168.2.40
``--fixed-ips ip_address=192.168.2.2 ip_address=192.168.2.40`` is one
unknown option.
+----------------+------+-------------------+-------------------------------------------------+
| id | name | mac_address | fixed_ips |
+----------------+------+-------------------+-------------------------------------------------+
| baf13412-26... | | fa:16:3e:f6:ec:c7 | {"subnet_id"... ..."ip_address": "192.168.2.2"} |
| f7a08fe4-e7... | | fa:16:3e:97:e0:fc | {"subnet_id"... ..."ip_address": "192.168.2.40"}|
+----------------+------+-------------------+-------------------------------------------------+
:option:`--fixed-ips ip_address=192.168.2.2 ip_address=192.168.2.40` is one
unknown option.
**How to find unknown options**
The unknown options can be easily found by watching the output of
``create_xxx`` or ``show_xxx`` command. For example, in the port creation
command, we see the fixed\_ips fields, which can be used as an unknown option.
:command:`create_xxx` or :command:`show_xxx` command. For example,
in the port creation command, we see the fixed\_ips fields, which
can be used as an unknown option.

43
doc/user-guide/source/cli_delete_an_instance.rst
View File

@ -4,35 +4,40 @@ Delete an instance
When you no longer need an instance, you can delete it.
#. List all instances::
#. List all instances:
.. code-block:: console
$ nova list
+-------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+-------------+----------------------+--------+------------+-------------+------------------+
| 84c6e57d... | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 |
| 8a99547e... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
| d7efd3e4... | newServer | ERROR | None | NOSTATE | |
+-------------+----------------------+--------+------------+-------------+------------------+
$ nova list
+-------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+-------------+----------------------+--------+------------+-------------+------------------+
| 84c6e57d... | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 |
| 8a99547e... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
| d7efd3e4... | newServer | ERROR | None | NOSTATE | |
+-------------+----------------------+--------+------------+-------------+------------------+
#. Run the :command:`nova delete` command to delete the instance. The following
example shows deletion of the ``newServer`` instance, which is in
``ERROR`` state::
``ERROR`` state:
$ nova delete newServer
.. code-block:: console
$ nova delete newServer
The command does not notify that your server was deleted.
#. To verify that the server was deleted, run the :command:`nova list`
command::
command:
$ nova list
+-------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+-------------+----------------------+--------+------------+-------------+------------------+
| 84c6e57d... | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 |
| 8a99547e... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
+-------------+----------------------+--------+------------+-------------+------------------+
.. code-block:: console
$ nova list
+-------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+-------------+----------------------+--------+------------+-------------+------------------+
| 84c6e57d... | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 |
| 8a99547e... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
+-------------+----------------------+--------+------------+-------------+------------------+
The deleted instance does not appear in the list.

204
doc/user-guide/source/cli_launch_instances.rst
View File

@ -54,14 +54,14 @@ Before you can launch an instance, gather the following parameters:
.. note::
Instances that use the default security group cannot, by default, be
accessed from any IP address outside of the cloud. If you want those
IP addresses to access the instances, you must modify the rules for
the default security group.
Instances that use the default security group cannot, by default, be
accessed from any IP address outside of the cloud. If you want those
IP addresses to access the instances, you must modify the rules for
the default security group.
You can also assign a floating IP address to a running instance to
make it accessible from outside the cloud. See
:doc:`cli_manage_ip_addresses`.
You can also assign a floating IP address to a running instance to
make it accessible from outside the cloud. See
:doc:`cli_manage_ip_addresses`.
After you gather the parameters that you need to launch an instance,
you can launch it from an image_ or a :ref:`volume`. You can launch an
@ -75,9 +75,11 @@ Gather parameters to launch an instance
Before you begin, source the OpenStack RC file.
#. List the available flavors::
#. List the available flavors.
$ nova flavor-list
.. code-block:: console
$ nova flavor-list
Note the ID of the flavor that you want to use for your instance::
@ -91,9 +93,11 @@ Before you begin, source the OpenStack RC file.
| 5 | m1.xlarge | 16384 | 160 | 0 | | 8 | 1.0 | True |
+-----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
#. List the available images::
#. List the available images.
$ nova image-list
.. code-block:: console
$ nova image-list
Note the ID of the image from which you want to boot your instance::
@ -105,21 +109,25 @@ Before you begin, source the OpenStack RC file.
| 3cf852bd-2332-48f4-9ae4-7d926d50945e | cirros-0.3.2-x86_64-uec-ramdisk | ACTIVE | |
+--------------------------------------+---------------------------------+--------+--------+
You can also filter the image list by using ``grep`` to find a specific
image, as follows::
You can also filter the image list by using :command:`grep` to find a specific
image, as follows:
$ nova image-list | grep 'kernel'
.. code-block:: console
| df430cc2-3406-4061-b635-a51c16e488ac | cirros-0.3.2-x86_64-uec-kernel | ACTIVE | |
$ nova image-list | grep 'kernel'
#. List the available security groups::
| df430cc2-3406-4061-b635-a51c16e488ac | cirros-0.3.2-x86_64-uec-kernel | ACTIVE | |
$ nova secgroup-list --all-tenants
#. List the available security groups.
.. code-block:: console
$ nova secgroup-list --all-tenants
.. note::
If you are an admin user, specify the ``--all-tenants`` parameter to
list groups for all tenants.
If you are an admin user, specify the :option:`--all-tenants` parameter to
list groups for all tenants.
@ -136,14 +144,18 @@ Before you begin, source the OpenStack RC file.
If you have not created any security groups, you can assign the instance
to only the default security group.
You can view rules for a specified security group::
You can view rules for a specified security group:
$ nova secgroup-list-rules default
.. code-block:: console
$ nova secgroup-list-rules default
#. List the available key pairs, and note the key pair name that you use for
SSH access::
SSH access.
$ nova keypair-list
.. code-block:: console
$ nova keypair-list
.. _image:
@ -151,11 +163,13 @@ Launch an instance from an image
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. After you gather required parameters, run the following command to
launch an instance. Specify the server name, flavor ID, and image ID::
launch an instance. Specify the server name, flavor ID, and image ID.
$ nova boot --flavor FLAVOR_ID --image IMAGE_ID --key-name KEY_NAME \
--user-data USER_DATA_FILE --security-groups SEC_GROUP_NAME --meta KEY=VALUE \
INSTANCE_NAME
.. code-block:: console
$ nova boot --flavor FLAVOR_ID --image IMAGE_ID --key-name KEY_NAME \
--user-data USER_DATA_FILE --security-groups SEC_GROUP_NAME --meta KEY=VALUE \
INSTANCE_NAME
Optionally, you can provide a key name for access control and a security
group for security. You can also include metadata key and value pairs.
@ -166,54 +180,58 @@ Launch an instance from an image
``--user-data USER-DATA-FILE`` parameter.
.. important::
If you boot an instance with an INSTANCE_NAME greater than 63 characters,
Compute truncates it automatically when turning it into a hostname to
ensure the correct work of dnsmasq. The corresponding warning is written
into the nova-network.log file.
If you boot an instance with an INSTANCE_NAME greater than 63 characters,
Compute truncates it automatically when turning it into a host name to
ensure the correct work of dnsmasq. The corresponding warning is written
into the ``nova-network.log`` file.
The following command launches the ``MyCirrosServer`` instance with the
``m1.small`` flavor (ID of ``1``), ``cirros-0.3.2-x86_64-uec`` image (ID
of ``397e713c-b95b-4186-ad46-6126863ea0a9``), ``default`` security
group, ``KeyPair01`` key, and a user data file called
``cloudinit.file``::
``cloudinit.file``:
$ nova boot --flavor 1 --image 397e713c-b95b-4186-ad46-6126863ea0a9 \
--security-groups default --key-name KeyPair01 --user-data cloudinit.file \
myCirrosServer
.. code-block:: console
$ nova boot --flavor 1 --image 397e713c-b95b-4186-ad46-6126863ea0a9 \
--security-groups default --key-name KeyPair01 --user-data cloudinit.file \
myCirrosServer
Depending on the parameters that you provide, the command returns a list
of server properties::
of server properties.
.. code-block:: console
+-------------------------------------+-------------------------------------+
| Property | Value |
+-------------------------------------+-------------------------------------+
| OS-EXT-STS:task_state | scheduling |
| image | cirros-0.3.2-x86_64-uec |
| OS-EXT-STS:vm_state | building |
| OS-EXT-SRV-ATTR:instance_name | instance-00000002 |
| flavor | m1.small |
| id | b3cdc6c0-85a7-4904-ae85-71918f734048|
| security_groups | [{u'name': u'default'}] |
| user_id | 376744b5910b4b4da7d8e6cb483b06a8 |
| OS-DCF:diskConfig | MANUAL |
| accessIPv4 | |
| accessIPv6 | |
| progress | 0 |
| OS-EXT-STS:power_state | 0 |
| OS-EXT-AZ:availability_zone | nova |
| config_drive | |
| status | BUILD |
| updated | 2013-07-16T16:25:34Z |
| hostId | |
| OS-EXT-SRV-ATTR:host | None |
| key_name | KeyPair01 |
| OS-EXT-SRV-ATTR:hypervisor_hostname | None |
| name | myCirrosServer |
| adminPass | tVs5pL8HcPGw |
| tenant_id | 66265572db174a7aa66eba661f58eb9e |
| created | 2013-07-16T16:25:34Z |
| metadata | {u'KEY': u'VALUE'} |
+-------------------------------------+-------------------------------------+
+-------------------------------------+-------------------------------------+
| Property | Value |
+-------------------------------------+-------------------------------------+
| OS-EXT-STS:task_state | scheduling |
| image | cirros-0.3.2-x86_64-uec |
| OS-EXT-STS:vm_state | building |
| OS-EXT-SRV-ATTR:instance_name | instance-00000002 |
| flavor | m1.small |
| id | b3cdc6c0-85a7-4904-ae85-71918f734048|
| security_groups | [{u'name': u'default'}] |
| user_id | 376744b5910b4b4da7d8e6cb483b06a8 |
| OS-DCF:diskConfig | MANUAL |
| accessIPv4 | |
| accessIPv6 | |
| progress | 0 |
| OS-EXT-STS:power_state | 0 |
| OS-EXT-AZ:availability_zone | nova |
| config_drive | |
| status | BUILD |
| updated | 2013-07-16T16:25:34Z |
| hostId | |
| OS-EXT-SRV-ATTR:host | None |
| key_name | KeyPair01 |
| OS-EXT-SRV-ATTR:hypervisor_hostname | None |
| name | myCirrosServer |
| adminPass | tVs5pL8HcPGw |
| tenant_id | 66265572db174a7aa66eba661f58eb9e |
| created | 2013-07-16T16:25:34Z |
| metadata | {u'KEY': u'VALUE'} |
+-------------------------------------+-------------------------------------+
A status of ``BUILD`` indicates that the instance has started, but is
not yet online.
@ -228,43 +246,49 @@ Launch an instance from an image
.. note::
You can also place arbitrary local files into the instance file
system at creation time by using the ``--file <dst-path=src-path>``
option. You can store up to five files. For example, if you have a
special authorized keys file named ``special_authorized_keysfile`` that
you want to put on the instance rather than using the regular SSH key
injection, you can use the ``--file`` option as shown in the following
example.
You can also place arbitrary local files into the instance file
system at creation time by using the ``--file <dst-path=src-path>``
option. You can store up to five files. For example, if you have a
special authorized keys file named ``special_authorized_keysfile`` that
you want to put on the instance rather than using the regular SSH key
injection, you can use the :option:`--file` option as shown in the following
example.
.. code::
.. code-block:: console
$ nova boot --image ubuntu-cloudimage --flavor 1 vm-name \
--file /root/.ssh/authorized_keys=special_authorized_keysfile
$ nova boot --image ubuntu-cloudimage --flavor 1 vm-name \
--file /root/.ssh/authorized_keys=special_authorized_keysfile
4. Check if the instance is online::
4. Check if the instance is online.
$ nova list
.. code-block:: console
$ nova list
The list shows the ID, name, status, and private (and if assigned,
public) IP addresses for all instances in the project to which you
belong::
belong:
+-------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+-------------+----------------------+--------+------------+-------------+------------------+
| 84c6e57d... | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 |
| 8a99547e... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
+-------------+----------------------+--------+------------+-------------+------------------+
.. code-block:: console
+-------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+-------------+----------------------+--------+------------+-------------+------------------+
| 84c6e57d... | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 |
| 8a99547e... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
+-------------+----------------------+--------+------------+-------------+------------------+
If the status for the instance is ACTIVE, the instance is online.
#. To view the available options for the :command:`nova list` command, run the
following command::
following command:
$ nova help list
.. code-block:: console
$ nova help list
.. note::
If you did not provide a key pair, security groups, or rules, you
can access the instance only from inside the cloud through VNC. Even
pinging the instance is not possible.
If you did not provide a key pair, security groups, or rules, you
can access the instance only from inside the cloud through VNC. Even
pinging the instance is not possible.

134
doc/user-guide/source/cli_manage_bare_metal_nodes.rst
View File

@ -49,35 +49,35 @@ When you create a bare-metal node, your PM address, user name, and
password should match the information in your hardware's BIOS/IPMI
configuration.
.. code::
.. code-block:: console
$ nova baremetal-node-create --pm_address PM_ADDRESS --pm_user PM_USERNAME \
--pm_password PM_PASSWORD $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff
$ nova baremetal-node-create --pm_address PM_ADDRESS --pm_user PM_USERNAME \
--pm_password PM_PASSWORD $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff
The following example shows the command and results from creating a node
with the PM address ``1.2.3.4``, the PM user name ipmi, and password
``ipmi``.
.. code::
.. code-block:: console
$ nova baremetal-node-create --pm_address 1.2.3.4 --pm_user ipmi \
--pm_password ipmi $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff
+------------------+-------------------+
| Property | Value |
+------------------+-------------------+
| instance_uuid | None |
| pm_address | 1.2.3.4 |
| interfaces | [] |
| prov_vlan_id | None |
| cpus | 1 |
| memory_mb | 512 |
| prov_mac_address | aa:bb:cc:dd:ee:ff |
| service_host | ubuntu |
| local_gb | 10 |
| id | 1 |
| pm_user | ipmi |
| terminal_port | None |
+------------------+-------------------+
$ nova baremetal-node-create --pm_address 1.2.3.4 --pm_user ipmi \
--pm_password ipmi $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff
+------------------+-------------------+
| Property | Value |
+------------------+-------------------+
| instance_uuid | None |
| pm_address | 1.2.3.4 |
| interfaces | [] |
| prov_vlan_id | None |
| cpus | 1 |
| memory_mb | 512 |
| prov_mac_address | aa:bb:cc:dd:ee:ff |
| service_host | ubuntu |
| local_gb | 10 |
| id | 1 |
| pm_user | ipmi |
| terminal_port | None |
+------------------+-------------------+
Add a network interface to the node
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -85,17 +85,17 @@ Add a network interface to the node
For each NIC on the node, you must create an interface, specifying the
interface's MAC address.
.. code::
.. code-block:: console
$ nova baremetal-interface-add 1 aa:bb:cc:dd:ee:ff
+-------------+-------------------+
| Property | Value |
+-------------+-------------------+
| datapath_id | 0 |
| id | 1 |
| port_no | 0 |
| address | aa:bb:cc:dd:ee:ff |
+-------------+-------------------+
$ nova baremetal-interface-add 1 aa:bb:cc:dd:ee:ff
+-------------+-------------------+
| Property | Value |
+-------------+-------------------+
| datapath_id | 0 |
| id | 1 |
| port_no | 0 |
| address | aa:bb:cc:dd:ee:ff |
+-------------+-------------------+
Launch an instance from a bare-metal image
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -105,15 +105,15 @@ machine, without any virtualization layer running underneath it. Nova
retains power control via IPMI. In some situations, Nova may retain
network control via Neutron and OpenFlow.
.. code::
.. code-block:: console
$ nova boot --image my-baremetal-image --flavor my-baremetal-flavor test
+-----------------------------+--------------------------------------+
| Property | Value |
+-----------------------------+--------------------------------------+
| status | BUILD |
| id | cc302a8f-cd81-484b-89a8-b75eb3911b1b |
+-----------------------------+--------------------------------------+
$ nova boot --image my-baremetal-image --flavor my-baremetal-flavor test
+-----------------------------+--------------------------------------+
| Property | Value |
+-----------------------------+--------------------------------------+
| status | BUILD |
| id | cc302a8f-cd81-484b-89a8-b75eb3911b1b |
+-----------------------------+--------------------------------------+
... wait for instance to become active ...
@ -137,14 +137,14 @@ Use the :command:`nova baremetal-node-list` command to view all bare-metal
nodes and interfaces. When a node is in use, its status includes the
UUID of the instance that runs on it:
.. code::
.. code-block:: console
$ nova baremetal-node-list
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
| ID | Host | CPUs | Memory_MB | Disk_GB | MAC Address | VLAN | PM Address | PM Username | PM Password | Terminal Port |
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
| 1 | ubuntu | 1 | 512 | 10 | aa:bb:cc:dd:ee:ff | None | 1.2.3.4 | ipmi | | None |
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
$ nova baremetal-node-list
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
| ID | Host | CPUs | Memory_MB | Disk_GB | MAC Address | VLAN | PM Address | PM Username | PM Password | Terminal Port |
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
| 1 | ubuntu | 1 | 512 | 10 | aa:bb:cc:dd:ee:ff | None | 1.2.3.4 | ipmi | | None |
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
Show details for a bare-metal node
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -152,24 +152,24 @@ Show details for a bare-metal node
Use the :command:`nova baremetal-node-list` command to view the details for a
bare-metal node:
.. code::
.. code-block:: console
$ nova baremetal-node-show 1
+------------------+--------------------------------------+
| Property | Value |
+------------------+--------------------------------------+
| instance_uuid | cc302a8f-cd81-484b-89a8-b75eb3911b1b |
| pm_address | 1.2.3.4 |
| interfaces | [{u'datapath_id': u'0', u'id': 1, |
| | u'port_no': 0, |
| | u'address': u'aa:bb:cc:dd:ee:ff'}] |
| prov_vlan_id | None |
| cpus | 1 |
| memory_mb | 512 |
| prov_mac_address | aa:bb:cc:dd:ee:ff |
| service_host | ubuntu |
| local_gb | 10 |
| id | 1 |
| pm_user | ipmi |
| terminal_port | None |
+------------------+--------------------------------------+
$ nova baremetal-node-show 1
+------------------+--------------------------------------+
| Property | Value |
+------------------+--------------------------------------+
| instance_uuid | cc302a8f-cd81-484b-89a8-b75eb3911b1b |
| pm_address | 1.2.3.4 |
| interfaces | [{u'datapath_id': u'0', u'id': 1, |
| | u'port_no': 0, |
| | u'address': u'aa:bb:cc:dd:ee:ff'}] |
| prov_vlan_id | None |
| cpus | 1 |
| memory_mb | 512 |
| prov_mac_address | aa:bb:cc:dd:ee:ff |
| service_host | ubuntu |
| local_gb | 10 |
| id | 1 |
| pm_user | ipmi |
| terminal_port | None |
+------------------+--------------------------------------+

129
doc/user-guide/source/cli_manage_ip_addresses.rst
View File

@ -29,30 +29,35 @@ Use the :command:`nova floating-ip-*` commands to manage floating IP addresses.
List floating IP address information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To list all pools that provide floating IP addresses, run::
To list all pools that provide floating IP addresses, run:
$ nova floating-ip-pool-list
+--------+
| name |
+--------+
| public |
| test |
+--------+
.. code-block:: console
$ nova floating-ip-pool-list
+--------+
| name |
+--------+
| public |
| test |
+--------+
.. note::
If this list is empty, the cloud administrator must configure a pool
of floating IP addresses.
If this list is empty, the cloud administrator must configure a pool
of floating IP addresses.
To list all floating IP addresses that are allocated to the current project,
run::
run:
$ nova floating-ip-list
+--------------+--------------------------------------+----------+--------+
| Ip | Instance Id | Fixed Ip | Pool |
+--------------+--------------------------------------+----------+--------+
| 172.24.4.225 | 4a60ff6a-7a3c-49d7-9515-86ae501044c6 | 10.0.0.2 | public |
| 172.24.4.226 | None | None | public |
+--------------+--------------------------------------+----------+--------+
.. code-block:: console
$ nova floating-ip-list
+--------------+--------------------------------------+----------+--------+
| Ip | Instance Id | Fixed Ip | Pool |
+--------------+--------------------------------------+----------+--------+
| 172.24.4.225 | 4a60ff6a-7a3c-49d7-9515-86ae501044c6 | 10.0.0.2 | public |
| 172.24.4.226 | None | None | public |
+--------------+--------------------------------------+----------+--------+
For each floating IP address that is allocated to the current project,
the command outputs the floating IP address, the ID for the instance
@ -67,51 +72,63 @@ You can assign a floating IP address to a project and to an instance.
#. Run the following command to allocate a floating IP address to the
current project. By default, the floating IP address is allocated from
the public pool. The command outputs the allocated IP address::
the public pool. The command outputs the allocated IP address:
$ nova floating-ip-create
+--------------+-------------+----------+--------+
| Ip | Instance Id | Fixed Ip | Pool |
+--------------+-------------+----------+--------+
| 172.24.4.225 | None | None | public |
+--------------+-------------+----------+--------+
.. code-block:: console
$ nova floating-ip-create
+--------------+-------------+----------+--------+
| IP | Instance Id | Fixed IP | Pool |
+--------------+-------------+----------+--------+
| 172.24.4.225 | None | None | public |
+--------------+-------------+----------+--------+
.. note::
If more than one IP address pool is available, you can specify from which
pool to allocate the IP address, using the pool's name. For example, to
allocate a floating IP address from the ``test`` pool, run::
If more than one IP address pool is available, you can specify from which
pool to allocate the IP address, using the pool's name. For example, to
allocate a floating IP address from the ``test`` pool, run:
$ nova floating-ip-create test
.. code-block:: console
$ nova floating-ip-create test
#. List all project instances with which a floating IP address could be
associated::
associated.
$ nova list
+---------------------+------+---------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+---------------------+------+---------+------------+-------------+------------------+
| d5c854f9-d3e5-4f... | VM1 | ACTIVE | - | Running | private=10.0.0.3 |
| 42290b01-0968-43... | VM2 | SHUTOFF | - | Shutdown | private=10.0.0.4 |
+---------------------+------+---------+------------+-------------+------------------+
.. code-block:: console
#. Associate an IP address with an instance in the project, as follows::
$ nova list
+---------------------+------+---------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+---------------------+------+---------+------------+-------------+------------------+
| d5c854f9-d3e5-4f... | VM1 | ACTIVE | - | Running | private=10.0.0.3 |
| 42290b01-0968-43... | VM2 | SHUTOFF | - | Shutdown | private=10.0.0.4 |
+---------------------+------+---------+------------+-------------+------------------+
$ nova floating-ip-associate INSTANCE_NAME_OR_ID FLOATING_IP_ADDRESS
#. Associate an IP address with an instance in the project, as follows:
For example::
.. code-block:: console
$ nova floating-ip-associate VM1 172.24.4.225
$ nova floating-ip-associate INSTANCE_NAME_OR_ID FLOATING_IP_ADDRESS
The instance is now associated with two IP addresses::
For example:
$ nova list
+------------------+------+--------+------------+-------------+-------------------------------+
| ID | Name | Status | Task State | Power State | Networks |
+------------------+------+--------+------------+-------------+-------------------------------+
| d5c854f9-d3e5... | VM1 | ACTIVE | - | Running | private=10.0.0.3, 172.24.4.225|
| 42290b01-0968... | VM2 | SHUTOFF| - | Shutdown | private=10.0.0.4 |
+------------------+------+--------+------------+-------------+-------------------------------+
.. code-block:: console
$ nova floating-ip-associate VM1 172.24.4.225
The instance is now associated with two IP addresses:
.. code-block:: console
$ nova list
+------------------+------+--------+------------+-------------+-------------------------------+
| ID | Name | Status | Task State | Power State | Networks |
+------------------+------+--------+------------+-------------+-------------------------------+
| d5c854f9-d3e5... | VM1 | ACTIVE | - | Running | private=10.0.0.3, 172.24.4.225|
| 42290b01-0968... | VM2 | SHUTOFF| - | Shutdown | private=10.0.0.4 |
+------------------+------+--------+------------+-------------+-------------------------------+
After you associate the IP address and configure security group rules
for the instance, the instance is publicly available at the floating IP
@ -121,7 +138,7 @@ You can assign a floating IP address to a project and to an instance.
If an instance is connected to multiple networks, you can associate a
floating IP address with a specific fixed IP address using the optional
``--fixed-address`` parameter:
:option:`--fixed-address` parameter:
.. code-block:: console
@ -131,13 +148,17 @@ You can assign a floating IP address to a project and to an instance.
Disassociate floating IP addresses
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To disassociate a floating IP address from an instance::
To disassociate a floating IP address from an instance:
$ nova floating-ip-disassociate INSTANCE_NAME_OR_ID FLOATING_IP_ADDRESS
.. code-block:: console
To remove the floating IP address from a project::
$ nova floating-ip-disassociate INSTANCE_NAME_OR_ID FLOATING_IP_ADDRESS
$ nova floating-ip-delete FLOATING_IP_ADDRESS
To remove the floating IP address from a project:
.. code-block:: console
$ nova floating-ip-delete FLOATING_IP_ADDRESS
The IP address is returned to the pool of IP addresses that is available
for all projects. If the IP address is still associated with a running

620
doc/user-guide/source/cli_manage_shares.rst
View File

@ -10,106 +10,116 @@ instances. To create and manage shares, you use ``manila`` client commands.
Create a share network
~~~~~~~~~~~~~~~~~~~~~~
#. Create a share network::
#. Create a share network.
$ manila share-network-create --name mysharenetwork --description "My Manila network" --neutron-net-id 394246ed-d3fd-4a30-a456-7042ce3429b9 --neutron-subnet-id 8f56d97d-8495-4a5b-8544-9ae4ee9390fc
.. code-block:: console
.. code::
$ manila share-network-create --name mysharenetwork --description "My Manila network" --neutron-net-id 394246ed-d3fd-4a30-a456-7042ce3429b9 --neutron-subnet-id 8f56d97d-8495-4a5b-8544-9ae4ee9390fc
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| name | mysharenetwork |
| segmentation_id | None |
| created_at | 2015-08-17T21:13:29.607489 |
| neutron_subnet_id | 8f56d97d-8495-4a5b-8544-9ae4ee9390fc |
| updated_at | None |
| network_type | None |
| neutron_net_id | 394246ed-d3fd-4a30-a456-7042ce3429b9 |
| ip_version | None |
| nova_net_id | None |
| cidr | None |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| description | My Manila network |
+-------------------+--------------------------------------+
.. code-block:: console
#. List share networks::
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| name | mysharenetwork |
| segmentation_id | None |
| created_at | 2015-08-17T21:13:29.607489 |
| neutron_subnet_id | 8f56d97d-8495-4a5b-8544-9ae4ee9390fc |
| updated_at | None |
| network_type | None |
| neutron_net_id | 394246ed-d3fd-4a30-a456-7042ce3429b9 |
| ip_version | None |
| nova_net_id | None |
| cidr | None |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| description | My Manila network |
+-------------------+--------------------------------------+
$ manila share-network-list
#. List share networks.
.. code::
.. code-block:: console
+--------------------------------------+----------------+
| id | name |
+--------------------------------------+----------------+
| ccd6b453-8b05-4508-bbce-93bfe660451f | mysharenetwork |
+--------------------------------------+----------------+
$ manila share-network-list
.. code-block:: console
+--------------------------------------+----------------+
| id | name |
+--------------------------------------+----------------+
| ccd6b453-8b05-4508-bbce-93bfe660451f | mysharenetwork |
+--------------------------------------+----------------+
Create a share
~~~~~~~~~~~~~~
#. Create a share::
#. Create a share.
$ manila create --name myshare --description "My Manila share" --share-network ccd6b453-8b05-4508-bbce-93bfe660451f NFS 1
.. code-block:: console
.. code::
$ manila create --name myshare --description "My Manila share" --share-network ccd6b453-8b05-4508-bbce-93bfe660451f NFS 1
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| status | creating |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | [] |
| host | None |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 1 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.777696 |
| export_location | None |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+--------------------------------------+
.. code-block:: console
#. Show a share::
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| status | creating |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | [] |
| host | None |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 1 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.777696 |
| export_location | None |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+--------------------------------------+
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
#. Show a share.
.. code::
.. code-block:: console
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| status | creating |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | [] |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 1 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| export_location | None |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+--------------------------------------+
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
#. List shares::
.. code-block:: console
$ manila list
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| status | creating |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | [] |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 1 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| export_location | None |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+--------------------------------------+
.. code::
#. List shares.
.. code-block:: console
$ manila list
.. code-block:: console
+--------------------------------------+---------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
| ID | Name | Size | Share Proto | Status | Is Public | Share Type | Export location | Host |
@ -120,33 +130,37 @@ Create a share
Allow access
~~~~~~~~~~~~
#. Allow access::
#. Allow access.
$ manila access-allow 2fe736d1-08ac-46f9-a482-8f224405f2a7 ip 192.100.00.168
.. code-block:: console
.. code::
$ manila access-allow 2fe736d1-08ac-46f9-a482-8f224405f2a7 ip 192.100.00.168
+--------------+--------------------------------------+
| Property | Value |
+--------------+--------------------------------------+
| share_id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| deleted | False |
| created_at | 2015-08-17T21:36:52.025125 |
| updated_at | None |
| access_type | ip |
| access_to | 192.100.00.168 |
| access_level | rw |
| state | new |
| deleted_at | None |
| id | d73d04ca-a97e-42bb-94b1-e01c72c8e50e |
+--------------+--------------------------------------+
.. code-block:: console
+--------------+--------------------------------------+
| Property | Value |
+--------------+--------------------------------------+
| share_id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| deleted | False |
| created_at | 2015-08-17T21:36:52.025125 |
| updated_at | None |
| access_type | ip |
| access_to | 192.100.00.168 |
| access_level | rw |
| state | new |
| deleted_at | None |
| id | d73d04ca-a97e-42bb-94b1-e01c72c8e50e |
+--------------+--------------------------------------+
#. List access::
#. List access.
$ manila access-list 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
.. code::
$ manila access-list 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+--------------------------------------+-------------+----------------+--------------+--------+
| id | access type | access to | access level | state |
@ -159,31 +173,37 @@ Allow access
Deny access
~~~~~~~~~~~
#. Deny access::
#. Deny access.
$ manila access-deny 2fe736d1-08ac-46f9-a482-8f224405f2a7 d73d04ca-a97e-42bb-94b1-e01c72c8e50e
.. code-block:: console
#. List access::
$ manila access-deny 2fe736d1-08ac-46f9-a482-8f224405f2a7 d73d04ca-a97e-42bb-94b1-e01c72c8e50e
$ manila access-list 2fe736d1-08ac-46f9-a482-8f224405f2a7
#. List access.
.. code::
.. code-block:: console
+----+-------------+-----------+--------------+-------+
| id | access type | access to | access level | state |
+----+-------------+-----------+--------------+-------+
+----+-------------+-----------+--------------+-------+
$ manila access-list 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+----+-------------+-----------+--------------+-------+
| id | access type | access to | access level | state |
+----+-------------+-----------+--------------+-------+
+----+-------------+-----------+--------------+-------+
The access is removed.
Create snapshot
~~~~~~~~~~~~~~~
#. Create a snapshot::
#. Create a snapshot.
$ manila snapshot-create --name mysnapshot --description "My Manila snapshot" 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
.. code::
$ manila snapshot-create --name mysnapshot --description "My Manila snapshot" 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+-------------+--------------------------------------+
| Property | Value |
@ -199,55 +219,61 @@ Create snapshot
| description | My Manila snapshot |
+-------------+--------------------------------------+
#. List snapshots::
#. List snapshots.
$ manila snapshot-list
.. code-block:: console
.. code::
$ manila snapshot-list
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| ID | Share ID | Status | Name | Share Size |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| 1a411703-baef-495f-8e9c-b60e68f2e657 | 2fe736d1-08ac-46f9-a482-8f224405f2a7 | available | mysnapshot | 1 |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
.. code-block:: console
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| ID | Share ID | Status | Name | Share Size |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| 1a411703-baef-495f-8e9c-b60e68f2e657 | 2fe736d1-08ac-46f9-a482-8f224405f2a7 | available | mysnapshot | 1 |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
Create share from snapshot
~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Create a share from a snapshot::
#. Create a share from a snapshot.
$ manila create --snapshot-id 1a411703-baef-495f-8e9c-b60e68f2e657 --share-network ccd6b453-8b05-4508-bbce-93bfe660451f --name mysharefromsnap NFS 1
.. code-block:: console
.. code::
$ manila create --snapshot-id 1a411703-baef-495f-8e9c-b60e68f2e657 --share-network ccd6b453-8b05-4508-bbce-93bfe660451f --name mysharefromsnap NFS 1
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| status | creating |
| description | None |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | [] |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | 1a411703-baef-495f-8e9c-b60e68f2e657 |
| is_public | False |
| id | bcc5b2a7-862b-418a-9607-5d669619d652 |
| size | 1 |
| name | mysharefromsnap |
| share_type | default |
| created_at | 2015-08-17T21:54:43.000000 |
| export_location | None |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+--------------------------------------+
.. code-block:: console
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| status | creating |
| description | None |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | [] |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | 1a411703-baef-495f-8e9c-b60e68f2e657 |
| is_public | False |
| id | bcc5b2a7-862b-418a-9607-5d669619d652 |
| size | 1 |
| name | mysharefromsnap |
| share_type | default |
| created_at | 2015-08-17T21:54:43.000000 |
| export_location | None |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+--------------------------------------+
#. List shares::
#. List shares.
$ manila list
.. code-block:: console
.. code::
$ manila list
.. code-block:: console
+--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
| ID | Name | Size | Share Proto | Status | Is Public | Share Type | Export location | Host |
@ -256,45 +282,51 @@ Create share from snapshot
| bcc5b2a7-862b-418a-9607-5d669619d652 | mysharefromsnap | 1 | NFS | creating | False | default | None | ubuntuManila@generic1#GENERIC1 |
+--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
#. Show the share created from snapshot::
#. Show the share created from snapshot.
$ manila show bcc5b2a7-862b-418a-9607-5d669619d652
.. code-block:: console
.. code::
$ manila show bcc5b2a7-862b-418a-9607-5d669619d652
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | available |
| description | None |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-bcc5b2a7-862b-418a-9607-5d669619d652 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | 1a411703-baef-495f-8e9c-b60e68f2e657 |
| is_public | False |
| id | bcc5b2a7-862b-418a-9607-5d669619d652 |
| size | 1 |
| name | mysharefromsnap |
| share_type | default |
| created_at | 2015-08-17T21:54:43.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | available |
| description | None |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-bcc5b2a7-862b-418a-9607-5d669619d652 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | 1a411703-baef-495f-8e9c-b60e68f2e657 |
| is_public | False |
| id | bcc5b2a7-862b-418a-9607-5d669619d652 |
| size | 1 |
| name | mysharefromsnap |
| share_type | default |
| created_at | 2015-08-17T21:54:43.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+
Delete share
~~~~~~~~~~~~
#. Delete a share::
#. Delete a share.
$ manila delete bcc5b2a7-862b-418a-9607-5d669619d652
.. code-block:: console
#. List shares::
$ manila delete bcc5b2a7-862b-418a-9607-5d669619d652
$ manila list
#. List shares.
.. code::
.. code-block:: console
$ manila list
.. code-block:: console
+--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
| ID | Name | Size | Share Proto | Status | Is Public | Share Type | Export location | Host |
@ -308,151 +340,167 @@ Delete share
Delete snapshot
~~~~~~~~~~~~~~~
#. List snapshots before deleting::
#. List snapshots before deleting.
$ manila snapshot-list
.. code-block:: console
.. code::
$ manila snapshot-list
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| ID | Share ID | Status | Name | Share Size |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| 1a411703-baef-495f-8e9c-b60e68f2e657 | 2fe736d1-08ac-46f9-a482-8f224405f2a7 | available | mysnapshot | 1 |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
.. code-block:: console
#. Delete a snapshot::
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| ID | Share ID | Status | Name | Share Size |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| 1a411703-baef-495f-8e9c-b60e68f2e657 | 2fe736d1-08ac-46f9-a482-8f224405f2a7 | available | mysnapshot | 1 |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
$ manila snapshot-delete 1a411703-baef-495f-8e9c-b60e68f2e657xyang@ubuntuManila:~/devstack$ manila snapshot-list
#. Delete a snapshot.
#. List snapshots after deleting::
.. code-block:: console
.. code::
$ manila snapshot-delete 1a411703-baef-495f-8e9c-b60e68f2e657xyang@ubuntuManila:~/devstack$ manila snapshot-list
+----+----------+--------+------+------------+
| ID | Share ID | Status | Name | Share Size |
+----+----------+--------+------+------------+
+----+----------+--------+------+------------+
#. List snapshots after deleting.
.. code-block:: console
+----+----------+--------+------+------------+
| ID | Share ID | Status | Name | Share Size |
+----+----------+--------+------+------------+
+----+----------+--------+------+------------+
The snapshot is deleted.
Extend share
~~~~~~~~~~~~
#. Extend share::
#. Extend share.
$ manila extend 2fe736d1-08ac-46f9-a482-8f224405f2a7 2
.. code-block:: console
#. Show the share while it is being extended::
$ manila extend 2fe736d1-08ac-46f9-a482-8f224405f2a7 2
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
#. Show the share while it is being extended.
.. code::
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | extending |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 1 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
#. Show the share after it is extended::
.. code-block:: console
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | extending |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 1 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+
.. code::
#. Show the share after it is extended.
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | available |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 2 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+
.. code-block:: console
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | available |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 2 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+
Shrink share
~~~~~~~~~~~~
#. Shrink a share::
#. Shrink a share.
$ manila shrink 2fe736d1-08ac-46f9-a482-8f224405f2a7 1
.. code-block:: console
#. Show the share while it is being shrunk::
$ manila shrink 2fe736d1-08ac-46f9-a482-8f224405f2a7 1
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
#. Show the share while it is being shrunk.
.. code::
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | shrinking |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 2 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
#. Show the share after it is being shrunk::
.. code-block:: console
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | shrinking |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 2 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+
.. code::
#. Show the share after it is being shrunk.
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | available |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 1 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+
.. code-block:: console
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
| status | available |
| description | My Manila share |
| availability_zone | nova |
| share_network_id | ccd6b453-8b05-4508-bbce-93bfe660451f |
| export_locations | 10.254.0.3:/shares/share-2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| host | ubuntuManila@generic1#GENERIC1 |
| snapshot_id | None |
| is_public | False |
| id | 2fe736d1-08ac-46f9-a482-8f224405f2a7 |
| size | 1 |
| name | myshare |
| share_type | default |
| created_at | 2015-08-17T21:17:23.000000 |
| share_proto | NFS |
| project_id | d80a6323e99f4f22a26ad2accd3ec791 |
| metadata | {} |
+-------------------+---------------------------------------------------------------+

67
doc/user-guide/source/cli_nova_configure_access_security_for_instances.rst
View File

@ -11,6 +11,7 @@ pair for multiple instances that belong to that project. If you generate
a key pair with an external tool, you can import it into OpenStack.
.. note::
A key pair belongs to an individual user, not to a project.
To share a key pair across multiple users, each user
needs to import that key pair.
@ -67,16 +68,20 @@ Add a key pair
You can generate a key pair or upload an existing public key.
#. To generate a key pair, run the following command::
#. To generate a key pair, run the following command.
.. code-block:: console
$ nova keypair-add KEY_NAME > MY_KEY.pem
This command generates a key pair with the name that you specify for
KEY\_NAME, writes the private key to the :file:`.pem` file that you specify,
KEY\_NAME, writes the private key to the ``.pem`` file that you specify,
and registers the public key to the Nova database.
#. To set the permissions of the :file:`.pem` file so that only you can read
and write to it, run the following command::
#. To set the permissions of the ``.pem`` file so that only you can read
and write to it, run the following command.
.. code-block:: console
$ chmod 600 MY_KEY.pem
@ -85,7 +90,9 @@ Import a key pair
#. If you have already generated a key pair and the public key is located
at ``~/.ssh/id_rsa.pub``, run the following command to upload the public
key::
key.
.. code-block:: console
$ nova keypair-add --pub_key ~/.ssh/id_rsa.pub KEY_NAME
@ -93,7 +100,9 @@ Import a key pair
key pair the name that you specify for ``KEY_NAME``.
#. To ensure that the key pair has been successfully imported, list key
pairs as follows::
pairs as follows:
.. code-block:: console
$ nova keypair-list
@ -101,16 +110,22 @@ Create and manage security groups
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. To list the security groups for the current project, including
descriptions, enter the following command::
descriptions, enter the following command:
.. code-block:: console
$ nova secgroup-list
#. To create a security group with a specified name and description, enter
the following command::
the following command:
.. code-block:: console
$ nova secgroup-create SECURITY_GROUP_NAME GROUP_DESCRIPTION
#. To delete a specified group, enter the following command::
#. To delete a specified group, enter the following command:
.. code-block:: console
$ nova secgroup-delete SECURITY_GROUP_NAME
@ -127,20 +142,26 @@ Modify security group rules with the :command:`nova secgroup-*-rule`
commands. Before you begin, source the OpenStack RC file. For details,
see :doc:`../common/cli_set_environment_variables_using_openstack_rc`.
#. To list the rules for a security group, run the following command::
#. To list the rules for a security group, run the following command:
$ nova secgroup-list-rules SECURITY_GROUP_NAME
.. code-block:: console
$ nova secgroup-list-rules SECURITY_GROUP_NAME
#. To allow SSH access to the instances, choose one of the following
options:
- Allow access from all IP addresses, specified as IP subnet ``0.0.0.0/0``
in CIDR notation::
in CIDR notation:
.. code-block:: console
$ nova secgroup-add-rule SECURITY_GROUP_NAME tcp 22 22 0.0.0.0/0
- Allow access only from IP addresses from other security groups
(source groups) to access the specified port::
(source groups) to access the specified port:
.. code-block:: console
$ nova secgroup-add-group-rule --ip_proto tcp --from_port 22 \
--to_port 22 SECURITY_GROUP_NAME SOURCE_GROUP_NAME
@ -148,14 +169,18 @@ see :doc:`../common/cli_set_environment_variables_using_openstack_rc`.
#. To allow pinging of the instances, choose one of the following options:
- Allow pinging from all IP addresses, specified as IP subnet
``0.0.0.0/0`` in CIDR notation::
``0.0.0.0/0`` in CIDR notation.
.. code-block:: console
$ nova secgroup-add-rule SECURITY_GROUP_NAME icmp -1 -1 0.0.0.0/0
This allows access to all codes and all types of ICMP traffic.
- Allow only members of other security groups (source groups) to ping
instances::
instances.
.. code-block:: console
$ nova secgroup-add-group-rule --ip_proto icmp --from_port -1 \
--to_port -1 SECURITY_GROUP_NAME SOURCE_GROUP_NAME
@ -164,12 +189,16 @@ see :doc:`../common/cli_set_environment_variables_using_openstack_rc`.
server that runs on a VM, choose one of the following options:
- Allow UDP access from IP addresses, specified as IP subnet
``0.0.0.0/0`` in CIDR notation::
``0.0.0.0/0`` in CIDR notation.
.. code-block:: console
$ nova secgroup-add-rule SECURITY_GROUP_NAME udp 53 53 0.0.0.0/0
- Allow only IP addresses from other security groups (source groups) to
access the specified port::
access the specified port.
.. code-block:: console
$ nova secgroup-add-group-rule --ip_proto udp --from_port 53 \
--to_port 53 SECURITY_GROUP_NAME SOURCE_GROUP_NAME
@ -181,6 +210,8 @@ To delete a security group rule, specify the same arguments that you
used to create the rule.
For example, to delete the security group rule that permits SSH access
from all IP addresses, run the following command::
from all IP addresses, run the following command.
.. code-block:: console
$ nova secgroup-delete-rule SECURITY_GROUP_NAME tcp 22 22 0.0.0.0/0

38
doc/user-guide/source/cli_nova_launch_instance_from_volume.rst
View File

@ -52,7 +52,9 @@ To create a non-bootable volume, do not create it from an image. The
volume must be entirely empty with no partition table and no file
system.
#. Create a non-bootable volume::
#. Create a non-bootable volume.
.. code-block:: console
$ cinder create --display-name my-volume 8
+--------------------------------+--------------------------------------+
@ -79,7 +81,9 @@ system.
| volume_type | None |
+--------------------------------+--------------------------------------+
#. List volumes::
#. List volumes.
.. code-block:: console
$ cinder list
+-----------------+-----------+-----------+------+-------------+----------+-------------+
@ -89,7 +93,9 @@ system.
+-----------------+-----------+-----------+------+-------------+----------+-------------+
#. Boot an instance from an image and attach the empty volume to the
instance::
instance.
.. code-block:: console
$ nova boot --flavor 2 --image 98901246-af91-43d8-b5e6-a4506aa8f369 \
--block-device source=volume,id=d620d971-b160-4c4e-8652-2513d74e2080,dest=volume,shutdown=preserve \
@ -137,7 +143,9 @@ You can create a volume from an existing image, volume, or snapshot.
This procedure shows you how to create a volume from an image, and use
the volume to boot an instance.
#. List the available images::
#. List the available images.
.. code-block:: console
$ nova image-list
+-----------------+---------------------------------+--------+--------+
@ -151,7 +159,9 @@ the volume to boot an instance.
Note the ID of the image that you want to use to create a volume.
#. List the available flavors::
#. List the available flavors.
.. code-block:: console
$ nova flavor-list
+-----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
@ -169,7 +179,9 @@ the volume to boot an instance.
#. To create a bootable volume from an image and launch an instance from
this volume, use the ``--block-device`` parameter.
For example::
For example:
.. code-block:: console
$ nova boot --flavor FLAVOR --block-device \
source=SOURCE,id=ID,dest=DEST,size=SIZE,shutdown=PRESERVE,bootindex=INDEX \
@ -207,7 +219,9 @@ the volume to boot an instance.
- ``NAME``. The name for the server.
#. Create a bootable volume from an image, before the instance boots. The
volume is not deleted when the instance is terminated::
volume is not deleted when the instance is terminated.
.. code-block:: console
$ nova boot --flavor 2 \
--block-device source=image,id=484e05af-a14d-4567-812b-28122d1c2260,dest=volume,size=10,shutdown=preserve,bootindex=0 \
@ -248,7 +262,9 @@ the volume to boot an instance.
+--------------------------------------+--------------------------------+
#. List volumes to see the bootable volume and its attached
``myInstanceFromVolume`` instance::
``myInstanceFromVolume`` instance.
.. code-block:: console
$ cinder list
+-------------+--------+--------------+------+-------------+----------+-------------+
@ -266,9 +282,11 @@ Use the nova ``boot`` ``--swap`` parameter to attach a swap disk on boot
or the nova ``boot`` ``--ephemeral`` parameter to attach an ephemeral
disk on boot. When you terminate the instance, both disks are deleted.
Boot an instance with a 512 MB swap disk and 2 GB ephemeral disk::
Boot an instance with a 512 MB swap disk and 2 GB ephemeral disk.
$ nova boot --flavor FLAVOR --image IMAGE_ID --swap 512 --ephemeral size=2 NAME
.. code-block:: console
$ nova boot --flavor FLAVOR --image IMAGE_ID --swap 512 --ephemeral size=2 NAME
.. note::

50
doc/user-guide/source/cli_nova_launch_instance_using_ISO_image.rst
View File

@ -9,7 +9,9 @@ Boot an instance from an ISO image
OpenStack supports booting instances using ISO images. But before you
make such instances functional, use the :command:`nova boot` command
with the following parameters to boot an instance::
with the following parameters to boot an instance.
.. code-block:: console
$ nova boot \
--image ubuntu-14.04.2-server-amd64.iso \
@ -56,9 +58,9 @@ is a valid network id in your system.
.. note::
You need the Block Storage service, and the parameter
``shutdown=preserve`` is also mandatory, thus the volume will be
preserved after the shutdown of the instance.
You need the Block Storage service, and the parameter
``shutdown=preserve`` is also mandatory, thus the volume will be
preserved after the shutdown of the instance.
After the instance is successfully launched, connect to the instance
using a remote console and follow the instructions to install the
@ -77,34 +79,40 @@ Make the instances booted from ISO image functional
Now complete the following steps to make your instances created
using ISO image actually functional.
#. Delete the instance using the following command::
#. Delete the instance using the following command.
$ nova delete INSTANCE_NAME
.. code-block:: console
$ nova delete INSTANCE_NAME
#. After you delete the instance, the system you have just installed
using your ISO image remains, because the parameter
``shutdown=preserve`` was set, so run the following command::
``shutdown=preserve`` was set, so run the following command.
$ cinder list
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| ID | Status | Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| d620d971-b16... | available | 655ef3e4-... | 8 | None | false | |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
.. code-block:: console
$ cinder list
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| ID | Status | Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| d620d971-b16... | available | 655ef3e4-... | 8 | None | false | |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
You get a list with all the volumes in your system. In this list,
you can find the volume that is attached to your ISO created
instance, with the false bootable property.
#. Upload the volume to glance::
#. Upload the volume to glance.
$ cinder upload-to-image VOLUME_UUID IMAGE_NAME
$ glance image-list
+-------------------+------------+-------------+------------------+------------+--------+
| ID | Name | Disk Format | Container Format | Size | Status |
+-------------------+------------+-------------+------------------+------------+--------+
| 74303284-f802-... | IMAGE_NAME | iso | bare | 764321792 | active |
+-------------------+------------+-------------+------------------+------------+--------+
.. code-block:: console
$ cinder upload-to-image VOLUME_UUID IMAGE_NAME
$ glance image-list
+-------------------+------------+-------------+------------------+------------+--------+
| ID | Name | Disk Format | Container Format | Size | Status |
+-------------------+------------+-------------+------------------+------------+--------+
| 74303284-f802-... | IMAGE_NAME | iso | bare | 764321792 | active |
+-------------------+------------+-------------+------------------+------------+--------+
The ``VOLUME_UUID`` is the uuid of the volume that is attached to
your ISO created instance, and the ``IMAGE_NAME`` is the name that

6
doc/user-guide/source/cli_provide_user_data_to_instances.rst
View File

@ -11,6 +11,8 @@ Linux distributions and which handles early initialization of a cloud
instance.
You can place user data in a local file and pass it through the
``--user-data <user-data-file>`` parameter at instance creation::
``--user-data <user-data-file>`` parameter at instance creation.
$ nova boot --image ubuntu-cloudimage --flavor 1 --user-data mydata.file
.. code-block:: console
$ nova boot --image ubuntu-cloudimage --flavor 1 --user-data mydata.file

38
doc/user-guide/source/cli_reboot_an_instance.rst
View File

@ -8,13 +8,15 @@ cycles the instance.
By default, when you reboot an instance, it is a soft reboot.
.. code::
.. code-block:: console
$ nova reboot SERVER
$ nova reboot SERVER
To perform a hard reboot, pass the ``--hard`` parameter, as follows::
To perform a hard reboot, pass the :option:`--hard` parameter, as follows:
$ nova reboot --hard SERVER
.. code-block:: console
$ nova reboot --hard SERVER
It is also possible to reboot a running instance into rescue mode. For example,
this operation may be required, if a filesystem of an instance becomes
@ -22,19 +24,21 @@ corrupted with prolonged use.
.. note::
Pause, suspend, and stop operations are not allowed when an instance
is running in rescue mode, as triggering these actions causes the
loss of the original instance state, and makes it impossible to
unrescue the instance.
Pause, suspend, and stop operations are not allowed when an instance
is running in rescue mode, as triggering these actions causes the
loss of the original instance state, and makes it impossible to
unrescue the instance.
Rescue mode provides a mechanism for access, even if an image renders
the instance inaccessible. By default, it starts an instance from the
initial image attaching the current boot disk as a secondary one.
To perform an instance reboot into rescue mode, run the following
command::
command:
$ nova rescue SERVER
.. code-block:: console
$ nova rescue SERVER
.. note::
@ -43,7 +47,7 @@ command::
the guest operating system has a chance to perform
a controlled shutdown before the instance is powered off.
The shutdown behavior is configured by the ``shutdown_timeout``
parameter that can be set in the :file:`nova.conf` file.
parameter that can be set in the ``nova.conf`` file.
Its value stands for the overall period (in seconds)
a guest operation system is allowed to complete the shutdown.
The default timeout is 60 seconds. See `Description of
@ -57,11 +61,15 @@ command::
how much time they need to shut down cleanly.
To restart the instance from the normal boot disk, run the following
command::
command:
$ nova unrescue SERVER
.. code-block:: console
$ nova unrescue SERVER
If you want to rescue an instance with a specific image, rather than the
default one, use the ``--rescue_image_ref`` parameter::
default one, use the :option:`--rescue_image_ref` parameter:
$ nova rescue --rescue_image_ref IMAGE_ID SERVER
.. code-block:: console
$ nova rescue --rescue_image_ref IMAGE_ID SERVER

20
doc/user-guide/source/cli_search_instance_with_ip_address.rst
View File

@ -2,20 +2,20 @@
Search for an instance using IP address
=======================================
You can search for an instance using the IP address parameter, ``--ip``,
You can search for an instance using the IP address parameter, :option:`--ip`,
with the :command:`nova list` command.
.. code::
.. code-block:: console
$ nova list --ip IP_ADDRESS
$ nova list --ip IP_ADDRESS
The following example shows the results of a search on ``10.0.0.4``.
.. code::
.. code-block:: console
$ nova list --ip 10.0.0.4
+------------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+------------------+----------------------+--------+------------+-------------+------------------+
| 8a99547e-7385... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
+------------------+----------------------+--------+------------+-------------+------------------+
$ nova list --ip 10.0.0.4
+------------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+------------------+----------------------+--------+------------+-------------+------------------+
| 8a99547e-7385... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 |
+------------------+----------------------+--------+------------+-------------+------------------+

38
doc/user-guide/source/cli_stop_and_start_an_instance.rst
View File

@ -7,28 +7,36 @@ Use one of the following methods to stop and start an instance.
Pause and unpause an instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To pause an instance, run the following command::
To pause an instance, run the following command:
$ nova pause INSTANCE_NAME
.. code-block:: console
$ nova pause INSTANCE_NAME
This command stores the state of the VM in RAM. A paused instance
continues to run in a frozen state.
To unpause an instance, run the following command::
To unpause an instance, run the following command:
$ nova unpause INSTANCE_NAME
.. code-block:: console
$ nova unpause INSTANCE_NAME
Suspend and resume an instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To initiate a hypervisor-level suspend operation, run the following
command::
command:
$ nova suspend INSTANCE_NAME
.. code-block:: console
To resume a suspended instance, run the following command::
$ nova suspend INSTANCE_NAME
$ nova resume INSTANCE_NAME
To resume a suspended instance, run the following command:
.. code-block:: console
$ nova resume INSTANCE_NAME
Shelve and unshelve an instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -46,9 +54,9 @@ You can run the following shelving tasks:
with associated data and resources (a snapshot is taken if not volume
backed). Anything in memory is lost.
.. code::
.. code-block:: console
$ nova shelve SERVERNAME
$ nova shelve SERVERNAME
.. note::
@ -56,7 +64,7 @@ You can run the following shelving tasks:
system a chance to perform a controlled shutdown before the instance
is powered off. The shutdown behavior is configured by the
``shutdown_timeout`` parameter that can be set in the
:file:`nova.conf` file. Its value stands for the overall
``nova.conf`` file. Its value stands for the overall
period (in seconds) a guest operation system is allowed
to complete the shutdown. The default timeout is 60 seconds.
See `Description of Compute configuration options
@ -70,15 +78,15 @@ You can run the following shelving tasks:
- Unshelve an instance - Restores the instance.
.. code::
.. code-block:: console
$ nova unshelve SERVERNAME
$ nova unshelve SERVERNAME
- Remove a shelved instance - Removes the instance from the server;
data and resource associations are deleted. If an instance is no longer
needed, you can move the instance off the hypervisor in order to minimize
resource usage.
.. code::
.. code-block:: console
$ nova shelve-offload SERVERNAME
$ nova shelve-offload SERVERNAME

108
doc/user-guide/source/cli_use_snapshots_to_migrate_instances.rst
View File

@ -19,7 +19,7 @@ In the destination project:
.. note::
Some cloud providers allow only administrators to perform this task.
Some cloud providers allow only administrators to perform this task.
.. _Create_a_snapshot_of_the_instance:
@ -28,71 +28,83 @@ Create a snapshot of the instance
#. Shut down the source VM before you take the snapshot to ensure that all
data is flushed to disk. If necessary, list the instances to view the
instance name::
instance name:
$ nova list
+--------------------------------------+------------+--------+------------------------------+
| ID | Name | Status | Networks |
+--------------------------------------+------------+--------+------------------------------+
| c41f3074-c82a-4837-8673-fa7e9fea7e11 | myInstance | ACTIVE | private=10.0.0.3 |
+--------------------------------------+------------+--------+------------------------------+
.. code-block:: console
$ nova stop example
$ nova list
+--------------------------------------+------------+--------+------------------------------+
| ID | Name | Status | Networks |
+--------------------------------------+------------+--------+------------------------------+
| c41f3074-c82a-4837-8673-fa7e9fea7e11 | myInstance | ACTIVE | private=10.0.0.3 |
+--------------------------------------+------------+--------+------------------------------+
$ nova stop example
#. Use the :command:`nova list` command to confirm that the instance shows a
``SHUTOFF`` status::
``SHUTOFF`` status:
$ nova list
+--------------------------------------+------------+---------+------------------+
| ID | Name | Status | Networks |
+--------------------------------------+------------+---------+------------------+
| c41f3074-c82a-4837-8673-fa7e9fea7e11 | myInstance | SHUTOFF | private=10.0.0.3 |
+--------------------------------------+------------+---------+------------------+
.. code-block:: console
#. Use the :command:`nova image-create` command to take a snapshot::
$ nova list
+--------------------------------------+------------+---------+------------------+
| ID | Name | Status | Networks |
+--------------------------------------+------------+---------+------------------+
| c41f3074-c82a-4837-8673-fa7e9fea7e11 | myInstance | SHUTOFF | private=10.0.0.3 |
+--------------------------------------+------------+---------+------------------+
$ nova image-create --poll myInstance myInstanceSnapshot
Instance snapshotting... 50% complete
#. Use the :command:`nova image-create` command to take a snapshot:
.. code-block:: console
$ nova image-create --poll myInstance myInstanceSnapshot
Instance snapshotting... 50% complete
#. Use the :command:`nova image-list` command to check the status
until the status is ``ACTIVE``::
until the status is ``ACTIVE``:
$ nova image-list
+--------------------------------------+---------------------------------+--------+--------+
| ID | Name | Status | Server |
+--------------------------------------+---------------------------------+--------+--------+
| 657ebb01-6fae-47dc-986a-e49c4dd8c433 | cirros-0.3.2-x86_64-uec | ACTIVE | |
| 72074c6d-bf52-4a56-a61c-02a17bf3819b | cirros-0.3.2-x86_64-uec-kernel | ACTIVE | |
| 3c5e5f06-637b-413e-90f6-ca7ed015ec9e | cirros-0.3.2-x86_64-uec-ramdisk | ACTIVE | |
| f30b204e-1ce6-40e7-b8d9-b353d4d84e7d | myInstanceSnapshot | ACTIVE | |
+--------------------------------------+---------------------------------+--------+--------+
.. code-block:: console
$ nova image-list
+--------------------------------------+---------------------------------+--------+--------+
| ID | Name | Status | Server |
+--------------------------------------+---------------------------------+--------+--------+
| 657ebb01-6fae-47dc-986a-e49c4dd8c433 | cirros-0.3.2-x86_64-uec | ACTIVE | |
| 72074c6d-bf52-4a56-a61c-02a17bf3819b | cirros-0.3.2-x86_64-uec-kernel | ACTIVE | |
| 3c5e5f06-637b-413e-90f6-ca7ed015ec9e | cirros-0.3.2-x86_64-uec-ramdisk | ACTIVE | |
| f30b204e-1ce6-40e7-b8d9-b353d4d84e7d | myInstanceSnapshot | ACTIVE | |
+--------------------------------------+---------------------------------+--------+--------+
.. _Download_the_snapshot_as_an_image:
Download the snapshot as an image
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Get the image ID::
#. Get the image ID:
$ nova image-list
+-------------------+-------------------+--------+--------------------------------------+
| ID | Name | Status | Server |
+-------------------+-------------------+--------+--------------------------------------+
| f30b204e-1ce6... | myInstanceSnapshot| ACTIVE | c41f3074-c82a-4837-8673-fa7e9fea7e11 |
+------------------+-------------------+--------+---------------------------------------+
.. code-block:: console
$ nova image-list
+-------------------+-------------------+--------+--------------------------------------+
| ID | Name | Status | Server |
+-------------------+-------------------+--------+--------------------------------------+
| f30b204e-1ce6... | myInstanceSnapshot| ACTIVE | c41f3074-c82a-4837-8673-fa7e9fea7e11 |
+------------------+-------------------+--------+---------------------------------------+
#. Download the snapshot by using the image ID that was returned in the
previous step::
previous step:
$ glance image-download --file snapshot.raw
f30b204e-1ce6-40e7-b8d9-b353d4d84e7d
.. code-block:: console
$ glance image-download --file snapshot.raw
f30b204e-1ce6-40e7-b8d9-b353d4d84e7d
.. note::
The :command:`glance image-download` command requires the image ID and
cannot use the image name.
Check there is sufficient space on the destination file system for
the image file.
The :command:`glance image-download` command requires the image ID and
cannot use the image name.
Check there is sufficient space on the destination file system for
the image file.
#. Make the image available to the new environment, either through HTTP or
direct upload to a machine (``scp``).
@ -104,9 +116,9 @@ Import the snapshot to the new environment
In the new project or cloud environment, import the snapshot:
.. code::
.. code-block:: console
$ glance image-create --copy-from IMAGE_URL
$ glance image-create --copy-from IMAGE_URL
.. _Boot_a_new_instance_from_the_snapshot:
@ -114,6 +126,8 @@ Boot a new instance from the snapshot
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the new project or cloud environment, use the snapshot to create the
new instance::
new instance:
$ nova boot --flavor m1.tiny --image myInstanceSnapshot myNewInstance
.. code-block:: console
$ nova boot --flavor m1.tiny --image myInstanceSnapshot myNewInstance

28
doc/user-guide/source/configure_access_and_security_for_instances.rst
View File

@ -21,6 +21,7 @@ belong to a project. For more information, see the section
:ref:`dashboard_import_keypair`.
.. note::
A key pair belongs to an individual user, not to a project.
To share a key pair across multiple users, each user
needs to import that key pair.
@ -46,7 +47,9 @@ access to the instances.
This procedure can be adjusted as necessary to add additional security
group rules to a project, if your cloud requires them.
.. note:: When adding a rule, you must specify the protocol used with the
.. note::
When adding a rule, you must specify the protocol used with the
destination port or source port.
#. Log in to the dashboard.
@ -68,7 +71,9 @@ group rules to a project, if your cloud requires them.
* **Remote**: ``CIDR``
* **CIDR**: ``0.0.0.0/0``
.. note:: To accept requests from a particular range of IP
.. note::
To accept requests from a particular range of IP
addresses, specify the IP address block in the
:guilabel:`CIDR` box.
@ -120,7 +125,6 @@ Create at least one key pair for each project.
Import a key pair
~~~~~~~~~~~~~~~~~
#. Log in to the dashboard.
#. Select the appropriate project from the drop down menu at the top left.
@ -142,20 +146,22 @@ Import a key pair
#. To change its permissions so that only you can read and write to the
file, run the following command:
.. code::
.. code-block:: console
$ chmod 0600 yourPrivateKey.pem
$ chmod 0600 yourPrivateKey.pem
.. note:: If you are using the Dashboard from a Windows computer, use PuTTYgen
.. note::
If you are using the Dashboard from a Windows computer, use PuTTYgen
to load the ``*.pem`` file and convert and save it as ``*.ppk``. For
more information see the `WinSCP web page for
PuTTYgen <http://winscp.net/eng/docs/ui_puttygen>`__.
#. To make the key pair known to SSH, run the **ssh-add** command.
#. To make the key pair known to SSH, run the :command:`ssh-add` command.
.. code::
.. code-block:: console
$ ssh-add yourPrivateKey.pem
$ ssh-add yourPrivateKey.pem
The Compute database registers the public key of the key pair.
@ -209,7 +215,9 @@ and the association of that address with a specific instance.
#. Click :guilabel:`Associate`.
.. note:: To disassociate an IP address from an instance, click the
.. note::
To disassociate an IP address from an instance, click the
:guilabel:`Disassociate` button.
To release the floating IP address back into the pool of addresses,

2
doc/user-guide/source/dashboard_create_networks.rst
View File

@ -107,5 +107,3 @@ Create a router
You have successfully created the router. You can view the new topology
from the :guilabel:`Network Topology` tab.

24
doc/user-guide/source/dashboard_databases.rst
View File

@ -24,29 +24,29 @@ flavor for the type of database instance you want.
#. Add the following line to ``/etc/trove/trove.conf``:
.. code::
.. code-block:: console
default_datastore = DATASTORE_NAME
default_datastore = DATASTORE_NAME
Replace *``DATASTORE_NAME``* with the name that the administrative
user set when issuing the **trove-manage** command to create the
datastore. You can use the trove **datastore-list** command to
Replace ``DATASTORE_NAME`` with the name that the administrative
user set when issuing the :command:`trove-manage` command to create the
datastore. You can use the trove :command:`datastore-list` command to
display the datastores that are available in your environment.
For example, if your MySQL datastore name is set to ``mysql``,
For example, if your MySQL data store name is set to ``mysql``,
your entry would look like this:
.. code::
.. code-block:: console
default_datastore = mysql
default_datastore = mysql
#. Restart Database services on the controller node:
.. code::
.. code-block:: console
# service trove-api restart
# service trove-taskmanager restart
# service trove-conductor restart
# service trove-api restart
# service trove-taskmanager restart
# service trove-conductor restart
#. **Verify flavor.**

18
doc/user-guide/source/dashboard_launch_instances.rst
View File

@ -58,7 +58,9 @@ copy of the image on the compute node where the instance starts.
Instance Name
Assign a name to the virtual machine.
.. note:: The name you assign here becomes the initial host name
.. note::
The name you assign here becomes the initial host name
of the server.
After the server is built, if you change the server name in the API
@ -71,7 +73,9 @@ copy of the image on the compute node where the instance starts.
Flavor
Specify the size of the instance to launch.
.. note:: The flavor is selected based on the size of the image selected
.. note::
The flavor is selected based on the size of the image selected
for launching an instance. For example, while creating an image, if
you have entered the value in the :guilabel:`Minimum RAM (MB)` field
as 2048, then on selecting the image, the default flavor is
@ -188,14 +192,18 @@ Connect to your instance by using SSH
To use SSH to connect to your instance, you use the downloaded keypair
file.
.. note:: The user name is ``ubuntu`` for the Ubuntu cloud images on TryStack.
.. note::
The user name is ``ubuntu`` for the Ubuntu cloud images on TryStack.
#. Copy the IP address for your instance.
#. Use the :command:`ssh` command to make a secure connection to the instance.
For example::
For example:
$ ssh -i MyKey.pem ubuntu@10.0.0.2
.. code-block:: console
$ ssh -i MyKey.pem ubuntu@10.0.0.2
#. At the prompt, type ``yes``.

12
doc/user-guide/source/dashboard_manage_containers.rst
View File

@ -30,7 +30,9 @@ Create a container
You have successfully created a container.
.. note:: To delete a container, click the :guilabel:`More` button and select
.. note::
To delete a container, click the :guilabel:`More` button and select
:guilabel:`Delete Container`.
Upload an object
@ -60,7 +62,9 @@ Upload an object
You have successfully uploaded an object to the container.
.. note:: To delete an object, click the :guilabel:`More button` and select
.. note::
To delete an object, click the :guilabel:`More button` and select
:guilabel:`Delete Object`.
Manage an object
@ -85,7 +89,9 @@ Manage an object
#. Click :guilabel:`Update Object`.
.. note:: To delete an object, click the menu button and select
.. note::
To delete an object, click the menu button and select
:guilabel:`Delete Object`.
**To copy an object from one container to another**

8
doc/user-guide/source/dashboard_manage_volumes.rst
View File

@ -74,7 +74,9 @@ You can attach a volume to one instance at a time.
#. Enter the name of the device from which the volume is accessible by
the instance.
.. note:: The actual device name might differ from the volume name because
.. note::
The actual device name might differ from the volume name because
of hypervisor settings.
#. Click :guilabel:`Attach Volume`.
@ -143,7 +145,9 @@ Edit a volume
#. Click :guilabel:`Edit Volume`.
.. note:: You can extend a volume by using the :guilabel:`Extend Volume`
.. note::
You can extend a volume by using the :guilabel:`Extend Volume`
option available in the :guilabel:`More` dropdown list and entering the
new value for volume size.