Merge branch '4.20' into main with 'ours' strategy

Author: Pearl1594

.readthedocs.yaml

@@ -9,5 +9,8 @@ build:
     python: "3.11"
 
 python:
-   install:
-   - requirements: requirements.txt
+  install:
+  - requirements: requirements.txt
+
+sphinx:
+  configuration: source/conf.py

source/_global.rst

@@ -25,19 +25,20 @@
 
 .. Latest version systemvm template name
 
-.. |sysvm64-version|     replace:: 4.20.0
-.. |sysvm64-name-xen|    replace:: systemvm-xenserver-4.20.0-x86_64
-.. |sysvm64-name-kvm|    replace:: systemvm-kvm-4.20.0-x86_64
-.. |sysvm64-name-vmware| replace:: systemvm-vmware-4.20.0-x86_64
-.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-4.20.0-x86_64
-.. |sysvm64-name-ovm|    replace:: systemvm-ovm-4.20.0-x86_64
+.. |sysvm64-version|     replace:: 4.20.1
+.. |sysvm64-name-xen|    replace:: systemvm-xenserver-4.20.1-x86_64
+.. |sysvm64-name-kvm|    replace:: systemvm-kvm-4.20.1-x86_64
+.. |sysvm64-name-vmware| replace:: systemvm-vmware-4.20.1-x86_64
+.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-4.20.1-x86_64
+.. |sysvm64-name-ovm|    replace:: systemvm-ovm-4.20.1-x86_64
 
 .. Latest version systemvm template URL
-.. |sysvm64-url-xen|    replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0-x86_64-xen.vhd.bz2
-.. |sysvm64-url-kvm|    replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0-x86_64-kvm.qcow2.bz2
-.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0-x86_64-vmware.ova
-.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0-x86_64-hyperv.vhd.zip
-.. |sysvm64-url-ovm|    replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.0-x86_64-ovm.raw.bz2
+.. |sysvm64-url-xen|            replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.1-x86_64-xen.vhd.bz2
+.. |sysvm64-url-kvm|            replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.1-x86_64-kvm.qcow2.bz2
+.. |sysvm64-url-kvm-aarch64|    replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.1-aarch64-kvm.qcow2.bz2
+.. |sysvm64-url-vmware|         replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.1-x86_64-vmware.ova
+.. |sysvm64-url-hyperv|         replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.1-x86_64-hyperv.vhd.zip
+.. |sysvm64-url-ovm|            replace:: http://download.cloudstack.org/systemvm/4.20/systemvmtemplate-4.20.1-x86_64-ovm.raw.bz2
 
 .. Images
 

source/_static/images/oauth-provider-registration.png

@@ -697,11 +697,6 @@ In any OAuth 2.0 configuration admin has to use the redirect URI "http://<manage
           server IP to host table in the local system and assign a domain, something like "management.cloud". In that redirect URI looks like
           "http://management.cloud:8080/?verifyOauth"
 
-.. image:: /_static/images/oauth-provider-registration.png
-   :width: 400px
-   :align: center
-   :alt: OAuth provider registration
-
 Following are the details needs to be provided to register the OAuth provider, this is to call the API "registerOauthProvider"
 
    -  **Provider**: Name of the provider from the list of OAuth providers supported in CloudStack
@@ -714,6 +709,11 @@ Following are the details needs to be provided to register the OAuth provider, t
 
    -  **Secret Key**: Secret Key pre-registered in the specific OAuth provider
 
+.. image:: /_static/images/oauth-provider-registration.png
+   :width: 400px
+   :align: center
+   :alt: OAuth provider registration
+
 Cloudmonkey API call looks like
 
    -  register oauthprovider provider=google description="Google Provider"

source/_static/images/vm-settings-kvm-guest-cpu-model.png

@@ -12,7 +12,7 @@
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
- 
+
 
 The CloudStack API is a low level API that has been used to implement
 the CloudStack web UIs. It is also a good basis for implementing other
@@ -181,6 +181,29 @@ VMdata - a list of String arrays representing [“directory”, “filename”,
 
     - default: config-2
 
+Virtual machine password via ConfigDrive
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ConfigDrive metadata provider delivers the virtual machine password simultaneously in two variants, leaving which one to use to the user discretion:
+
+1. As the ``<mountdir>/cloudstack/password/vm_password.txt`` file.
+
+This file is intended to be used by an external script that runs inside the virtual machine every boot, and changes the password if needed.
+The init-script that implements this functionality can be found in the `Cloudstack source <https://github.com/apache/cloudstack/blob/main/setup/bindir/cloud-set-guest-password-configdrive.in>`_.
+
+.. note::
+    The ``vm_password.txt`` file is not compatible with cloud-init password module, so the cloud-init will ignore it.
+    It is up to Cloudstack administrator to include the script processing it in the virtual machines and/or their templates.
+
+2. As the ``<mountdir>/openstack/latest/vendor_data.json``.
+This is a standard password location supported by cloud-init's both ConfigDrive datasource and the password module.
+Therefore, this variant allows using cloud-init as the only tool for provisioning a virtual machine, without using external scripts.
+
+.. warning::
+    Cloud-init password module is designed to only perform the initial virtual machine password setup.
+    It will ignore the changes in ``vendor_data.json`` after the first run. Therefore, resetting the virtual machine password from Cloudstack will not work with this variant.
+
+
 For more detailed information about the Config Drive implementation refer to
 the `Wiki Article
 <https://cwiki.apache.org/confluence/display/CLOUDSTACK/Using+ConfigDrive+for+Metadata%2C+Userdata+and+Password#:~:text=CLOUDSTACK%2D9813%20%2D%20(),%2Dkeys)%20and%20password%20files>`_