Cleanup launch instance and manage IPs docs

This is a follow up to Ie039322660fd0e2e0403843448379b78114c425b.

A few things are changed here:

* The note about using file injection is removed. File injection
  was deprecated in the API in Queens and not something that we
  really want users using.
* Mention that creating a flavor is typically admin-only.
* Link to the BDM docs for more details about BDM parameter values.
* Update the manage-ip-address docs to make the examples rely on
  using the networking resource CLIs rather than any proxy APIs
  that were available in nova.

Change-Id: Ifa2e2bbb4c5f51f13d1a5832bd7dbf9f690fcad7
This commit is contained in:
Matt Riedemann
2018-02-01 15:12:10 -05:00
parent 4ed5e81ee0
commit 49b1bf8c54
4 changed files with 29 additions and 37 deletions

View File

@@ -92,21 +92,6 @@ Follow the steps below to launch an instance from an image.
#. Copy the administrative password value from the ``adminPass`` field. Use the #. Copy the administrative password value from the ``adminPass`` field. Use the
password to log in to your server. password to log in to your server.
.. 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.
.. code-block:: console
$ openstack server create --image ubuntu-cloudimage --flavor 1 vm-name \
--file /root/.ssh/authorized_keys=special_authorized_keysfile
#. Check if the instance is online. #. Check if the instance is online.
.. code-block:: console .. code-block:: console

View File

@@ -250,6 +250,8 @@ the volume to boot an instance.
- ``NAME``. The name for the server. - ``NAME``. The name for the server.
See :doc:`block-device-mapping` for more details on these parameters.
#. Create a bootable volume from an image. Cinder makes a volume bootable #. Create a bootable volume from an image. Cinder makes a volume bootable
when ``--image`` parameter is passed. when ``--image`` parameter is passed.

View File

@@ -41,7 +41,8 @@ Before you can launch an instance, gather the following parameters:
policies, known as *security group rules*. policies, known as *security group rules*.
- If needed, you can assign a **floating (public) IP address** to a - If needed, you can assign a **floating (public) IP address** to a
running instance. running instance to make it accessible from outside the cloud. See
:doc:`manage-ip-addresses`.
- You can also attach a block storage device, or **volume**, for - You can also attach a block storage device, or **volume**, for
persistent storage. persistent storage.
@@ -53,10 +54,6 @@ Before you can launch an instance, gather the following parameters:
IP addresses to access the instances, you must modify the rules for IP addresses to access the instances, you must modify the rules for
the default security group. 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:`manage-ip-addresses`.
After you gather the parameters that you need to launch an instance, After you gather the parameters that you need to launch an instance,
you can launch it from an :doc:`image<launch-instance-from-image>` you can launch it from an :doc:`image<launch-instance-from-image>`
or a :doc:`volume<launch-instance-from-volume>`. You can launch an or a :doc:`volume<launch-instance-from-volume>`. You can launch an
@@ -72,6 +69,9 @@ Before you begin, source the OpenStack RC file.
#. Create a flavor. #. Create a flavor.
Creating a flavor is typically only available to administrators of a cloud
because this has implications for scheduling efficiently in the cloud.
.. code-block:: console .. code-block:: console
$ openstack flavor create --ram 512 --disk 1 --vcpus 1 m1.tiny $ openstack flavor create --ram 512 --disk 1 --vcpus 1 m1.tiny

View File

@@ -2,11 +2,6 @@
Manage IP addresses Manage IP addresses
=================== ===================
.. todo:: This needs quite a bit of work since nova-network has been
deprecated since Newton, and the network resource related compute
APIs which are for nova-network or that proxy to neutron have been
deprecated, along with their respective CLIs in python-novaclient.
Each instance has a private, fixed IP address and can also have a Each instance has a private, fixed IP address and can also have a
public, or floating IP address. Private IP addresses are used for public, or floating IP address. Private IP addresses are used for
communication between instances, and public addresses are used for communication between instances, and public addresses are used for
@@ -21,8 +16,7 @@ is available in OpenStack Compute. The project quota defines the maximum
number of floating IP addresses that you can allocate to the project. number of floating IP addresses that you can allocate to the project.
After you allocate a floating IP address to a project, you can: After you allocate a floating IP address to a project, you can:
- Associate the floating IP address with an instance of the project. Only one - Associate the floating IP address with an instance of the project.
floating IP address can be allocated to an instance at any given time.
- Disassociate a floating IP address from an instance in the project. - Disassociate a floating IP address from an instance in the project.
@@ -115,17 +109,35 @@ You can assign a floating IP address to a project and to an instance.
| 42290b01-0968-43... | VM2 | SHUTOFF | - | Shutdown | private=10.0.0.4 | centos | | 42290b01-0968-43... | VM2 | SHUTOFF | - | Shutdown | private=10.0.0.4 | centos |
+---------------------+------+---------+------------+-------------+------------------+------------+ +---------------------+------+---------+------------+-------------+------------------+------------+
Note the server ID to use.
#. List ports associated with the selected server.
.. code-block:: console
$ openstack port list --device-id SERVER_ID
+--------------------------------------+------+-------------------+--------------------------------------------------------------+--------+
| ID | Name | MAC Address | Fixed IP Addresses | Status |
+--------------------------------------+------+-------------------+--------------------------------------------------------------+--------+
| 40e9dea9-f457-458f-bc46-6f4ebea3c268 | | fa:16:3e:00:57:3e | ip_address='10.0.0.4', subnet_id='23ee9de7-362e- | ACTIVE |
| | | | 49e2-a3b0-0de1c14930cb' | |
| | | | ip_address='fd22:4c4c:81c2:0:f816:3eff:fe00:573e', subnet_id | |
| | | | ='a2b3acbe-fbeb-40d3-b21f-121268c21b55' | |
+--------------------------------------+------+-------------------+--------------------------------------------------------------+--------+
Note the port ID to use.
#. Associate an IP address with an instance in the project, as follows: #. Associate an IP address with an instance in the project, as follows:
.. code-block:: console .. code-block:: console
$ openstack server add floating ip INSTANCE_NAME_OR_ID FLOATING_IP_ADDRESS $ openstack floating ip set --port PORT_ID FLOATING_IP_ADDRESS
For example: For example:
.. code-block:: console .. code-block:: console
$ openstack server add floating ip VM1 172.24.4.225 $ openstack floating ip set --port 40e9dea9-f457-458f-bc46-6f4ebea3c268 172.24.4.225
The instance is now associated with two IP addresses: The instance is now associated with two IP addresses:
@@ -143,13 +155,6 @@ You can assign a floating IP address to a project and to an instance.
for the instance, the instance is publicly available at the floating IP for the instance, the instance is publicly available at the floating IP
address. address.
.. note::
The :command:`openstack server` command does not allow users to associate a
floating IP address with a specific fixed IP address using the optional
``--fixed-address`` parameter, which legacy commands required as an
argument.
Disassociate floating IP addresses Disassociate floating IP addresses
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -157,7 +162,7 @@ To disassociate a floating IP address from an instance:
.. code-block:: console .. code-block:: console
$ openstack server remove floating ip INSTANCE_NAME_OR_ID FLOATING_IP_ADDRESS $ openstack floating ip unset --port FLOATING_IP_ADDRESS
To remove the floating IP address from a project: To remove the floating IP address from a project: