Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions source/adminguide/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,15 @@ possible as well. For example, see Using an LDAP Server for User
Authentication.


User Data and Meta Data via the Virtual Router
----------------------------------------------
User Data and Meta Data
~~~~~~~~~~~~~~~~~~~~~~~

The user-data service on a Shared or Isolated Network can be provided through the
Virtual Router or through an attached iso called the Config drive.

User Data and Meta Data Via Virtual Router
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


CloudStack provides API access to attach up to 32KB of user data to a
deployed VM. Deployed VMs also have access to instance metadata via the
Expand All @@ -57,16 +64,12 @@ the user data:
#. Run the following command to find the virtual router.

.. code:: bash

# cat /var/lib/dhclient/dhclient-eth0.leases | grep dhcp-server-identifier | tail -1

#. Access user data by running the following command using the result of
the above command

.. code:: bash

# curl http://10.1.1.1/latest/user-data

Meta Data can be accessed similarly, using a URL of the form
http://10.1.1.1/latest/meta-data/{metadata type}. (For backwards
compatibility, the previous URL http://10.1.1.1/latest/{metadata type}
Expand All @@ -88,10 +91,7 @@ is also supported.) For metadata type, use one of the following:
- instance-id. The instance name of the VM

User Data and Meta Data via Config Drive
----------------------------------------

The user-data service on a Shared or L2 Network can be provided through the
Virtual Router or through an attached iso called the Config drive.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Config drive is an ISO file that is mounted as a cd-rom on a user VM and
contains the user VM related userdata, metadata (incl. ssh-keys) and
Expand All @@ -103,8 +103,8 @@ To use the config drive the network offering must have the “ConfigDrive”
provider selected for the userdata service.

If the networkoffering uses ConfigDrive for userdata and the template is
password enabled, the password string for the VM is placed in password.txt file
and it is included in the ISO.
password enabled, the password string for the VM is placed in the
vm_password.txt file and it is included in the ISO.

ConfigDrive availability
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -113,8 +113,8 @@ user instance, such that any other ISO image (e.g. boot image or vmware tools)
is mounted on 1st cd/dvd drive. This means existing functionality of
supporting 1 cd rom drive is still available.

At Password reset or update of user data, Secondary Storage VM will rebuild the
ConfigDrive ISO image. That is the existing ISO is mounted on a temporary directory,
At password reset or update of user data, the Config Drive ISO
will be rebuilt. The existing ISO is mounted on a temporary directory,
password, userdata or ssh-keys are updated and a new ISO is built from the
updated directory structure.

Expand All @@ -123,9 +123,12 @@ To access the updated userdata, the user needs to remount the config drive ISO.

When a VM is stopped, the ConfigDrive network element will trigger the
Secondary Storage VM to remove the ISO from the secondary storage.
If the config drive is stored on primary storage, the network element will
trigger the host to remove the ISO.

Since the ISO is available on secondary storage, there is no need for an extra
implementation in case of migration.
The config drive ISO can be stored on primary storage by setting the global
setting vm.configdrive.primarypool.enabled to true. This is currently only
supported with use of the KVM Hypervisor.

Supporting ConfigDrive
~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -176,4 +179,4 @@ VMdata - a list of String arrays representing [“directory”, “filename”,

For more detailed information about the Config Drive implementation refer to
the `Wiki Article
<https://cwiki.apache.org/confluence/display/CLOUDSTACK/Using+ConfigDrive+for+Metadata%2C+Userdata+and+Password#:~:text=CLOUDSTACK%2D9813%20%2D%20(),%2Dkeys)%20and%20password%20files>`_
<https://cwiki.apache.org/confluence/display/CLOUDSTACK/Using+ConfigDrive+for+Metadata%2C+Userdata+and+Password#:~:text=CLOUDSTACK%2D9813%20%2D%20(),%2Dkeys)%20and%20password%20files>`_
4 changes: 2 additions & 2 deletions source/adminguide/networking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ Basic zones or Advanced Zones with Security Groups.
Network” <networking_and_traffic.html#configuring-a-shared-guest-network>`_.


L2 Networks
~~~~~~~~~~~
L2 (Layer 2) Networks
~~~~~~~~~~~~~~~~~~~~~

L2 networks provide network isolation without any other services. This
means that there will be no virtual router. It is assumed that the end
Expand Down
1 change: 1 addition & 0 deletions source/adminguide/networking/advanced_zone_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ configure the base guest network:
want to assign a special domain name to the guest VM network, specify a
DNS suffix.


#. Click OK.


Expand Down