Skip to content

Commit f611702

Browse files
committed
Replace Userdata with User data
1 parent 0ac80e9 commit f611702

File tree

10 files changed

+60
-60
lines changed

10 files changed

+60
-60
lines changed

source/adminguide/api.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,15 @@ User Data and Meta Data via Config Drive
9494
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9595

9696
Config drive is an ISO file that is mounted as a cd-rom on a user Instance and
97-
contains related userdata, metadata (incl. ssh-keys) and
97+
contains related user data, metadata (incl. ssh-keys) and
9898
password files.
9999

100100
Enable config drive
101101
~~~~~~~~~~~~~~~~~~~
102102
To use the config drive the Network offering must have the “ConfigDrive”
103-
provider selected for the userdata service.
103+
provider selected for the user data service.
104104

105-
If the networkoffering uses ConfigDrive for userdata and the Template is
105+
If the networkoffering uses ConfigDrive for user data and the Template is
106106
password enabled, the password string for the Instance is placed in the
107107
vm_password.txt file and it is included in the ISO.
108108

@@ -115,11 +115,11 @@ supporting 1 cd rom drive is still available.
115115

116116
At password reset or update of user data, the Config Drive ISO
117117
will be rebuilt. The existing ISO is mounted on a temporary directory,
118-
password, userdata or ssh-keys are updated and a new ISO is built from the
118+
password, user data or ssh-keys are updated and a new ISO is built from the
119119
updated directory structure.
120120

121121
In case of a password reset, the new password will be picked-up at Instance start.
122-
To access the updated userdata, the user needs to remount the config drive ISO.
122+
To access the updated user data, the user needs to remount the config drive ISO.
123123

124124
When an Instance is stopped, the ConfigDrive network element will trigger the
125125
Secondary Storage VM to remove the ISO from the secondary storage.

source/adminguide/autoscale_with_virtual_router.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Specify the following:
170170
For more information, see `“Affinity Groups”
171171
<virtual_machines.html#affinity-groups>`_.
172172

173-
- Userdata: The userdata of the Instances.
173+
- User data: The user data of the Instances.
174174

175175
For more information, see `“User-Data and Meta-Data”
176176
<virtual_machines.html#user-data-and-meta-data>`_.
@@ -287,7 +287,7 @@ then click Edit AutoScale Instance Profile button.
287287

288288
|autoscale-vmgroup-profile-update.png|
289289

290-
You are able to reset userdata of the Instance, by clicking Reset Userdata on AutoScale Instance Group button.
290+
You are able to reset user data of the Instance, by clicking Reset User data on AutoScale Instance Group button.
291291

292292
|autoscale-vmgroup-profile-reset-userdata.png|
293293

@@ -399,5 +399,5 @@ a service assigned to a rule inside the context of AutoScale.
399399
.. |autoscale-vmgroup-profile-update.png| image:: /_static/images/autoscale-vmgroup-profile-update.png
400400
:alt: Update AutoScale Instance Profile.
401401
.. |autoscale-vmgroup-profile-reset-userdata.png| image:: /_static/images/autoscale-vmgroup-profile-reset-userdata.png
402-
:alt: Reset Userdata in AutoScale Instance Profile.
402+
:alt: Reset User data in AutoScale Instance Profile.
403403

source/adminguide/networking.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ IP addresses.
106106

107107
- CloudStack does not assign IP addresses to instances.
108108

109-
- Userdata and metadata can be passed to the instance using a config drive
109+
- User data and metadata can be passed to the instance using a config drive
110110
(which must be enabled in the network service offering)
111111

112112
Example GUI dialog box (for a regular user account) is shown below:

source/adminguide/networking/dynamic_static_routing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Network mode indicates the mode with which the isolated network or VPC will oper
4141
There are two valid options
4242

4343
- NATTED. This is the default network mode of isolated networks. The VR of isolated networks and VPCs provides Source NAT services, as well as Static NAT, Load Balancer, Port Forwarding, Vpn if the network offering supports.
44-
- ROUTED. For isolated networks in ROUTED mode, the VR no longer supports Source NAT, Static NAT, Load Balancer, Port Forwarding and Vpn. The supported services are Dns, Dhcp, Userdata, Firewall (for isolated networks) and Network ACL (for vpc and vpc networks).
44+
- ROUTED. For isolated networks in ROUTED mode, the VR no longer supports Source NAT, Static NAT, Load Balancer, Port Forwarding and Vpn. The supported services are Dns, Dhcp, User data, Firewall (for isolated networks) and Network ACL (for vpc and vpc networks).
4545

