Skip to content

polish: Fix some inconsistencies in object names and messages #506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: 4.20
Choose a base branch
from
Draft

polish: Fix some inconsistencies in object names and messages #506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ac80e9
Replace ACL List with ACL
abh1sar May 13, 2025
f611702
Replace Userdata with User data
abh1sar May 14, 2025
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
10 changes: 5 additions & 5 deletions source/adminguide/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

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.
Expand Down
6 changes: 3 additions & 3 deletions source/adminguide/autoscale_with_virtual_router.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ 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>`_.
Expand Down Expand Up @@ -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|

Expand Down Expand Up @@ -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.

2 changes: 1 addition & 1 deletion source/adminguide/networking.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion source/adminguide/networking/dynamic_static_routing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Network mode indicates the mode with which the isolated network or VPC will oper
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).
- 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
Expand Down
2 changes: 1 addition & 1 deletion source/adminguide/networking/remote_access_vpn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions source/adminguide/networking/site_to_site_vpn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -299,7 +299,7 @@ Creating a VPN Connection

- Site-to-Site VPNs

- Network ACL Lists
- Network ACLs

#. Select Site-to-Site VPN.

Expand Down Expand Up @@ -431,7 +431,7 @@ Restarting and Removing a VPN Connection

- Site-to-Site VPNs

- Network ACL Lists
- Network ACLs

#. Select Site-to-Site VPN.

Expand Down
56 changes: 28 additions & 28 deletions source/adminguide/networking/virtual_private_cloud_config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ 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
^^^^^^^^^^^^^^^^^^^^^^^
Comment on lines +318 to 319
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
About Network ACLs
^^^^^^^^^^^^^^^^^^^^^^^
About Network ACLs
^^^^^^^^^^^^^^^^^^


In CloudStack terminology, a Network ACL is a group of Network ACL rules.
Expand Down Expand Up @@ -357,7 +357,7 @@ Afterwards traffic can be white- or blacklisted.
connection


Creating ACL Lists
Creating ACLs
^^^^^^^^^^^^^^^^^^
Comment on lines +360 to 361
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Creating ACLs
^^^^^^^^^^^^^^^^^^
Creating ACLs
^^^^^^^^^^^^^


#. Log in to the CloudStack UI as an administrator or end User.
Expand Down Expand Up @@ -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.


Expand All @@ -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.
Expand Down Expand Up @@ -471,23 +471,23 @@ Creating an ACL Rule
tab.


Creating a Tier with Custom ACL List
Creating a Tier with Custom ACL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Comment on lines +474 to 475
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Creating a Tier with Custom ACL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Comment on lines +490 to 491
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Assigning a Custom ACL to a Tier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Assigning a Custom ACL to a Tier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


#. Create a VPC.
Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -859,7 +859,7 @@ still belongs to the same VPC.

- Site-to-Site VPNs

- Network ACL Lists
- Network ACLs

#. Select Public IP Addresses.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/adminguide/systemvm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -829,7 +829,7 @@ it is upgraded:

- SecurityGroup

- UserData
- User Data

- DHCP

Expand Down
6 changes: 3 additions & 3 deletions source/adminguide/templates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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-meta-data>`_.


- **Hypervisor**: The supported hypervisors are listed. Select the
Expand Down
Loading