This is an automated email from the ASF dual-hosted git repository.
sureshanaparti pushed a commit to branch 4.20
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
The following commit(s) were added to refs/heads/4.20 by this push:
new f285c3f polish: Fix some inconsistencies in object names and messages
(#506)
f285c3f is described below
commit f285c3f200e83e21e9575679da2a2fcd661ae970
Author: Abhisar Sinha <[email protected]>
AuthorDate: Mon Jul 28 18:54:14 2025 +0530
polish: Fix some inconsistencies in object names and messages (#506)
* Replace ACL List with ACL
* Replace Userdata with User Data
* Addressed review comments and updated screenshots
---
source/_static/images/deployvm_userdata.png | Bin 28071 -> 88487 bytes
.../images/deployvm_userdata_with_variables.png | Bin 32033 -> 102521 bytes
source/_static/images/register_userdata.png | Bin 31148 -> 124595 bytes
.../images/register_userdata_with_variables.png | Bin 33407 -> 103043 bytes
source/_static/images/userdata_template_link.png | Bin 64782 -> 231420 bytes
source/adminguide/api.rst | 22 ++--
.../adminguide/autoscale_with_virtual_router.rst | 10 +-
source/adminguide/networking.rst | 6 +-
.../networking/dynamic_static_routing.rst | 4 +-
source/adminguide/networking/remote_access_vpn.rst | 2 +-
source/adminguide/networking/site_to_site_vpn.rst | 6 +-
.../networking/virtual_private_cloud_config.rst | 64 +++++------
source/adminguide/reliability.rst | 2 +-
source/adminguide/systemvm.rst | 2 +-
source/adminguide/templates.rst | 6 +-
source/adminguide/templates/_cloud_init.rst | 6 +-
source/adminguide/templates/_create_linux.rst | 4 +-
source/adminguide/virtual_machines/user-data.rst | 120 ++++++++++-----------
source/conceptsandterminology/network_setup.rst | 2 +-
source/plugins/ipv6.rst | 6 +-
source/plugins/nsx-plugin.rst | 2 +-
21 files changed, 132 insertions(+), 132 deletions(-)
diff --git a/source/_static/images/deployvm_userdata.png
b/source/_static/images/deployvm_userdata.png
index bcc249d..e26c20b 100644
Binary files a/source/_static/images/deployvm_userdata.png and
b/source/_static/images/deployvm_userdata.png differ
diff --git a/source/_static/images/deployvm_userdata_with_variables.png
b/source/_static/images/deployvm_userdata_with_variables.png
index 59089c1..eca4733 100644
Binary files a/source/_static/images/deployvm_userdata_with_variables.png and
b/source/_static/images/deployvm_userdata_with_variables.png differ
diff --git a/source/_static/images/register_userdata.png
b/source/_static/images/register_userdata.png
index 8ac4fcc..43ca382 100644
Binary files a/source/_static/images/register_userdata.png and
b/source/_static/images/register_userdata.png differ
diff --git a/source/_static/images/register_userdata_with_variables.png
b/source/_static/images/register_userdata_with_variables.png
index 463baac..9a53515 100644
Binary files a/source/_static/images/register_userdata_with_variables.png and
b/source/_static/images/register_userdata_with_variables.png differ
diff --git a/source/_static/images/userdata_template_link.png
b/source/_static/images/userdata_template_link.png
index 5138393..1db5005 100644
Binary files a/source/_static/images/userdata_template_link.png and
b/source/_static/images/userdata_template_link.png differ
diff --git a/source/adminguide/api.rst b/source/adminguide/api.rst
index 48bdeb6..2ea4c64 100644
--- a/source/adminguide/api.rst
+++ b/source/adminguide/api.rst
@@ -46,26 +46,26 @@ Authentication.
User Data and Meta Data
~~~~~~~~~~~~~~~~~~~~~~~
-The user-data service on a Shared or Isolated Network can be provided through
the
+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
+CloudStack provides API access to attach up to 32KB of User Data to a
deployed Instance. Deployed Instances also have access to metadata via the
virtual router.
-User data can be accessed once the IP address of the virtual router is
+User Data can be accessed once the IP address of the virtual router is
known. Once the IP address is known, use the following steps to access
-the user data:
+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
+#. Access User Data by running the following command using the result of
the above command
.. code:: bash
@@ -94,15 +94,15 @@ User Data and Meta Data via Config Drive
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Config drive is an ISO file that is mounted as a cd-rom on a user Instance and
-contains related userdata, metadata (incl. ssh-keys) and
+contains related User Data, metadata (incl. ssh-keys) and
password files.
Enable config drive
~~~~~~~~~~~~~~~~~~~
To use the config drive the Network offering must have the “ConfigDrive”
-provider selected for the userdata service.
+provider selected for the User Data service.
-If the networkoffering uses ConfigDrive for userdata and the Template is
+If the networkoffering uses ConfigDrive for User Data and the Template is
password enabled, the password string for the Instance is placed in the
vm_password.txt file and it is included in the ISO.
@@ -113,13 +113,13 @@ 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, the Config Drive ISO
+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
+password, User Data or ssh-keys are updated and a new ISO is built from the
updated directory structure.
In case of a password reset, the new password will be picked-up at Instance
start.
-To access the updated userdata, the user needs to remount the config drive ISO.
+To access the updated User Data, the user needs to remount the config drive
ISO.
When an Instance is stopped, the ConfigDrive network element will trigger the
Secondary Storage VM to remove the ISO from the secondary storage.
diff --git a/source/adminguide/autoscale_with_virtual_router.rst
b/source/adminguide/autoscale_with_virtual_router.rst
index 7e7be10..4370fec 100644
--- a/source/adminguide/autoscale_with_virtual_router.rst
+++ b/source/adminguide/autoscale_with_virtual_router.rst
@@ -170,10 +170,10 @@ Specify the following:
For more information, see `“Affinity Groups”
<virtual_machines.html#affinity-groups>`_.
-- Userdata: The userdata of the Instances.
+- User Data: The User Data of the Instances.
- For more information, see `“User-Data and Meta-Data”
- <virtual_machines.html#user-data-and-meta-data>`_.
+ For more information, see `“User Data and Metadata”
+ <virtual_machines.html#user-data-and-metadata>`_.
AutoScale Policies
@@ -287,7 +287,7 @@ then click Edit AutoScale Instance Profile button.
|autoscale-vmgroup-profile-update.png|
-You are able to reset userdata of the Instance, by clicking Reset Userdata on
AutoScale Instance Group button.
+You are able to reset User Data of the Instance, by clicking Reset User Data
on AutoScale Instance Group button.
|autoscale-vmgroup-profile-reset-userdata.png|
@@ -399,5 +399,5 @@ a service assigned to a rule inside the context of
AutoScale.
.. |autoscale-vmgroup-profile-update.png| image::
/_static/images/autoscale-vmgroup-profile-update.png
:alt: Update AutoScale Instance Profile.
.. |autoscale-vmgroup-profile-reset-userdata.png| image::
/_static/images/autoscale-vmgroup-profile-reset-userdata.png
- :alt: Reset Userdata in AutoScale Instance Profile.
+ :alt: Reset User Data in AutoScale Instance Profile.
diff --git a/source/adminguide/networking.rst b/source/adminguide/networking.rst
index df18c75..f0cf3c1 100644
--- a/source/adminguide/networking.rst
+++ b/source/adminguide/networking.rst
@@ -106,7 +106,7 @@ IP addresses.
- CloudStack does not assign IP addresses to instances.
-- Userdata and metadata can be passed to the instance using a config drive
+- User Data and metadata can be passed to the instance using a config drive
(which must be enabled in the network service offering)
Example GUI dialog box (for a regular user account) is shown below:
@@ -367,8 +367,8 @@ To create a network offering:
been configured in the cloud.
VPN For more information, see `“Remote Access
Supported Not Supported
VPN”
<networking_and_traffic.html#remote-access-vpn>`_.
- User Data For more information, see `“User Data and Meta
Not Supported Supported
- Data” <api.html#user-data-and-meta-data>`_.
+ User Data For more information, see `“User Data and Metadata
Not Supported Supported
+ ” <api.html#user-data-and-metadata>`_.
Network ACL For more information, see `“Configuring Network
Access Control List Supported Not Supported
”
<networking_and_traffic.html#configuring-network-access-control-list>`_.
Security Groups For more information, see `“Adding a Security
Not Supported Supported
diff --git a/source/adminguide/networking/dynamic_static_routing.rst
b/source/adminguide/networking/dynamic_static_routing.rst
index f86497e..7bc126d 100644
--- a/source/adminguide/networking/dynamic_static_routing.rst
+++ b/source/adminguide/networking/dynamic_static_routing.rst
@@ -40,8 +40,8 @@ About Network Mode
Network mode indicates the mode with which the isolated network or VPC will
operate.
There are two valid options
-- 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.
-- 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).
+- 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.
+- 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).
About Routing mode
diff --git a/source/adminguide/networking/remote_access_vpn.rst
b/source/adminguide/networking/remote_access_vpn.rst
index ffa4582..1947fd6 100644
--- a/source/adminguide/networking/remote_access_vpn.rst
+++ b/source/adminguide/networking/remote_access_vpn.rst
@@ -133,7 +133,7 @@ To enable VPN for a VPC:
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. In the Router node, select Public IP Addresses.
diff --git a/source/adminguide/networking/site_to_site_vpn.rst
b/source/adminguide/networking/site_to_site_vpn.rst
index 33d3ccb..29aeea7 100644
--- a/source/adminguide/networking/site_to_site_vpn.rst
+++ b/source/adminguide/networking/site_to_site_vpn.rst
@@ -236,7 +236,7 @@ Creating a VPN gateway for the VPC
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. Select Site-to-Site VPN.
@@ -299,7 +299,7 @@ Creating a VPN Connection
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. Select Site-to-Site VPN.
@@ -431,7 +431,7 @@ Restarting and Removing a VPN Connection
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. Select Site-to-Site VPN.
diff --git a/source/adminguide/networking/virtual_private_cloud_config.rst
b/source/adminguide/networking/virtual_private_cloud_config.rst
index 2448b27..9edcc5c 100644
--- a/source/adminguide/networking/virtual_private_cloud_config.rst
+++ b/source/adminguide/networking/virtual_private_cloud_config.rst
@@ -315,8 +315,8 @@ Define a Network Access Control List (ACL) to control
incoming
(ingress) and outgoing (egress) traffic between the associated Network Tier
and external Networks (other Network Tiers of the VPC as well as public
Networks).
-About Network ACL Lists
-^^^^^^^^^^^^^^^^^^^^^^^
+About Network ACLs
+^^^^^^^^^^^^^^^^^^
In CloudStack terminology, a Network ACL is a group of Network ACL rules.
Network ACL rules are processed by their order, starting with the lowest
@@ -357,8 +357,8 @@ Afterwards traffic can be white- or blacklisted.
connection
-Creating ACL Lists
-^^^^^^^^^^^^^^^^^^
+Creating ACLs
+^^^^^^^^^^^^^
#. Log in to the CloudStack UI as an administrator or end User.
@@ -391,18 +391,18 @@ Creating ACL Lists
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
-#. Select Network ACL Lists.
+#. Select Network ACLs.
The following default rules are displayed in the Network ACLs page:
default\_allow, default\_deny.
-#. Click Add ACL Lists, and specify the following:
+#. Click Add Network ACL, and specify the following:
- - **ACL List Name**: A name for the ACL list.
+ - **ACL Name**: A name for the ACL.
- - **Description**: A short description of the ACL list that can be
+ - **Description**: A short description of the ACL that can be
displayed to users.
@@ -420,15 +420,15 @@ Creating an ACL Rule
#. Click the Configure button of the VPC.
-#. Select Network ACL Lists.
+#. Select Network ACLs.
- In addition to the custom ACL lists you have created, the following
+ In addition to the custom ACLs you have created, the following
default rules are displayed in the Network ACLs page: default\_allow,
default\_deny.
-#. Select the desired ACL list.
+#. Select the desired ACL.
-#. Select the ACL List Rules tab.
+#. Select the ACL Rules tab.
To add an ACL rule, fill in the following fields to specify what kind
of network traffic is allowed in the VPC.
@@ -471,24 +471,24 @@ Creating an ACL Rule
tab.
-Creating a Tier with Custom ACL List
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Creating a Tier with Custom ACL
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#. Create a VPC.
-#. Create a custom ACL list.
+#. Create a custom ACL.
-#. Add ACL rules to the ACL list.
+#. Add ACL rules to the ACL.
#. Create a tier in the VPC.
- Select the desired ACL list while creating a tier.
+ Select the desired ACL while creating a tier.
#. Click OK.
-Assigning a Custom ACL List to a Tier
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Assigning a Custom ACL to a Tier
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#. Create a VPC.
@@ -496,17 +496,17 @@ Assigning a Custom ACL List to a Tier
#. Associate the tier with the default ACL rule.
-#. Create a custom ACL list.
+#. Create a custom ACL.
-#. Add ACL rules to the ACL list.
+#. Add ACL rules to the ACL.
#. Select the tier for which you want to assign the custom ACL.
-#. Click the Replace ACL List icon. |replace-acl-icon.png|
+#. Click the Replace ACL icon. |replace-acl-icon.png|
- The Replace ACL List dialog is displayed.
+ The Replace ACL dialog is displayed.
-#. Select the desired ACL list.
+#. Select the desired ACL.
#. Click OK.
@@ -558,7 +558,7 @@ with duplicated VLAN and IP are allowed in the same data
center.
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. Select Private Gateways.
@@ -801,7 +801,7 @@ associated to more than one network at a time.
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. Select IP Addresses.
@@ -859,7 +859,7 @@ still belongs to the same VPC.
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. Select Public IP Addresses.
@@ -920,7 +920,7 @@ function only if they are defined on the default network.
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. In the Router node, select Public IP Addresses.
@@ -1086,7 +1086,7 @@ Creating an External LB Rule
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. In the Router node, select Public IP Addresses.
@@ -1354,7 +1354,7 @@ Adding a Port Forwarding Rule on a VPC
- Site-to-Site VPNs
- - Network ACL Lists
+ - Network ACLs
#. In the Router node, select Public IP Addresses.
@@ -1473,7 +1473,7 @@ is not required.
.. |add-tier.png| image:: /_static/images/add-tier.png
:alt: adding a tier to a vpc.
.. |replace-acl-icon.png| image:: /_static/images/replace-acl-icon.png
- :alt: button to replace an ACL list
+ :alt: button to replace an ACL
.. |add-new-gateway-vpc2.png| image:: /_static/images/add-new-gateway-vpc2.png
:alt: adding a private gateway for the VPC.
.. |add-vm-vpc.png| image:: /_static/images/add-vm-vpc.png
diff --git a/source/adminguide/reliability.rst
b/source/adminguide/reliability.rst
index 62bdcf5..ff0bb63 100644
--- a/source/adminguide/reliability.rst
+++ b/source/adminguide/reliability.rst
@@ -320,7 +320,7 @@ with the selected Template for a User. A User may also not
be able to save
Templates or examine/restore saved Templates. These features will
automatically be available when the secondary storage comes back online.
-Secondary storage data loss will impact recently added User data
+Secondary storage data loss will impact recently added user data
including Templates, Snapshots, and ISO Images. Secondary storage should
be backed up periodically. Multiple secondary storage servers can be
provisioned within each zone to increase the scalability of the system.
diff --git a/source/adminguide/systemvm.rst b/source/adminguide/systemvm.rst
index d88561e..7812b42 100644
--- a/source/adminguide/systemvm.rst
+++ b/source/adminguide/systemvm.rst
@@ -829,7 +829,7 @@ it is upgraded:
- SecurityGroup
-- UserData
+- User Data
- DHCP
diff --git a/source/adminguide/templates.rst b/source/adminguide/templates.rst
index e92db41..652e3b1 100644
--- a/source/adminguide/templates.rst
+++ b/source/adminguide/templates.rst
@@ -271,11 +271,11 @@ To upload a Template:
- **Tag**: The tag for the template. This tag can be used with host tags to
allow deployment of Instances on specific hosts.
- - **Userdata**: The registered Userdata are listed. Select the
+ - **User Data**: The registered User Data entries are listed. Select the
desired one.
- - **Userdata link policy**: Select the userdata override policy as
required.
- For more information on userdata and override link policy, please check
`Userdata section <virtual_machines.html#user-data-and-meta-data>`_.
+ - **User Data link policy**: Select the User Data override policy as
required.
+ For more information on User Data and override link policy, please check
`User Data section <virtual_machines.html#user-data-and-metadata>`_.
- **Hypervisor**: The supported hypervisors are listed. Select the
diff --git a/source/adminguide/templates/_cloud_init.rst
b/source/adminguide/templates/_cloud_init.rst
index 1494308..c178575 100644
--- a/source/adminguide/templates/_cloud_init.rst
+++ b/source/adminguide/templates/_cloud_init.rst
@@ -22,7 +22,7 @@ Cloudstack and cloud-init integration provide Instances with
advanced management
* Password management
* SSH keys management
* Partition management
-* User-data input
+* User Data input
* `Other modules
<https://cloudinit.readthedocs.io/en/latest/topics/modules.html>`_
@@ -211,9 +211,9 @@ These features can be implemented in `“Linux Template
creation process” <_cr
sudo sed -i s/" - runcmd"/" - [runcmd, always]"/g /etc/cloud/cloud.cfg
sudo sed -i s/" - scripts-user"/" - [scripts-user, always]"/g
/etc/cloud/cloud.cfg
-#. **User-data**
+#. **User Data**
- Cloud-init can parse and execute user-data form Cloud-stack during Instance
creation. This feature works as is without additional configuration.
+ Cloud-init can parse and execute User Data form Cloud-stack during Instance
creation. This feature works as is without additional configuration.
#. **Network configuration with ConfigDrive**
diff --git a/source/adminguide/templates/_create_linux.rst
b/source/adminguide/templates/_create_linux.rst
index 895e2e0..503acfa 100644
--- a/source/adminguide/templates/_create_linux.rst
+++ b/source/adminguide/templates/_create_linux.rst
@@ -129,9 +129,9 @@ templating of Centos and Ubuntu.
Volumes can autorextend after reboot when partition is extended in the GUI.
This feature is possible with `Cloud-init integration
<templates/_cloud_init.html#linux-with-cloud-init>`_.
-#. **User-data**
+#. **User Data**
- Cloudstack can push user-data during Instance creation.
+ Cloudstack can push User Data during Instance creation.
This feature is possible with `Cloud-init integration
<templates/_cloud_init.html#linux-with-cloud-init>`_.
#. **Template cleanup**
diff --git a/source/adminguide/virtual_machines/user-data.rst
b/source/adminguide/virtual_machines/user-data.rst
index 1c715e1..7dcd2e7 100644
--- a/source/adminguide/virtual_machines/user-data.rst
+++ b/source/adminguide/virtual_machines/user-data.rst
@@ -14,43 +14,43 @@
under the License.
-User-Data and Meta-Data
------------------------
+User Data and Metadata
+----------------------
-Users can register userdata in CloudStack and refer the registered userdata
while
-deploying or editing or reset userdata on an instance. The userdata content
can also be
-directly provided while deploying the instance. Userdata content length can be
up to 32kb.
+Users can register User Data in CloudStack and refer the registered User Data
while
+deploying or editing or reset User Data on an instance. The User Data content
can also be
+directly provided while deploying the instance. User Data content length can
be up to 32kb.
-To register a new userdata:
+To register a new User Data:
#. Log in to the CloudStack UI.
-#. In the left navigation bar, click Compute and then User Data.
+#. In the left navigation bar, click Compute and then User Data Library.
-#. Click Register a userdata.
+#. Click Register User Data.
#. In the dialog, make the following choices:
- - **Name**: Any desired name for the userdata.
+ - **Name**: Any desired name for the User Data.
- - **Userdata**: Plain userdata content. CloudStack UI does base64 encoding.
+ - **User Data**: Plain User Data content. CloudStack UI does base64
encoding.
- - **Userdata parameters**: Comma separated list of variables which (if
any) declared
- in userdata content.
+ - **User Data parameters**: Comma separated list of variables which (if
any) declared
+ in the User Data content.
- - **Domain**: An optional domain for the userdata.
+ - **Domain**: An optional domain for the User Data.
- - **Account**: An optional account for the userdata.
+ - **Account**: An optional account for the User Data.
.. image:: /_static/images/register_userdata.png
:width: 400px
:align: center
- :alt: Regiser userdata dialog box
+ :alt: Regiser User Data dialog box
-If userdata content has variables declared in it, user can register the
Userdata
-with userdata parameters.
+If User Data content has variables declared in it, user can register the User
Data
+with User Data parameters.
-For example, if userdata content is like below having a custom variable
"variable1"
+For example, if User Data content is like below having a custom variable
"variable1"
.. code:: bash
@@ -60,87 +60,87 @@ For example, if userdata content is like below having a
custom variable "variabl
- echo 'TestVariable {{ ds.meta_data.variable1 }}' >> /tmp/variable
- echo 'Hostname {{ ds.meta_data.public_hostname }}' > /tmp/hostname
-Userdata has to be registered with userdata parameter "variable1" like below
+User Data has to be registered with the parameter "variable1" like below
.. image:: /_static/images/register_userdata_with_variables.png
:width: 400px
:align: center
- :alt: Regiser userdata with variables dialog box
+ :alt: Register User Data with variables dialog box
-If the variables in userdata content are of a predefined metadata like
"public_hostname"
-or "instance_id", then userdata parameters should not declare these variables.
That is
+If the variables in User Data content are of a predefined metadata like
"public_hostname"
+or "instance_id", then User Data parameters should not declare these
variables. That is
the reason in the above example "public_hostname" is not declared.
-There are three CloudStack APIs that can be used to provide user-data to
instance:
+There are three CloudStack APIs that can be used to provide User Data to
instance:
deployVirtualMachine, updateVirtualMachine and resetUserDataForVirtualMachine.
These APIs accepts parameters ``userdataid`` and ``userdatadetails``.
userdatadetails is to specify the custom values for the variables which are
declared
-in userdata in a key value parameter map details.
+in User Data in a key value parameter map details.
.. image:: /_static/images/deployvm_userdata.png
:width: 400px
:align: center
- :alt: Provide userdata id or userdata text dialog box
+ :alt: Provide User Data id or User Data text dialog box
-If the userdata contains variables that are declared during registration then
those values
+If the User Data contains variables that are declared during registration then
those values
has to be specified like below,
.. image:: /_static/images/deployvm_userdata_with_variables.png
:width: 400px
:align: center
- :alt: Provide userdata id or userdata with variables text dialog box
+ :alt: Provide userdata id or User Data with variables text dialog box
-These details will be saved as meta-data file(s) in both config drive and
virtual router,
-which in turn support jinja based instance meta-data feature of cloud-init,
+These details will be saved as metadata file(s) in both config drive and
virtual router,
+which in turn support jinja based instance metadata feature of cloud-init,
refer to https://cloudinit.readthedocs.io/en/latest/topics/instancedata.html.
-These APIs also support the parameter ``userdata=`` to provide the userdata
content
+These APIs also support the parameter ``userdata=`` to provide the User Data
content
directly. The value for this parameter must be a `base64
<https://www.base64encode.org/>`_-encoded
multi-part MIME message. See further below for an example of what this should
look like.
-The registered UserData can be linked to a Template or ISO on
registration/upload/editing
-using linkUserDataToTemplate API. The same API can be used to unlink the
mapping of userdata and Template.
+The registered User Data can be linked to a Template or ISO on
registration/upload/editing
+using linkUserDataToTemplate API. The same API can be used to unlink the
mapping of User Data and Template.
-While linking userData to a Template/ISO userdata override policy has to be
specified.
+While linking User Data to a Template/ISO User Data override policy has to be
specified.
Following are the override policies available:
-Allow Override: Allow users to override UserData for the Template during
instance deployment or on reset.
+Allow Override: Allow users to override User Data for the Template during
instance deployment or on reset.
This is the default override policy if not specified
-Deny Override: Override of UserData isn’t allowed during instance deployment
or on reset.
+Deny Override: Override of User Data isn’t allowed during instance deployment
or on reset.
-Append Only: Don’t allow users to override linked UserData but allow users to
pass userdata content
- 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
+Append Only: Don’t allow users to override linked User Data but allow users to
pass User Data content
+ 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
This is how it looks like in Template/ISO register/upload/edit forms.
.. image:: /_static/images/userdata_template_link.png
:width: 400px
:align: center
- :alt: Linking userdata to template/ISO
+ :alt: Linking User Data to template/ISO
Based on these override policies, "Add Instance" UI form provides relevant
options to either
-override or append. If it is "Deny Override" then "Add Instance" will not
allow adding user specific userdata
+override or append. If it is "Deny Override" then "Add Instance" will not
allow adding user specific User Data
-Storing and accessing userdata
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Storing and accessing User Data
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
HTTP GET parameters are limited to a length of 2048 bytes, but it is possible
-to store larger user-data blobs by sending them in the body via HTTP POST
+to store larger User Data blobs by sending them in the body via HTTP POST
instead of GET.
-From inside the instance, the user-data is accessible via the virtual router,
-if the UserData service is enabled on the network offering.
+From inside the instance, the User Data is accessible via the virtual router,
+if the User Data service is enabled on the network offering.
If you are using the DNS service of the virtual router, a special hostname
-called `data-server.` is provided, that will point to a valid user-data server.
+called `data-server.` is provided, that will point to a valid User Data server.
Otherwise you have to determine the virtual router address via other means,
such as DHCP leases. Be careful to scan all routers if you have multiple
-networks attached to an instance, in case not all of them have the UserData
service
+networks attached to an instance, in case not all of them have the User Data
service
enabled.
-User-data is available from the URL ``http://data-server./latest/user-data``
+User Data is available from the URL ``http://data-server./latest/user-data``
and can be fetched via curl or other HTTP client.
It is also possible to fetch instance metadata from the same service, via the
URL
@@ -168,7 +168,7 @@ Determining the virtual router address without DNS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If can't or don't want to use the virtual router's DNS service, it's also
-possible to determine the user-data server from a DHCP lease.
+possible to determine the User Data server from a DHCP lease.
#. Run the following command to find the virtual router.
@@ -176,18 +176,18 @@ possible to determine the user-data server from a DHCP
lease.
# cat /var/lib/dhcp/dhclient.eth0.leases | grep dhcp-server-identifier |
tail -1
-#. Access the data-server via its IP
+#. Access the User Data server via its IP
.. code:: bash
# curl http://10.1.1.1/latest/user-data
-Fetching user-data via the API
+Fetching User Data via the API
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-User-data is not included with the normal instance state for historic reasons.
-To read out the base64-encoded user-data via the API, use the
`getVirtualMachineUserData
<https://cloudstack.apache.org/docs/api/apidocs-4.14/user/getVirtualMachineUserData.html>`_
+User Data is not included with the normal instance state for historic reasons.
+To read out the base64-encoded User Data via the API, use the
`getVirtualMachineUserData
<https://cloudstack.apache.org/docs/api/apidocs-4.14/user/getVirtualMachineUserData.html>`_
API call:
.. code:: bash
@@ -199,7 +199,7 @@ Using cloud-init
~~~~~~~~~~~~~~~~
`cloud-init <https://cloudinit.readthedocs.org/en/latest>`_ can be used to
access
-and interpret user-data inside Instances. If you install cloud-init into your
+and interpret User Data inside Instances. If you install cloud-init into your
Instance Templates, it will allow you to store SSH keys and user passwords on
each new
Instance deployment automatically
(:ref:`adding-password-management-to-templates` and `using ssh keys
<virtual_machines.html#using-ssh-keys-for-authentication>`_).
@@ -219,13 +219,13 @@ Instance deployment automatically
(:ref:`adding-password-management-to-templates
For more information, see `Cloud-init integration
<templates/_cloud_init.html#linux-with-cloud-init>`_
-Custom user-data example
+Custom User Data example
~~~~~~~~~~~~~~~~~~~~~~~~
This example uses cloud-init to automatically update all OS packages on the
first launch.
-#. Register the following user-data in CloudStack. If APIs are used to
register userdata or to
- provide direct userdata text then userdata needs to be wrapped into a
multi-part MIME message
+#. Register the following User Data in CloudStack. If APIs are used to
register User Data or to
+ provide direct User Data text then User Data needs to be wrapped into a
multi-part MIME message
and encoded in base64:
.. code:: bash
@@ -250,8 +250,8 @@ This example uses cloud-init to automatically update all OS
packages on the firs
package_upgrade: true
EOF
-#. Deploy an instance with this user-data either by providing the UUID of the
registerd userdata
- or by providing base64 encoded userdata:
+#. Deploy an instance with this User Data either by providing the UUID of the
registerd User Data
+ or by providing base64 encoded User Data:
.. code:: bash
@@ -259,9 +259,9 @@ This example uses cloud-init to automatically update all OS
packages on the firs
.. code:: bash
- cmk deploy virtualmachine name=..... userdataid=<Userdata UUID>
+ cmk deploy virtualmachine name=..... userdataid=<User Data UUID>
-.. note:: When using multipart userdata, cloud-init expects userdata format of
one particular type only in one multipart section.
+.. note:: When using multipart User Data, cloud-init expects User Data format
of one particular type only in one multipart section.
Disclaimer
~~~~~~~~~~
diff --git a/source/conceptsandterminology/network_setup.rst
b/source/conceptsandterminology/network_setup.rst
index 467130a..7427add 100644
--- a/source/conceptsandterminology/network_setup.rst
+++ b/source/conceptsandterminology/network_setup.rst
@@ -55,7 +55,7 @@ VPN support No
Yes
Port forwarding Physical Physical and
Virtual
1:1 NAT Physical Physical and
Virtual
Source NAT No Physical and
Virtual
-Userdata Yes Yes
+User data Yes Yes
Network usage monitoring sFlow / netFlow at physical router Hypervisor and
Virtual Router
DNS and DHCP Yes Yes
========================= ===================================
===============================
diff --git a/source/plugins/ipv6.rst b/source/plugins/ipv6.rst
index 81fe7a5..25da560 100644
--- a/source/plugins/ipv6.rst
+++ b/source/plugins/ipv6.rst
@@ -101,7 +101,7 @@ The following are not yet supported:
#. Security groups
-#. Userdata and metadata
+#. User Data and metadata
#. Passwords
@@ -322,7 +322,7 @@ These operations are also available using UI in the network
details view of an I
IPv6 ACL
########
-IPv6 ACL rules for an IPv6 supported VPC Network Tier can be managed using
Network ACL lists for the VPC. IPv6 CIDRs can be specified while adding or
updating an ACL rule.
+IPv6 ACL rules for an IPv6 supported VPC Network Tier can be managed using
Network ACLs for the VPC. IPv6 CIDRs can be specified while adding or updating
an ACL rule.
|add-ipv6-acl-rule-form.png|
|ipv6-acl-list.png|
@@ -343,4 +343,4 @@ IPv6 ACL rules for an IPv6 supported VPC Network Tier can
be managed using Netwo
.. |add-ipv6-acl-rule-form.png| image::
/_static/images/add-ipv6-acl-rule-form.png
:alt: Add IPv6 ACL rule.
.. |ipv6-acl-list.png| image:: /_static/images/ipv6-acl-list.png
- :alt: IPv6 ACL rule in Network ACL list.
+ :alt: IPv6 ACL rule in Network ACL.
diff --git a/source/plugins/nsx-plugin.rst b/source/plugins/nsx-plugin.rst
index 0613370..21eb467 100644
--- a/source/plugins/nsx-plugin.rst
+++ b/source/plugins/nsx-plugin.rst
@@ -28,7 +28,7 @@ The VMware NSX Plugin introduces VMware NSX 4 as a network
service provider in C
- Port Forwarding between “public” networks and VPC network tier
- External load balancing – between VPCs network tiers and “public” networks
(runs on Edge Cluster)
- Internal load balancing – between VPC network tiers
-- Password injection, UserData and SSH Keys
+- Password injection, User Data and SSH Keys
- External, Internal DNS
- DHCP
- Kubernetes host orchestration, supporting CKS on VPCs