4646

4747
About Routing mode

source/adminguide/systemvm.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -829,7 +829,7 @@ it is upgraded:
829829
830830
- SecurityGroup
831831
832-
- UserData
832+
- User Data
833833
834834
- DHCP
835835

source/adminguide/templates.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -271,11 +271,11 @@ To upload a Template:
271271
- **Tag**: The tag for the template. This tag can be used with host tags to
272272
allow deployment of Instances on specific hosts.
273273

274-
- **Userdata**: The registered Userdata are listed. Select the
274+
- **User data**: The registered User data are listed. Select the
275275
desired one.
276276

277-
- **Userdata link policy**: Select the userdata override policy as required.
278-
For more information on userdata and override link policy, please check `Userdata section <virtual_machines.html#user-data-and-meta-data>`_.
277+
- **User data link policy**: Select the user data override policy as required.
278+
For more information on user data and override link policy, please check `User data section <virtual_machines.html#user-data-and-meta-data>`_.
279279

280280

281281
- **Hypervisor**: The supported hypervisors are listed. Select the

source/adminguide/virtual_machines/user-data.rst

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -17,40 +17,40 @@
1717
User-Data and Meta-Data
1818
-----------------------
1919

20-
Users can register userdata in CloudStack and refer the registered userdata while
21-
deploying or editing or reset userdata on an instance. The userdata content can also be
22-
directly provided while deploying the instance. Userdata content length can be up to 32kb.
20+
Users can register user data in CloudStack and refer the registered user data while
21+
deploying or editing or reset user data on an instance. The user data content can also be
22+
directly provided while deploying the instance. User data content length can be up to 32kb.
2323

24-
To register a new userdata:
24+
To register a new user data:
2525

2626
#. Log in to the CloudStack UI.
2727

28-
#. In the left navigation bar, click Compute and then User Data.
28+
#. In the left navigation bar, click Compute and then User Data Library.
2929

30-
#. Click Register a userdata.
30+
#. Click Register user data.
3131

3232
#. In the dialog, make the following choices:
3333

34-
- **Name**: Any desired name for the userdata.
34+
- **Name**: Any desired name for the user data.
3535

36-
- **Userdata**: Plain userdata content. CloudStack UI does base64 encoding.
36+
- **User data**: Plain user data content. CloudStack UI does base64 encoding.
3737

38-
- **Userdata parameters**: Comma separated list of variables which (if any) declared
39-
in userdata content.
38+
- **User data parameters**: Comma separated list of variables which (if any) declared
39+
in user data content.
4040

41-
- **Domain**: An optional domain for the userdata.
41+
- **Domain**: An optional domain for the user data.
4242

43-
- **Account**: An optional account for the userdata.
43+
- **Account**: An optional account for the user data.
4444

4545
.. image:: /_static/images/register_userdata.png
4646
:width: 400px
4747
:align: center
48-
:alt: Regiser userdata dialog box
48+
:alt: Regiser user data dialog box
4949

50-
If userdata content has variables declared in it, user can register the Userdata
51-
with userdata parameters.
50+
If user data content has variables declared in it, user can register the User data
51+
with user data parameters.
5252

53-
For example, if userdata content is like below having a custom variable "variable1"
53+
For example, if user data content is like below having a custom variable "variable1"
5454

5555
.. code:: bash
5656
@@ -60,84 +60,84 @@ For example, if userdata content is like below having a custom variable "variabl
6060
- echo 'TestVariable {{ ds.meta_data.variable1 }}' >> /tmp/variable
6161
- echo 'Hostname {{ ds.meta_data.public_hostname }}' > /tmp/hostname
6262
63-
Userdata has to be registered with userdata parameter "variable1" like below
63+
User data has to be registered with user data parameter "variable1" like below
6464

6565
.. image:: /_static/images/register_userdata_with_variables.png
6666
:width: 400px
6767
:align: center
68-
:alt: Regiser userdata with variables dialog box
68+
:alt: Regiser user data with variables dialog box
6969

