diff --git a/doc/common/section_cli_nova_baremetal.xml b/doc/common/section_cli_nova_baremetal.xml index dca83ba63d..c056724437 100644 --- a/doc/common/section_cli_nova_baremetal.xml +++ b/doc/common/section_cli_nova_baremetal.xml @@ -2,56 +2,64 @@
- Manage bare metal nodes - The bare metal driver for OpenStack Compute manages - provisioning of physical hardware using common cloud APIs and - tools such as Orchestration (Heat). The use case for this driver - is for single tenant clouds such as a high-performance computing - cluster or deploying OpenStack itself. Development efforts are - focused on moving the driver out of the Compute code base in the - Icehouse release. If you use the bare metal driver, you must - create and add a network interface to a bare metal node. Then, you - can launch an instance from a bare metal image. - You can list and delete bare metal nodes. When you delete a - node, any associated network interfaces are removed. You can list - and remove network interfaces that are associated with a bare - metal node. + Manage bare-metal nodes + The bare-metal driver for OpenStack Compute manages provisioning of + physical hardware by using common cloud APIs and tools such as Orchestration + (Heat). The use case for this driver is for single tenant clouds such as a + high-performance computing cluster or for deploying OpenStack itself. + If you use the bare-metal driver, you must create a network interface + and add it to a bare-metal node. Then, you can launch an instance from a + bare-metal image. + Development efforts are focused on moving the driver out of the Compute + code base in the Icehouse release. + You can list and delete bare-metal nodes. When you delete a node, any + associated network interfaces are removed. You can list and remove network + interfaces that are associated with a bare-metal node. Commands + The following commands can be used to manage bare-metal nodes. - baremetal-interface-add. Adds a network - interface to a bare metal node. + baremetal-interface-add. Adds a network interface + to a bare-metal node. baremetal-interface-list. Lists network - interfaces associated with a bare metal node. + interfaces associated with a bare-metal node. - baremetal-interface-remove. Removes a - network interface from a bare metal node. + baremetal-interface-remove. Removes a network + interface from a bare-metal node. - baremetal-node-create. Creates a bare - metal node. + baremetal-node-create. Creates a bare-metal + node. - baremetal-node-delete. Removes a bare - metal node and any associated interfaces. + baremetal-node-delete. Removes a bare-metal node + and any associated interfaces. - baremetal-node-list. Lists available - bare metal nodes. + baremetal-node-list. Lists available bare-metal + nodes. - baremetal-node-show. Shows information - about a bare metal node. + baremetal-node-show. Shows information about a + bare-metal node. - - - Create a bare metal node: - $ 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 - +------------------+-------------------+ +
+ Create a bare-metal node + When you create a bare-metal node, your PM address, username, and + password should match those that are configured in your hardware's + BIOS/IPMI configuration. + $ 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 username + ipmi, and password ipmi. + $ 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 | @@ -66,51 +74,64 @@ | id | 1 | | pm_user | ipmi | | terminal_port | None | -+------------------+-------------------+ - - - Add a network interface to the node: - $ nova baremetal-interface-add 1 aa:bb:cc:dd:ee:ff - +-------------+-------------------+ ++------------------+-------------------+
+
+ Add a network interface to the node: + For each NIC on the node, you must create an interface, specifying the + interface's MAC address. + $ 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: - $ nova boot --image my-baremetal-image --flavor my-baremetal-flavor test - +-----------------------------+--------------------------------------+ ++-------------+-------------------+
+
+ Launch an instance + from a bare-metal image: + A bare-metal instance is an instance created directly on a physical + 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. + $ 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 ... - - - List bare metal nodes and interfaces: - $ nova baremetal-node-list - When a node is in use, its status includes the UUID of the - instance that runs on it: - +----+--------+------+-----------+---------+------------------- - +------+------------+-------------+-------------+---------------+ -| 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: - $ nova baremetal-node-show 1 - +------------------+--------------------------------------+ + + Set the --availability_zone parameter to + specify which zone or node to use to start the server. Separate the zone + from the host name with a comma. For example: + $ nova boot --availability_zone=zone:HOST,NODE + host is optional for the + --availability_zone parameter. You can specify + simply zone:,node. You must still use the + comma. + +
+
+ List bare-metal nodes and + interfaces: + Use the 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: + $ 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: + Use the nova baremetal-node-list command to view + the details for a bare-metal node. + $ nova baremetal-node-show 1 ++------------------+--------------------------------------+ | Property | Value | +------------------+--------------------------------------+ | instance_uuid | cc302a8f-cd81-484b-89a8-b75eb3911b1b | @@ -126,17 +147,5 @@ | id | 1 | | pm_user | ipmi | | terminal_port | None | -+------------------+--------------------------------------+ - - - - Set the --availability_zone parameter - to specify which zone or node to use to start the server. - Separate the zone from the host name with a comma. For - example: - $ nova boot --availability_zone=zone:host,node - host is optional for the - --availability_zone parameter. - zone:,node also works. - ++------------------+--------------------------------------+
diff --git a/doc/common/section_cli_nova_get_console.xml b/doc/common/section_cli_nova_get_console.xml index 6c75d5db02..962c608e3f 100644 --- a/doc/common/section_cli_nova_get_console.xml +++ b/doc/common/section_cli_nova_get_console.xml @@ -4,14 +4,16 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg" xmlns:html="http://www.w3.org/1999/xhtml" version="5.0"> - Get a console to access an instance - To get a VNC console to access an instance, run the following - command: $ nova get-vnc-console myCirrosServer xvpvnc + Access an instance through a console + To access an instance through a VNC console, run the + following command: $ nova get-vnc-console INSTANCE_NAME xvpvnc The command returns a URL from which you can access your instance: +--------+------------------------------------------------------------------------------+ | Type | Url | +--------+------------------------------------------------------------------------------+ | xvpvnc | http://166.78.190.96:6081/console?token=c83ae3a3-15c4-4890-8d45-aefb494a8d6c | +--------+------------------------------------------------------------------------------+ -To get a non-VNC console, specify the novnc parameter instead of the xvpvnc parameter. +To access an instance through a non-VNC console, specify the + novnc parameter instead of the + xvpvnc parameter. diff --git a/doc/common/section_cli_nova_resizerebuild.xml b/doc/common/section_cli_nova_resizerebuild.xml index c7ae4576ba..850fd07404 100644 --- a/doc/common/section_cli_nova_resizerebuild.xml +++ b/doc/common/section_cli_nova_resizerebuild.xml @@ -7,24 +7,10 @@ You change the size of a server by changing its flavor. - List the available flavors: - $ nova flavor-list - +----+-----------+-----------+------+-----------+------+-------+-------------+-----------+ -| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public | -+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+ -| 1 | m1.tiny | 512 | 0 | 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 | -+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+ - - - Show information about your server, including its - size: - - $ nova show myCirrosServer - +-------------------------------------+----------------------------------------------------------------+ + Show information about your server, including its size, which is shown as the value of the flavor + property. + $ nova show myCirrosServer + +-------------------------------------+----------------------------------------------------------------+ | Property | Value | +-------------------------------------+----------------------------------------------------------------+ | status | ACTIVE | @@ -54,13 +40,24 @@ | OS-EXT-AZ:availability_zone | nova | | config_drive | | +-------------------------------------+----------------------------------------------------------------+ - The size of the server is m1.small - (2). + The size (flavor) of the server is m1.small (2). - To resize the server, pass the server ID and the desired - flavor to the nova resize command. Include - the --poll parameter to report the resize + 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 | 0 | 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 | ++----+-----------+-----------+------+-----------+------+-------+-------------+-----------+ + + + To resize the server, pass the server ID or name and the new flavor to the nova + resize command. Include the --poll parameter to report the resize progress. $ nova resize myCirrosServer 4 --poll Instance resizing... 100% complete @@ -68,24 +65,23 @@ Finished Show the status for your server: - $ nova list - +--------------------------------------+-------------+--------+-----------------------------------------+ -| ID | Name | Status | Networks | -+--------------------------------------+-------------+--------+-----------------------------------------+ -| 970e4ca0-f9b7-4c44-80ed-bf0152c96ae1 | resize-demo | RESIZE | private=172.16.101.6, public=10.4.113.6 | -+--------------------------------------+-------------+--------+-----------------------------------------+ + $ nova list ++--------------------------------------+----------------+--------+-----------------------------------------+ +| ID | Name | Status | Networks | ++--------------------------------------+----------------+--------+-----------------------------------------+ +| 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 | myCirrosServer | RESIZE | private=172.16.101.6, public=10.4.113.6 | ++--------------------------------------+----------------+--------+-----------------------------------------+ + When the resize completes, the status becomes VERIFY_RESIZE. - When the resize completes, the status becomes - VERIFY_RESIZE. To confirm the - resize: - $ nova resize-confirm 6beefcf7-9de6-48b3-9ba9-e11b343189b3 + Confirm the resize: + $ 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: - $ nova resize-revert 6beefcf7-9de6-48b3-9ba9-e11b343189b3 + $ nova resize-revert 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 The server status becomes ACTIVE. diff --git a/doc/common/section_cli_nova_search_ip.xml b/doc/common/section_cli_nova_search_ip.xml index 267623f667..3f46a5c192 100644 --- a/doc/common/section_cli_nova_search_ip.xml +++ b/doc/common/section_cli_nova_search_ip.xml @@ -5,21 +5,16 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="search_ip" version="5.0"> Search for an instance using IP address - You can search for an instance using the IP address parameter. - - - Use the --ip to search for an instance - using the IP address. - $ nova list --ip IP_ADDRESS - - For example, use the nova list command as follows: + You can search for an instance using the IP address parameter, + --ip, with the nova list + command. + $ nova list --ip IP_ADDRESS + The following example shows the results of a search on + 10.0.0.4. $ nova list --ip 10.0.0.4 +--------------------------------------+----------------------+--------+------------+-------------+------------------+ | ID | Name | Status | Task State | Power State | Networks | +--------------------------------------+----------------------+--------+------------+-------------+------------------+ | 8a99547e-7385-4ad1-ae50-4ecfaaad5f42 | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 | -+--------------------------------------+----------------------+--------+------------+-------------+------------------+ - - - - \ No newline at end of file ++--------------------------------------+----------------------+--------+------------+-------------+------------------+ + diff --git a/doc/common/section_cli_nova_startstop.xml b/doc/common/section_cli_nova_startstop.xml index 3625533af9..fb2c99a220 100644 --- a/doc/common/section_cli_nova_startstop.xml +++ b/doc/common/section_cli_nova_startstop.xml @@ -7,38 +7,38 @@ Use one of the following methods to stop and start an instance.
- Pause and un-pause an instance - - - To pause a server, run the following command: - $ nova pause SERVER + Pause and unpause an instance + + + To pause an instance, run the following command: + $ 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 un-pause the server, run the following - command: - $ nova unpause SERVER - - + instance continues to run in a frozen state. + To unpause the instance, run the following command: + $ nova unpause INSTANCE_NAME + +
Suspend and resume an instance - - Administrative users might want to suspend an infrequently - used instance or to perform system maintenance. - - When you suspend an instance, its VM state is stored on - disk, all memory is written to disk, and the virtual machine - is stopped. Suspending an instance is similar to placing a - device in hibernation; memory and vCPUs become - available. + + Administrative users might want to suspend an instance if + it is infrequently used or to perform system maintenance. When + you suspend an instance, its VM state is stored on disk, all + memory is written to disk, and the virtual machine is stopped. + Suspending an instance is similar to placing a device in + hibernation; memory and vCPUs become available to create other + instances. + To initiate a hypervisor-level suspend operation, run the following command: - $ nova suspend SERVER - - - To resume a suspended server: - $ nova resume SERVER - - + $ nova suspend INSTANCE_NAME + + + To resume a suspended instance, run the following + command: + $ nova resume INSTANCE_NAME + +
diff --git a/doc/common/section_cli_nova_terminate.xml b/doc/common/section_cli_nova_terminate.xml index c0c3040ff1..217cee9c14 100644 --- a/doc/common/section_cli_nova_terminate.xml +++ b/doc/common/section_cli_nova_terminate.xml @@ -18,13 +18,11 @@ | d7efd3e4-d375-46d1-9d57-372b6e4bdb7f | newServer | ERROR | None | NOSTATE | | +--------------------------------------+----------------------+--------+------------+-------------+------------------+ - Use the following command to delete the - newServer instance, which is in - ERROR state: + Run the nova delete command to delete the instance. The following example shows deletion + of the newServer instance, which is in ERROR state: $ nova delete newServer -The command does not notify that your server was deleted. - Instead, run the nova list - command: +The command does not notify that your server was deleted. + To verify that the server was deleted, run the nova list command: $ nova list +--------------------------------------+----------------------+--------+------------+-------------+------------------+ | ID | Name | Status | Task State | Power State | Networks | diff --git a/doc/common/section_cli_nova_usage_statistics.xml b/doc/common/section_cli_nova_usage_statistics.xml index 8ae31c6312..eb1a37cd40 100644 --- a/doc/common/section_cli_nova_usage_statistics.xml +++ b/doc/common/section_cli_nova_usage_statistics.xml @@ -3,17 +3,23 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="usage_statistics"> Show usage statistics for hosts and instancesYou can show basic statistics on resource usage for hosts and instances. - For more sophisticated + + For more sophisticated monitoring, see the Ceilometer project, which is under development. You can also use tools, such as Ganglia or Graphite, to gather more detailed data. - - To show host usage statistics - List the hosts and the nova-related services that run on + >Graphite, to gather more detailed data. + +
+ Show host usage statistics + The following examples show the host usage statistics for a host + called devstack. + + + List the hosts and the nova-related services that run on them:$ nova host-list +-----------+-------------+----------+ | host_name | service | zone | @@ -24,12 +30,11 @@ | devstack | network | internal | | devstack | scheduler | internal | | devstack | consoleauth | internal | -+-----------+-------------+----------+ - - Get a summary of resource usage of all of the instances running - on the host. - $ nova host-describe devstack -+-----------+----------------------------------+-----+-----------+---------+ ++-----------+-------------+----------+ + Get a summary of resource usage of all of the instances running on + the host: + $ nova host-describe devstack + +-----------+----------------------------------+-----+-----------+---------+ | HOST | PROJECT | cpu | memory_mb | disk_gb | +----------+----------------------------------+-----+-----------+---------+ | devstack | (total) | 2 | 4003 | 157 | @@ -40,38 +45,43 @@ +----------+----------------------------------+-----+-----------+---------+ The cpu column shows the sum of the virtual CPUs for instances running on the host. - The memory_mb column shows the - sum of the memory (in MB) allocated to the instances - that run on the hosts. - The disk_gb column shows the sum - of the root and ephemeral disk sizes (in GB) of the - instances that run on the hosts. - The used_now row shows the sum - of the resources allocated to the instances - that run on the host plus the resources allocated to - the virtual machine of the host itself. - The used_max row shows the sum - of the resources allocated to the instances - that run on the host. - These values are computed by using only information - about the flavors of the instances that run on the - hosts. This command does not query the CPU usage, - memory usage, or hard disk usage of the physical - host. - - To show instance usage statistics - - Get CPU, memory, I/O, and network statistics for an + The memory_mb column shows the sum of the + memory (in MB) allocated to the instances that run on the + host. + The disk_gb column shows the sum of the + root and ephemeral disk sizes (in GB) of the instances that + run on the host. + The row that has the value used_now in the + PROJECT column shows the sum of the + resources allocated to the instances that run on the host, + plus the resources allocated to the virtual machine of the + host itself. + The row that has the value used_max row in + the PROJECT column shows the sum of the + resources allocated to the instances that run on the + host. + + + These values are computed by using information about the flavors of the + instances that run on the hosts. This command does not query the + CPU usage, memory usage, or hard disk usage of the physical + host. + +
+
+ Show instance usage statistics + + Get CPU, memory, I/O, and network statistics for an instance. - First, list instances: + List instances: $ nova list +--------------------------------------+----------------------+--------+------------+-------------+------------------+ | ID | Name | Status | Task State | Power State | Networks | +--------------------------------------+----------------------+--------+------------+-------------+------------------+ | 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 | | 8a99547e-7385-4ad1-ae50-4ecfaaad5f42 | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 | -+--------------------------------------+----------------------+--------+------------+-------------+------------------+ - Then, get diagnostic statistics: ++--------------------------------------+----------------------+--------+------------+-------------+------------------+ + Get diagnostic statistics: $ nova diagnostics myCirrosServer +------------------+----------------+ | Property | Value | @@ -91,9 +101,8 @@ | vnet1_rx_packets | 5485 | | vda_read_req | 0 | | vda_errors | -1 | -+------------------+----------------+ - - Get summary statistics for each tenant: ++------------------+----------------+ + Get summary statistics for each tenant: $ nova usage-list Usage from 2013-06-25 to 2013-07-24: +----------------------------------+-----------+--------------+-----------+---------------+ @@ -101,7 +110,6 @@ +----------------------------------+-----------+--------------+-----------+---------------+ | b70d90d65e464582b6b2161cf3603ced | 1 | 344064.44 | 672.00 | 0.00 | | 66265572db174a7aa66eba661f58eb9e | 3 | 671626.76 | 327.94 | 6558.86 | -+----------------------------------+-----------+--------------+-----------+---------------+ - - ++----------------------------------+-----------+--------------+-----------+---------------+ +
diff --git a/doc/user-guide/section_cli_nova_floating_ips.xml b/doc/user-guide/section_cli_nova_floating_ips.xml index 3d84a13f07..0c4ce4894e 100644 --- a/doc/user-guide/section_cli_nova_floating_ips.xml +++ b/doc/user-guide/section_cli_nova_floating_ips.xml @@ -6,35 +6,30 @@ Manage IP addresses Each instance can have a private, or fixed, IP address and a public, or floating, one. - Private IP addresses are used for communication between - instances, and public ones are used for communication with the - outside world. + Private IP addresses are used for communication between instances, and + public ones are used for communication with networks outside the cloud, + including the Internet. When you launch an instance, it is automatically assigned a private IP address that stays the same until you explicitly terminate the instance. Rebooting an instance has no effect on the private IP address. - A pool of floating IPs, configured by the cloud operator, is - available in OpenStack Compute. - You can allocate a certain number of these to a project: The - maximum number of floating IP addresses per project is defined - by the quota. - You can add a floating IP address from this set to an - instance of the project. Floating IP addresses can be - dynamically disassociated and associated with other instances - of the same project at any time. - Before you can assign a floating IP address to an instance, - you first must allocate floating IPs to a project. After - floating IP addresses have been allocated to the current - project, you can assign them to running instances. - You can assign a floating IP address to one instance at a - time. + A pool of floating IP addresses, configured by the cloud operator, is + available in OpenStack Compute. You can allocate a certain number of + these IP addresses to a project. The maximum number of floating IP + addresses per project is defined by the quota. + After you allocate floating IP addresses to a project, you can add a + floating IP address from this set to an instance of the project. You can + assign a floating IP address to one instance at a time. Floating IP + addresses can be disassociated from an instance and associated with + another instance of the same project at any time.
List floating IP address information - - - To list all floating IP addresses: - $ nova floating-ip-bulk-list - +------------+---------------+---------------+--------+-----------+ + + + To list all floating IP addresses, run the following + command: + $ nova floating-ip-bulk-list ++------------+---------------+---------------+--------+-----------+ | project_id | address | instance_uuid | pool | interface | +------------+---------------+---------------+--------+-----------+ | None | 172.24.4.225 | None | public | eth0 | @@ -58,10 +53,10 @@ | None | 192.168.253.5 | None | test | eth0 | | None | 192.168.253.6 | None | test | eth0 | +------------+---------------+---------------+--------+-----------+ - - - To list all pools that provide floating IP - addresses: + + + To list all pools that provide floating IP addresses, run + the following command: $ nova floating-ip-pool-list +--------+ | name | @@ -69,20 +64,20 @@ | public | | test | +--------+ - - + +
Assign floating IP addresses - You can assign floating IP addresses to a project or an + You can assign floating IP addresses to a project and to an instance. - Allocate a floating IP address to the current - project. If more than one IP address pool is - available, you can specify the pool from which to - allocate the IP address. This example specifies - the public pool: + Run the following command to allocate a floating IP + address to the current project. If more than one IP address + pool is available, you can specify the pool from which to + allocate the IP address. This example specifies the + public pool: $ nova floating-ip-create public +--------------+-------------+----------+--------+ | Ip | Instance Id | Fixed Ip | Pool | @@ -91,20 +86,9 @@ +--------------+-------------+----------+--------+ - To release a floating IP address from the - current project: - $ nova floating-ip-delete FLOATING_IP - The IP address is returned to the pool of IP - addresses that are available for all projects. If - an IP address is assigned to a running instance, - it is disassociated from the instance. - - - To associate an IP address with an instance, at - least one floating IP address must be allocated to - the current project. - To assign a floating IP address to an - instance: + After at least one floating IP address is allocated to the + project, assign an IP address to an instance in the project, + as follows: $ nova add-floating-ip INSTANCE_NAME_OR_ID FLOATING_IP After you assign the IP address and configure security group rules for the instance, the @@ -112,11 +96,20 @@ address. - To remove a floating IP address from an - instance, specify the same arguments that - you used to assign the IP address: + To remove a floating IP address from an instance, specify + the same arguments that you used to assign the IP address, + but run the following command: $ nova remove-floating-ip INSTANCE_NAME_OR_ID FLOATING_IP + + To release a floating IP address from the current project, + run the following command: + $ nova floating-ip-delete FLOATING_IP + The IP address is returned to the pool of IP addresses + that are available for all projects. If an IP address is + assigned to a running instance, it is disassociated from the + instance. +
diff --git a/doc/user-guide/section_cli_nova_manage_instances.xml b/doc/user-guide/section_cli_nova_manage_instances.xml index 0b87d22cc8..47ce6f7465 100644 --- a/doc/user-guide/section_cli_nova_manage_instances.xml +++ b/doc/user-guide/section_cli_nova_manage_instances.xml @@ -4,8 +4,15 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cli_manage_instances"> Manage instances and hosts - Instances are virtual machines that run inside the - cloud. + Instances are virtual machines that run inside the cloud on + physical compute nodes. The Compute service manages instances. + A host is the node on which a group of instances + resides. + This section describes how to perform the different tasks + involved in instance management, such as adding floating IP + addresses, stopping and starting instances, and terminating + instances. This section also discusses node management + tasks.