Merge branch 'main' into fix/bottom_link_create_a_linux_template

.github/workflows/gen-docs.yaml

@@ -0,0 +1,32 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: readthedocs/actions
+
+on:
+  pull_request_target:
+
+permissions:
+  pull-requests: write
+
+jobs:
+  pull-request-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "cloudstack-documentation"

.readthedocs.yaml

@@ -1,5 +1,10 @@
 version: 2
 
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
 python:
    install:
    - requirements: requirements.txt

requirements.txt

@@ -1 +1,5 @@
 docutils<0.18
+sphinx<2
+sphinx-rtd-theme<0.5
+readthedocs-sphinx-ext<2.3
+jinja2<3.1.0

source/_global.rst

@@ -25,25 +25,19 @@
 
 .. Latest version systemvm template name
 
-.. |sysvm64-version|     replace:: 4.18.0
-.. |sysvm64-name-xen|    replace:: systemvm-xenserver-4.18.0
-.. |sysvm64-name-kvm|    replace:: systemvm-kvm-4.18.0
-.. |sysvm64-name-vmware| replace:: systemvm-vmware-4.18.0
-.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-4.18.0
-.. |sysvm64-name-ovm|    replace:: systemvm-ovm-4.18.0
+.. |sysvm64-version|     replace:: 4.18.1
+.. |sysvm64-name-xen|    replace:: systemvm-xenserver-4.18.1
+.. |sysvm64-name-kvm|    replace:: systemvm-kvm-4.18.1
+.. |sysvm64-name-vmware| replace:: systemvm-vmware-4.18.1
+.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-4.18.1
+.. |sysvm64-name-ovm|    replace:: systemvm-ovm-4.18.1
 
 .. Latest version systemvm template URL
-.. |sysvm64-url-xen|    replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.0-xen.vhd.bz2
-.. |sysvm64-url-kvm|    replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.0-kvm.qcow2.bz2
-.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.0-vmware.ova
-.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.0-hyperv.vhd.zip
-.. |sysvm64-url-ovm|    replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.0-ovm.raw.bz2
-
-.. Version specific: 4.5 systemvm template URL
-.. |acs45-sysvm64-url-xen|    replace:: https://download.cloudstack.org/systemvm/4.5/systemvm64template-4.5-xen.vhd.bz2
-.. |acs45-sysvm64-url-kvm|    replace:: https://download.cloudstack.org/systemvm/4.5/systemvm64template-4.5-kvm.qcow2.bz2
-.. |acs45-sysvm64-url-vmware| replace:: https://download.cloudstack.org/systemvm/4.5/systemvm64template-4.5-vmware.ova
-.. |acs45-sysvm64-url-hyperv| replace:: https://download.cloudstack.org/systemvm/4.5/systemvm64template-4.5-hyperv.vhd.zip
+.. |sysvm64-url-xen|    replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.1-xen.vhd.bz2
+.. |sysvm64-url-kvm|    replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.1-kvm.qcow2.bz2
+.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.1-vmware.ova
+.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.1-hyperv.vhd.zip
+.. |sysvm64-url-ovm|    replace:: http://download.cloudstack.org/systemvm/4.18/systemvmtemplate-4.18.1-ovm.raw.bz2
 
 .. Images
 

source/adminguide/administration.rst

@@ -18,24 +18,24 @@ User Services
 =============
 
 In addition to the physical and logical infrastructure of your cloud and
-the CloudStack software and servers, you also need a layer of user
+the CloudStack software and servers, you also need a layer of User
 services so that people can actually make use of the cloud. This means
-not just a user UI, but a set of options and resources that users can
-choose from, such as templates for creating virtual machines, disk
+not just a User UI, but a set of options and resources that Users can
+choose from, such as Templates for creating Instances, disk
 storage, and more. If you are running a commercial service, you will be
-keeping track of what services and resources users are consuming and
+keeping track of what services and resources Users are consuming and
 charging them for that usage. Even if you do not charge anything for
-people to use your cloud – say, if the users are strictly internal to
+people to use your cloud – say, if the Users are strictly internal to
 your organization, or just friends who are sharing your cloud – you can
 still keep track of what services they use and how much of them.
 
 
 Service Offerings, Disk Offerings, Network Offerings, and Templates
 -------------------------------------------------------------------
 
-A user creating a new instance can make a variety of choices about its
+A User creating a new Instance can make a variety of choices about its
 characteristics and capabilities. CloudStack provides several ways to