70-
If the variables in userdata content are of a predefined metadata like "public_hostname"
71-
or "instance_id", then userdata parameters should not declare these variables. That is
70+
If the variables in user data content are of a predefined metadata like "public_hostname"
71+
or "instance_id", then user data parameters should not declare these variables. That is
7272
the reason in the above example "public_hostname" is not declared.
7373

7474
There are three CloudStack APIs that can be used to provide user-data to instance:
7575
deployVirtualMachine, updateVirtualMachine and resetUserDataForVirtualMachine.
7676
These APIs accepts parameters ``userdataid`` and ``userdatadetails``.
7777
userdatadetails is to specify the custom values for the variables which are declared
78-
in userdata in a key value parameter map details.
78+
in user data in a key value parameter map details.
7979

8080
.. image:: /_static/images/deployvm_userdata.png
8181
:width: 400px
8282
:align: center
83-
:alt: Provide userdata id or userdata text dialog box
83+
:alt: Provide user data id or user data text dialog box
8484

85-
If the userdata contains variables that are declared during registration then those values
85+
If the user data contains variables that are declared during registration then those values
8686
has to be specified like below,
8787

8888
.. image:: /_static/images/deployvm_userdata_with_variables.png
8989
:width: 400px
9090
:align: center
91-
:alt: Provide userdata id or userdata with variables text dialog box
91+
:alt: Provide userdata id or user data with variables text dialog box
9292

9393
These details will be saved as meta-data file(s) in both config drive and virtual router,
9494
which in turn support jinja based instance meta-data feature of cloud-init,
9595
refer to https://cloudinit.readthedocs.io/en/latest/topics/instancedata.html.
9696

97-
These APIs also support the parameter ``userdata=`` to provide the userdata content
97+
These APIs also support the parameter ``userdata=`` to provide the user data content
9898
directly. The value for this parameter must be a `base64 <https://www.base64encode.org/>`_-encoded
9999
multi-part MIME message. See further below for an example of what this should look like.
100100

101-
The registered UserData can be linked to a Template or ISO on registration/upload/editing
102-
using linkUserDataToTemplate API. The same API can be used to unlink the mapping of userdata and Template.
101+
The registered User Data can be linked to a Template or ISO on registration/upload/editing
102+
using linkUserDataToTemplate API. The same API can be used to unlink the mapping of user data and Template.
103103

104-
While linking userData to a Template/ISO userdata override policy has to be specified.
104+
While linking user Data to a Template/ISO user data override policy has to be specified.
105105
Following are the override policies available:
106106

107-
Allow Override: Allow users to override UserData for the Template during instance deployment or on reset.
107+
Allow Override: Allow users to override User Data for the Template during instance deployment or on reset.
108108
This is the default override policy if not specified
109109

110-
Deny Override: Override of UserData isn’t allowed during instance deployment or on reset.
110+
Deny Override: Override of User Data isn’t allowed during instance deployment or on reset.
111111

112-
Append Only: Don’t allow users to override linked UserData but allow users to pass userdata content
113-
or ID that should be appended to the linked UserData of the Template. When the users pass userdata it is appended to the Template userdata in the form of a multipart MIME message
112+
Append Only: Don’t allow users to override linked User Data but allow users to pass user data content
113+
or ID that should be appended to the linked User Data of the Template. When the users pass user data it is appended to the Template user data in the form of a multipart MIME message
114114

115115
This is how it looks like in Template/ISO register/upload/edit forms.
116116

117117
.. image:: /_static/images/userdata_template_link.png
118118
:width: 400px
119119
:align: center
120-
:alt: Linking userdata to template/ISO
120+
:alt: Linking user data to template/ISO
121121

122122
Based on these override policies, "Add Instance" UI form provides relevant options to either
123-
override or append. If it is "Deny Override" then "Add Instance" will not allow adding user specific userdata
123+
override or append. If it is "Deny Override" then "Add Instance" will not allow adding user specific user data
124124

125-
Storing and accessing userdata
125+
Storing and accessing user data
126126
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127127

128128
HTTP GET parameters are limited to a length of 2048 bytes, but it is possible
129129
to store larger user-data blobs by sending them in the body via HTTP POST
130130
instead of GET.
131131

132132
From inside the instance, the user-data is accessible via the virtual router,
133-
if the UserData service is enabled on the network offering.
133+
if the User Data service is enabled on the network offering.
134134

