Skip to content

Commit 65f540a

Browse files
Networking update and config drive (#225)
* Cleanup * Updated networking and added config drive * Renamed password file name * Changed L2 networks title * Changed headings * Review changes to config drive * Replaced missing section * Added change to storage * Update api.rst Co-authored-by: Andrija Panic <45762285+andrijapanicsb@users.noreply.github.com>
1 parent a6ce2d8 commit 65f540a

File tree

3 files changed

+23
-19
lines changed

3 files changed

+23
-19
lines changed

source/adminguide/api.rst

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,15 @@ possible as well. For example, see Using an LDAP Server for User
4343
Authentication.
4444

4545

46-
User Data and Meta Data via the Virtual Router
47-
----------------------------------------------
46+
User Data and Meta Data
47+
~~~~~~~~~~~~~~~~~~~~~~~
48+
49+
The user-data service on a Shared or Isolated Network can be provided through the
50+
Virtual Router or through an attached iso called the Config drive.
51+
52+
User Data and Meta Data Via Virtual Router
53+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54+
4855

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

5966
.. code:: bash
60-
6167
# cat /var/lib/dhclient/dhclient-eth0.leases | grep dhcp-server-identifier | tail -1
62-
6368
#. Access user data by running the following command using the result of
6469
the above command
6570

6671
.. code:: bash
67-
6872
# curl http://10.1.1.1/latest/user-data
69-
7073
Meta Data can be accessed similarly, using a URL of the form
7174
http://10.1.1.1/latest/meta-data/{metadata type}. (For backwards
7275
compatibility, the previous URL http://10.1.1.1/latest/{metadata type}
@@ -88,10 +91,7 @@ is also supported.) For metadata type, use one of the following:
8891
- instance-id. The instance name of the VM
8992

9093
User Data and Meta Data via Config Drive
91-
----------------------------------------
92-
93-
The user-data service on a Shared or L2 Network can be provided through the
94-
Virtual Router or through an attached iso called the Config drive.
94+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9595

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

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

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

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

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

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

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

130133
Supporting ConfigDrive
131134
~~~~~~~~~~~~~~~~~~~~~~
@@ -176,4 +179,4 @@ VMdata - a list of String arrays representing [“directory”, “filename”,
176179

177180
For more detailed information about the Config Drive implementation refer to
178181
the `Wiki Article
179-
<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>`_
182+
<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>`_

source/adminguide/networking.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ Basic zones or Advanced Zones with Security Groups.
8888
Network” <networking_and_traffic.html#configuring-a-shared-guest-network>`_.
8989

9090

91-
L2 Networks
92-
~~~~~~~~~~~
91+
L2 (Layer 2) Networks
92+
~~~~~~~~~~~~~~~~~~~~~
9393

9494
L2 networks provide network isolation without any other services. This
9595
means that there will be no virtual router. It is assumed that the end

source/adminguide/networking/advanced_zone_config.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ configure the base guest network:
6060
want to assign a special domain name to the guest VM network, specify a
6161
DNS suffix.
6262

63+
6364
#. Click OK.
6465

6566

0 commit comments

Comments
 (0)