Merge branch '4.19' into scope-419

Author: abh1sar

source/_static/images/nfs-mount-options-add-primary-storage.png

@@ -288,6 +288,17 @@ to add members in CloudStack, but only one way is enabled at a time:
    the UI.
 
 
+Working with Project Roles
+--------------------------
+CloudStack allows adding project members with a desired project role. A
+project role will be assigned to the member in addition to their base
+account role. Project Roles are retrictive in nature and can be used to
+further restrict certain API access to the members within the project.
+It is important to note that a project role cannot be used to elevate an
+existing user's permissions. Project roles can be created or managed
+using `Project roles` tab in the project details UI.
+
+
 Sending Project Membership Invitations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

source/_static/images/nfs-mount-options-create-zone-wizard.png

@@ -222,7 +222,6 @@ combinations:
 It is possible to use this functionality with other configurations but some
 manual intervention might be needed by the Administrator to make it work.
 
-
 Storage Tags
 ~~~~~~~~~~~~
 
@@ -275,6 +274,73 @@ templates, and ISOs.
 .. note::
    If files or folders are not associated with a cloudstack resource, it doesn't mean that they are not used by cloudstack.
 
+
+Setting NFS Mount Options on the Storage Pool
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+NFS mount options can be added while creating an NFS storage pool for
+KVM hosts. When the storage pool is mounted on the KVM hypervisor host,
+these options will be used. Options currently tested and supported are
+`vers` and `nconnect`. 
+
+Although it depends on the NFS server, but commonly supported `vers` values 
+are `3` for NFSv3 and minor versions `4.0, 4.1 and 4.2` for NFSv4. 
+`nconnect` values can range from 1 to 16.
+
+Administrator can give the NFS mount options while adding a Primary Storage
+from the Create Zone Wizard as well as the Add Primary Storage form.
+|nfs-mount-options-create-zone-wizard.png|
+|nfs-mount-options-add-primary-storage.png|
+
+NFS mount options can be changed on a pre-existing Storage Pool in maintenance
+mode using the Edit Primary Storage form. Running VMs using volumes in the
+Storage Pool will either be stopped or the volumes would be migrated to other
+available pools upon enabling maintenance mode.
+Storage Pool will be unmounted and mounted again on the KVM hosts using the
+new options upon cancelling the maintenance mode.
+|nfs-mount-options-edit-primary-storage.png|
+
+Mount failing due to an incorrect mount option
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Add Storage Pool will fail with the error ``An incorrect mount option was specified``.
+
+In the Update storage pool case, cancel maintenance will throw the above error.
+The Administrator should set the correct mount option and cancel the maintenance mode again.
+
+
+Version Requirements
+^^^^^^^^^^^^^^^^^^^^
+This feature needs libvirt version 5.1.0 and above on the KVM hosts.
+
+The `nconnect` mount option exists in all Linux distributions with kernel 5.3 or higher
+  
+A note on the `nconnect` option
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This option defines the count of TCP connections that the client makes
+to the NFS server. The `nconnect` setting is applied only during the
+first mount process to the particular NFS server for a given NFS version.
+
+If the same client executes the mount command again to the same NFS server using
+the same version, it will get the same `nconnect` value as the first mount.
+All mount point to the same server at a given version share the same number
+of TCP connections. To change the `nconnect` settings all the such mount points
+need to be unmounted and then mounted again with the new `nconnect` value.
+
+So, from CloudStack’s perspective also, the first storage pool created from an
+NFS server will set the `nconnect` setting on the hypervisor host corresponding
+to the server. Specifying a different `nconnect` mount option while creating a
+new storage pool from the same server will not change the `nconnect` setting on the host.
+
+Similarly if there is only one pre-existing storage pool from a give NFS server
+mounted on the host, modifying the `nconnect` mount option via CloudStack will
+change the `nconnect` setting on that host. If there are more than one storage pools
+from the same server mounted on a host. Changing the `nconnect` mount option on one
+of the storage pools via CloudStack will not do anything. To change the `nconnect`
+setting on the host, after modifying `nconnect` mount option on all storage pools,
+the host needs to be restarted.
+
+
 Secondary Storage
 -----------------
 
@@ -1463,4 +1529,10 @@ Deleting objects from a bucket
    :alt: Import Volume
 .. |unmanage-volume.png| image:: /_static/images/unmanage-volume.png
    :alt: Unmanage Volume
+.. |nfs-mount-options-create-zone-wizard.png| image:: /_static/images/nfs-mount-options-create-zone-wizard.png
+   :alt: NFS mount options in create Zone wizard
+.. |nfs-mount-options-add-primary-storage.png| image:: /_static/images/nfs-mount-options-add-primary-storage.png
+   :alt: NFS mount options in add Primary Storage
+.. |nfs-mount-options-edit-primary-storage.png| image:: /_static/images/nfs-mount-options-edit-primary-storage.png
+   :alt: NFS mount options in edit Primary Storage
 

source/_static/images/nfs-mount-options-edit-primary-storage.png

@@ -444,7 +444,7 @@ hypervisor-specific.
 
 
 Adding an ISO
