DaanHoogland commented on code in PR #506: URL: https://github.com/apache/cloudstack-documentation/pull/506#discussion_r2123883114
########## source/adminguide/networking/virtual_private_cloud_config.rst: ########## @@ -357,7 +357,7 @@ Afterwards traffic can be white- or blacklisted. connection -Creating ACL Lists +Creating ACLs ^^^^^^^^^^^^^^^^^^ Review Comment: ```suggestion Creating ACLs ^^^^^^^^^^^^^ ``` ########## source/adminguide/networking/virtual_private_cloud_config.rst: ########## @@ -471,23 +471,23 @@ 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Review Comment: ```suggestion Assigning a Custom ACL to a Tier ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``` ########## source/adminguide/virtual_machines/user-data.rst: ########## @@ -60,84 +60,84 @@ 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 user data parameter "variable1" like below .. image:: /_static/images/register_userdata_with_variables.png :width: 400px :align: center - :alt: Regiser userdata with variables dialog box + :alt: Regiser 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: 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, 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Review Comment: ```suggestion Storing and accessing user data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``` ########## source/adminguide/networking/virtual_private_cloud_config.rst: ########## @@ -471,23 +471,23 @@ Creating an ACL Rule tab. -Creating a Tier with Custom ACL List +Creating a Tier with Custom ACL ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Review Comment: ```suggestion Creating a Tier with Custom ACL ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``` ########## source/adminguide/networking/virtual_private_cloud_config.rst: ########## @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^ Review Comment: ```suggestion About Network ACLs ^^^^^^^^^^^^^^^^^^ ``` ########## source/plugins/ipv6.rst: ########## @@ -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. Review Comment: ```suggestion :alt: IPv6 access rule in Network ACL. ``` ?? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@cloudstack.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org