135135
If you are using the DNS service of the virtual router, a special hostname
136136
called `data-server.` is provided, that will point to a valid user-data server.
137137

138138
Otherwise you have to determine the virtual router address via other means,
139139
such as DHCP leases. Be careful to scan all routers if you have multiple
140-
networks attached to an instance, in case not all of them have the UserData service
140+
networks attached to an instance, in case not all of them have the User Data service
141141
enabled.
142142

143143
User-data is available from the URL ``http://data-server./latest/user-data``
@@ -224,8 +224,8 @@ Custom user-data example
224224

225225
This example uses cloud-init to automatically update all OS packages on the first launch.
226226

227-
#. Register the following user-data in CloudStack. If APIs are used to register userdata or to
228-
provide direct userdata text then userdata needs to be wrapped into a multi-part MIME message
227+
#. Register the following user-data in CloudStack. If APIs are used to register user data or to
228+
provide direct user data text then user data needs to be wrapped into a multi-part MIME message
229229
and encoded in base64:
230230

231231
.. code:: bash
@@ -250,18 +250,18 @@ This example uses cloud-init to automatically update all OS packages on the firs
250250
package_upgrade: true
251251
EOF
252252
253-
#. Deploy an instance with this user-data either by providing the UUID of the registerd userdata
254-
or by providing base64 encoded userdata:
253+
#. Deploy an instance with this user-data either by providing the UUID of the registerd user data
254+
or by providing base64 encoded user data:
255255
256256
.. code:: bash
257257
258258
cmk deploy virtualmachine name=..... userdata=Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSIvLyIKTUlNRS1WZXJzaW9uOiAxLjAKCi0tLy8KQ29udGVudC1UeXBlOiB0ZXh0L2Nsb3VkLWNvbmZpZzsgY2hhcnNldD0idXMtYXNjaWkiCk1JTUUtVmVyc2lvbjogMS4wCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQKQ29udGVudC1EaXNwb3NpdGlvbjogYXR0YWNobWVudDsgZmlsZW5hbWU9ImNsb3VkLWNvbmZpZy50eHQiCgojY2xvdWQtY29uZmlnCgojIFVwZ3JhZGUgdGhlIGluc3RhbmNlIG9uIGZpcnN0IGJvb3QKIyAoaWUgcnVuIGFwdC1nZXQgdXBncmFkZSkKIwojIERlZmF1bHQ6IGZhbHNlCiMgQWxpYXNlczogYXB0X3VwZ3JhZGUKcGFja2FnZV91cGdyYWRlOiB0cnVlCg==
259259
260260
.. code:: bash
261261
262-
cmk deploy virtualmachine name=..... userdataid=<Userdata UUID>
262+
cmk deploy virtualmachine name=..... userdataid=<User data UUID>
263263
264-
.. note:: When using multipart userdata, cloud-init expects userdata format of one particular type only in one multipart section.
264+
.. note:: When using multipart user data, cloud-init expects user data format of one particular type only in one multipart section.
265265
266266
Disclaimer
267267
~~~~~~~~~~

source/conceptsandterminology/network_setup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ VPN support No Yes
5555
Port forwarding Physical Physical and Virtual
5656
1:1 NAT Physical Physical and Virtual
5757
Source NAT No Physical and Virtual
58-
Userdata Yes Yes
58+
User data Yes Yes
5959
Network usage monitoring sFlow / netFlow at physical router Hypervisor and Virtual Router
6060
DNS and DHCP Yes Yes
6161
========================= =================================== ===============================

source/plugins/ipv6.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ The following are not yet supported:
101101

102102
#. Security groups
103103

104-
#. Userdata and metadata
104+
#. User data and metadata
105105

106106
#. Passwords
107107

source/plugins/nsx-plugin.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The VMware NSX Plugin introduces VMware NSX 4 as a network service provider in C
2828
- Port Forwarding between “public” networks and VPC network tier
2929
- External load balancing – between VPCs network tiers and “public” networks (runs on Edge Cluster)
3030
- Internal load balancing – between VPC network tiers
31-
- Password injection, UserData and SSH Keys
31+
- Password injection, User Data and SSH Keys
3232
- External, Internal DNS
3333
- DHCP
3434
- Kubernetes host orchestration, supporting CKS on VPCs

0 commit comments

Comments
 (0)