----------------
+-------------
 
 To make additional operating system or other software available for use
 with Guest Instances, you can add an ISO. The ISO is typically thought of as

source/_static/images/plugin1.jpg

@@ -62,6 +62,13 @@ These features can be implemented in `“Linux Template creation process” <_cr
      datasource:
        CloudStack: {}
        None: {}
+
+   .. note::
+      For the vm instances running on VMware or XenServer/XCP-ng hypervisors, if there are multiple cloud-init data sources, it is a known issue that ds-identify is not able to detect if "CloudStack" DataSource is enabled. To fix the problem, please run the following command to enable cloud-init without any aid from ds-identify.
+
+        .. code:: bash
+
+          echo "policy: enabled" >  /etc/cloud/ds-identify.cfg
 	   
 #. **Password management**
 

source/_static/images/plugin2.jpg

@@ -30,19 +30,19 @@ An overview of the procedure is as follow:
 #. Upload your Linux ISO.
 
    For more information, see `“Adding an
-   ISO” <virtual_machines.html#adding-an-iso>`_.
+   ISO” <templates.html#adding-an-iso>`_.
 
 #. Create an Instance with this ISO.
 
    For more information, see `“Creating
-   VMs” <virtual_machines.html#creating-vms>`_.
+   Instances” <virtual_machines.html#creating-instances>`_.
 
 #. Prepare the Linux Instance
 
 #. Create a Template from the Instance.
 
    For more information, see `“Creating a Template from an Existing 
-   Instance” <#creating-a-template-from-an-existing-virtual-machine>`_.
+   Instance” <#creating-a-template-from-an-existing-instance>`_.
 
 
 System preparation for Linux
@@ -114,25 +114,25 @@ templating of Centos and Ubuntu.
 	 
    User password management and reset cappabilities in GUI are available with:
 
-   *  `Cloud-init integration <_cloud_init.html#linux-with-cloud-init>`_
-   *  `Adding Password Management to Your Templates <_password.html#adding-password-management-to-templates>`_ /Legacy for non systemd systems only/
+   *  `Cloud-init integration <templates/_cloud_init.html#linux-with-cloud-init>`_
+   *  `Adding Password Management to Your Templates <templates.html#adding-password-management-to-templates>`_ /Legacy for non systemd systems only/
 
 #. **SSH keys management**
 
    Cloudstack can create key pair and push certificates to Instances. This feature is available with:
 
-   *  `Cloud-init integration <_cloud_init.html#linux-with-cloud-init>`_
+   *  `Cloud-init integration <templates/_cloud_init.html#linux-with-cloud-init>`_
    *  `Implementing a SSH-Key bash script <http://docs.cloudstack.apache.org/en/latest/adminguide/virtual_machines.html#creating-an-instance-template-that-supports-ssh-keys>`_   
 
 #. **Partition management**
 
    Volumes can autorextend after reboot when partition is extended in the GUI.
-   This feature is possible with `Cloud-init integration <_cloud_init.html#linux-with-cloud-init>`_.
+   This feature is possible with `Cloud-init integration <templates/_cloud_init.html#linux-with-cloud-init>`_.
 
 #. **User-data**
 
    Cloudstack can push user-data during Instance creation.
-   This feature is possible with `Cloud-init integration <_cloud_init.html#linux-with-cloud-init>`_.
+   This feature is possible with `Cloud-init integration <templates/_cloud_init.html#linux-with-cloud-init>`_.
 
 #. **Template cleanup**
 
@@ -214,4 +214,4 @@ templating of Centos and Ubuntu.
 
    You are now ready to create the Final Template, for more information see
    `“Creating a Template from an Existing Virtual
-   Machine” <#creating-a-template-from-an-existing-virtual-machine>`_.
+   Machine” <#creating-a-template-from-an-existing-instance>`_.

source/_static/images/plugin3.jpg

@@ -38,7 +38,7 @@ An overview of the procedure is as follows:
 #. Create an instance with this ISO.
 
    For more information, see `“Creating
-   instances” <virtual_machines.html#creating-vms>`_.
+   instances” <virtual_machines.html#creating-instances>`_.
 
 #. Follow the steps in Sysprep for Windows Server 2008 R2 (below) or
    Sysprep for Windows Server 2003 R2, depending on your version of

source/_static/images/plugin4.png

@@ -437,8 +437,6 @@ those same credentials are later used for SSH authentication when the QCOW2 imag
 .. parsed-literal::
    - **zoneid** (Zone to which Instance will be imported)
    - **host** (the host name or IP address of External Host)
-   - **username** (the username of External Host for authentication)
-   - **password** (the password of External Host for authentication)
 
 **Response**:
 

source/_static/images/plugin_intro.png

@@ -217,6 +217,8 @@ Instance deployment automatically (:ref:`adding-password-management-to-templates
 
       datasource_list: [ CloudStack, None ]
 
+For more information, see `Cloud-init integration <templates/_cloud_init.html#linux-with-cloud-init>`_
+
 Custom user-data example
 ~~~~~~~~~~~~~~~~~~~~~~~~