-present users with choices when creating a new instance:
+present Users with choices when creating a new Instance:
 
 -  Service Offerings, defined by the CloudStack administrator, provide a
    choice of CPU speed, number of CPUs, RAM size, tags on the root disk,
@@ -46,16 +46,16 @@ present users with choices when creating a new instance:
    storage. See Creating a New Disk Offering.
 
 -  Network Offerings, defined by the CloudStack administrator, describe
-   the feature set that is available to end users from the virtual
+   the feature set that is available to end Users from the virtual
    router or external networking devices on a given guest network. See
    Network Offerings.
 
 -  Templates, defined by the CloudStack administrator or by any
-   CloudStack user, are the base OS images that the user can choose from
-   when creating a new instance. For example, CloudStack includes CentOS
-   as a template. See Working with Templates.
+   CloudStack User, are the base OS images that the User can choose from
+   when creating a new Instance. For example, CloudStack includes CentOS
+   as a Template. See Working with Templates.
 
-In addition to these choices that are provided for users, there is
+In addition to these choices that are provided for Users, there is
 another type of service offering which is available only to the
 CloudStack root administrator, and is used for configuring virtual
 infrastructure resources. For more information, see Upgrading a Virtual

source/adminguide/api.rst

@@ -54,7 +54,7 @@ User Data and Meta Data Via Virtual Router
 
 
 CloudStack provides API access to attach up to 32KB of user data to a
-deployed VM. Deployed VMs also have access to instance metadata via the
+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
@@ -75,41 +75,41 @@ http://10.1.1.1/latest/meta-data/{metadata type}. (For backwards
 compatibility, the previous URL http://10.1.1.1/latest/{metadata type}
 is also supported.) For metadata type, use one of the following:
 
--  service-offering. A description of the VMs service offering
+-  service-offering. A description of the Instance service offering
 
 -  availability-zone. The Zone name
 
--  local-ipv4. The guest IP of the VM
+-  local-ipv4. The guest IP of the Instance
 
--  local-hostname. The hostname of the VM
+-  local-hostname. The hostname of the Instance
 
 -  public-ipv4. The first public IP for the router. (E.g. the first IP
    of eth2)
 
 -  public-hostname. This is the same as public-ipv4
 
--  instance-id. The instance name of the VM
+-  instance-id. The Instance name
 
 User Data and Meta Data via Config Drive
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Config drive is an ISO file that is mounted as a cd-rom on a user VM and
-contains the user VM related userdata, metadata (incl. ssh-keys) and
+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
 password files.
 
 Enable config drive
 ~~~~~~~~~~~~~~~~~~~
-To use the config drive the network offering must have the “ConfigDrive”
+To use the config drive the Network offering must have the “ConfigDrive”
 provider selected for the userdata service.
 
-If the networkoffering uses ConfigDrive for userdata and the template is
-password enabled, the password string for the VM is placed in the
+If the networkoffering uses ConfigDrive for userdata 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.
 
 ConfigDrive availability
 ~~~~~~~~~~~~~~~~~~~~~~~~
-At VM start the config drive ISO is attached on the 2nd cd/dvd drive of the
-user instance, such that any other ISO image (e.g. boot image or vmware tools)
+At Instance start the config drive ISO is attached on the 2nd cd/dvd drive of the
+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.
 
@@ -118,10 +118,10 @@ 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
 updated directory structure.
 
-In case of a password reset, the new password will be picked-up at VM start.
+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.
 
-When a VM is stopped, the ConfigDrive network element will trigger the
+When an Instance is stopped, the ConfigDrive network element will trigger the
 Secondary Storage VM to remove the ISO from the secondary storage.
 If the config drive is stored on primary storage, the network element will
 trigger the host to remove the ISO.
@@ -133,7 +133,7 @@ supported with use of the KVM Hypervisor.
 Supporting ConfigDrive
 ~~~~~~~~~~~~~~~~~~~~~~
 
-Extra data is added to the VM profile to enable the creation of the config drive:
+Extra data is added to the Instance profile to enable the creation of the config drive:
 
 VMdata - a list of String arrays representing [“directory”, “filename”, “content”] on the ConfigDrive device.
 
@@ -159,7 +159,7 @@ VMdata - a list of String arrays representing [“directory”, “filename”,
 
     - vm_password.txt
 
-    - vm_password_md5checksum (for windows VM’s)
+    - vm_password_md5checksum (for windows Instances)
 
 - <mountdir>/openstack/version/: