Merge branch 'main' into Added-Health-Checks-and-Monitoring-to-Optional-Installation

daviftorres · web-flow · commit 02278e9c0b55 · 2025-06-04T11:04:14.000-04:00
diff --git a/source/_static/images/B&R-Backup-Offerings.png b/source/_static/images/B&R-Backup-Offerings.png
diff --git a/source/adminguide/accounts.rst b/source/adminguide/accounts.rst
@@ -904,8 +904,8 @@ password for a user:
 Using API Key and Secret Key based Authentication
 -------------------------------------------------
 Users can generate API key and Secret key to directly access CloudStack APIs.
-This authenctication method is used for programatically calling CloudStack APIs and thus helps in automation.
-The API key uniquely identifies the Account, while the Secret key is used to generate a secure singnature.
+This authentication method is used for programmatically calling CloudStack APIs and thus helps in automation.
+The API key uniquely identifies the Account, while the Secret key is used to generate a secure signature.
 When making an API call, the API key and signature are included along with the command and other parameters,
 and sent to the CloudStack API endpoint. For detailed information, refer to the CloudStack's Programmer Guide.
 
diff --git a/source/adminguide/events.rst b/source/adminguide/events.rst
@@ -75,7 +75,7 @@ implementation are also available.
 
 
 .. note::
-   On upgrading from 4.19.x or lower, existing AMQP or Kafka intergration
+   On upgrading from 4.19.x or lower, existing AMQP or Kafka integration
    configurations should be moved from folder
    ``/etc/cloudstack/management/META-INF/cloudstack/core`` to
    ``/etc/cloudstack/management/META-INF/cloudstack/event``
diff --git a/source/adminguide/events/webhooks.rst b/source/adminguide/events/webhooks.rst
@@ -21,7 +21,7 @@ This allows users to consume event notifications without any external services
 such as an event streaming platforms.
 
 Webhooks can be managed using both API and UI. CloudStack provides following
-APIs for webhhoks:
+APIs for webhooks:
 
    .. cssclass:: table-striped table-bordered table-hover
 
@@ -37,7 +37,7 @@ APIs for webhhoks:
    executeWebhookDelivery Executes a Webhook delivery
    ====================== ===========================
 
-In the UI, webhooks can be managed under *Tools > Webhhooks* menu.
+In the UI, webhooks can be managed under *Tools > Webhooks* menu.
 
    |webhooks.png|
 
diff --git a/source/adminguide/hosts.rst b/source/adminguide/hosts.rst
@@ -924,7 +924,7 @@ There are four stages in the KVM rolling maintenance process:
 
 #. Pre-Flight stage: Pre-flight script (``PreFlight`` or ``PreFlight.sh`` or ``PreFlight.py``) runs on hosts before commencing the rolling maintenance. If pre-flight check scripts return an error from any host, then rolling maintenance will be cancelled with no actions taken, and an error returned. If there are no pre-flight scripts defined, then no checks will be done from the hosts.
 
-#. Pre-Maintenace stage: Pre-maintenance script ((``PreMaintenance`` or ``PreMaintenance.sh`` or ``PreMaintenance.py``)) runs before a specific host is put into maintenance. If no pre-maintenance script is defined, then no pre-maintenance actions will be taken, and the management server will move straight to putting the host in maintenance followed by requesting that the agent runs the maintenance script.
+#. Pre-Maintenance stage: Pre-maintenance script ((``PreMaintenance`` or ``PreMaintenance.sh`` or ``PreMaintenance.py``)) runs before a specific host is put into maintenance. If no pre-maintenance script is defined, then no pre-maintenance actions will be taken, and the management server will move straight to putting the host in maintenance followed by requesting that the agent runs the maintenance script.
 
 #. Maintenance stage: Maintenance script ((``Maintenance`` or ``Maintenance.sh`` or ``Maintenance.py``)) runs after a host has been put into maintenance. If no maintenance script is defined, or if the pre-flight or pre-maintenance scripts determine that no maintenance is required, then the host will not be put into maintenance, and the completion of the pre-maintenance scripts will signal the end of all maintenance tasks and the KVM agent will hand the host back to the management server. Once the maintenance scripts have signalled that it has completed, the host agent will signal to the management server that the maintenance tasks have completed, and therefore the host is ready to exit maintenance mode and any 'information' which was collected (such as processing times) will be returned to the management server.
 
diff --git a/source/adminguide/nas_plugin.rst b/source/adminguide/nas_plugin.rst
@@ -27,6 +27,9 @@ instances to any shared storage (NAS). It is based on `libvirt push backup mode
 to take full instance backups (qcow2) and requires libvirt-7.2.0 and QEMU-4.2,
 or high versions on the KVM hosts.
 
+Currently, only backup of VMs from the NFS-based Primary Storage are tested to work.
+You can also make backups of CEPH-based VMs, but restoring is not possible yet.
+
 The NAS B&R plugin requires admin to first add backup repositories which are
 network-attached storage (shared storage). Currently it supports NFS, and may
 support other shared storage such as CephFS and CIFS/Samba in future.
@@ -67,25 +70,35 @@ backup.framework.enabled          true
 backup.framework.provider.plugin  nas
 ================================= ========================
 
-Once the above two configurations are set, restart the cloudstack-management service. Once the service is restarted we can add the backup repository for the 'nas' Backup and Recovery plugin.
-Navigate to the configuration -> Backup Repository. Click on 'Add Backup Repository' and fill the form. 
+Once the above two configurations are set, restart the cloudstack-management service. After restart check the Settings of the Zone where you want to enable NAS backups - make sure that the "backup.framework.enabled"="true" on the Setting tab of the Zone. Once this is done, we can add the backup repository for the 'nas' Backup and Recovery plugin.
+Navigate to the Configuration -> Backup Repository. Click on 'Add Backup Repository' and fill the form. 
 
 =================== ========================
 Field               Value
 =================== ========================
 Name                A suitable name to represent the Backup Repository
 Address             URL, in case of NFS <server IP>:/path
 Type                NFS ( only NFS type in 4.20)
-label.mountopts     Any mount point options to be passed while mouting this storage on the hypervisor. 
+label.mountopts     Any mount point options to be passed while mounting this storage on the hypervisor.
 Zone                The zone in CloudStack with which this Backup Repository must be associated.
 =================== ========================
 
 .. image:: /_static/images/B&R-Backup-Respository.png
    :align: center
    :alt: NAS Backup repository
 
+Pay attention to the "Name" given to this repository, as you will have to specify this in the "External ID" field when creating Backup Offerings (Importing backup offering)
+
 Once the Backup Repository is created, we need to add a Backup Offering, in this plugin the Backup offering is a placeholder to associate an instance to a Backup Repository. While creating the Backup Offering, select the desired Backup Repository. Associate the Backup Offering on an instance to create an Adhoc or scheduled backup. 
 
+For the "External ID", please specify the name of the previously created backup repository.
+
+.. image:: /_static/images/B&R-Backup-Offerings.png
+   :align: center
+   :alt: NAS Backup offerings
+
+After this has been done, you can go to any Instance view and there will be buttons available for either ad-hoc backup or a scheduled backup of the VM
+
 Support Information and Limitation
 ----------------------------------
 
diff --git a/source/adminguide/networking/dynamic_static_routing.rst b/source/adminguide/networking/dynamic_static_routing.rst
@@ -253,7 +253,7 @@ For more information, see `“CloudStack Kubernetes Service” <../plugins/cloud
 
 
 .. |manage-ipv4-subnets-for-zone.png| image:: /_static/images/manage-ipv4-subnets-for-zone.png
-   :alt: Manage IPv4 subnets for zoone
+   :alt: Manage IPv4 subnets for zone
 
 .. |manage-ipv4-subnets-for-networks.png| image:: /_static/images/manage-ipv4-subnets-for-networks.png
    :alt: Manage IPv4 subnets for guest networks
diff --git a/source/adminguide/networking/ip_reservation_in_guest_networks.rst b/source/adminguide/networking/ip_reservation_in_guest_networks.rst
@@ -90,7 +90,7 @@ Limitations
 -  Upgrading network offering which causes a change in CIDR (such as
    upgrading an offering with no external devices to one with external
    devices) IP Reservation becomes void if any. Reconfigure IP
-   Reservation in the new re-implemeted network.
+   Reservation in the new re-implemented network.
 
 
 Best Practices
diff --git a/source/adminguide/service_offerings.rst b/source/adminguide/service_offerings.rst
@@ -654,11 +654,11 @@ To create a system service offering:
 Network Throttling
 ------------------
 
-Network throttling is the process of controlling the network bandwith. CloudStack controls this
+Network throttling is the process of controlling the network bandwidth. CloudStack controls this
 behaviour of the guest networks in the cloud by using the network rate
 parameter. This parameter is defined as the default data transfer rate
 in Mbps (Megabits Per Second) allowed in a guest network. It defines the
-upper limits for network bandwith.
+upper limits for network bandwidth.
 
 You can throttle the network bandwidth either to control the usage above
 a certain limit for some accounts, or to control network congestion in a
diff --git a/source/adminguide/templates.rst b/source/adminguide/templates.rst
@@ -597,9 +597,9 @@ Attaching an ISO to a Instance
 .. |template-permissions-update-2.png| image:: /_static/images/template-permissions-update-2.png
    :alt: Sharing template with 2 specific projects
 .. |template-permissions-update-3.png| image:: /_static/images/template-permissions-update-3.png
-   :alt: Revoking permissins from Account "user8"
+   :alt: Revoking permissions from Account "user8"
 .. |template-permissions-update-4.png| image:: /_static/images/template-permissions-update-4.png
-   :alt: Revoking permsissons from both projects previously added
+   :alt: Revoking permissions from both projects previously added
 .. |template-permissions-update-5.png| image:: /_static/images/template-permissions-update-5.png
    :alt: Resetting (removing all) permissions
 .. |iso.png| image:: /_static/images/iso-icon.png
diff --git a/source/adminguide/templates/_import_ami.rst b/source/adminguide/templates/_import_ami.rst
@@ -102,14 +102,14 @@ To import an AMI:
       none       /sys      sysfs   defaults        0 0
 
 #. Enable login via the console. The default console device in a
-   XenServer system is xvc0. Ensure that etc/inittab and etc/securetty
+   XenServer system is xvc0. Ensure that etc/inittab and etc/security
    have the following lines respectively:
 
    .. code:: bash
 
       # grep xvc0 etc/inittab 
       co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav
-      # grep xvc0 etc/securetty 
+      # grep xvc0 etc/security
       xvc0
 
 #. Ensure the ramdisk supports PV disk and PV network. Customize this
diff --git a/source/adminguide/ui.rst b/source/adminguide/ui.rst
@@ -498,7 +498,7 @@ Example for adding custom plugins:
    Not all ant icons are supported at the moment. You will find a list of supported icons 
    within the github repository in ui/src/core/lazy_lib/icons_use.js. To use an icon you 
    need to transform the listed name. For example "PieChartOutlined" needs to be transformed 
-   to "pie-chart-outlined", "ReadOutlined" needs to be tranformed to "read-outlined".
+   to "pie-chart-outlined", "ReadOutlined" needs to be transformed to "read-outlined".
 
 For displaying a custom HTML in the plugin, HTML file can be stored in the CloudStack management server's web application directory on the server, i.e., */usr/share/cloudstack-management/webapp* and `path` can be set to the name of the file. For displaying a service or a web page, URL can be set as the `path` of the plugin.
 
diff --git a/source/adminguide/virtual_machines.rst b/source/adminguide/virtual_machines.rst
@@ -1609,7 +1609,7 @@ Before proceeding, ensure that you have these prerequisites:
 - The vGPU-enabled XenServer 6.2 and later versions.
   For more information, see `Citrix 3D Graphics Pack <https://www.citrix.com/go/private/vgpu.html>`_.
 
-- GPU/vPGU functionality is supported for following HVM guest operating systems:
+- GPU/vGPU functionality is supported for following HVM guest operating systems:
   For more information, see `Citrix 3D Graphics Pack <https://www.citrix.com/go/private/vgpu.html>`_.
 
 - Windows 7 (x86 and x64)
diff --git a/source/adminguide/vm_volume_allocators.rst b/source/adminguide/vm_volume_allocators.rst
@@ -51,11 +51,11 @@ Use global configuration parameter:
 **vm.allocation.algorithm** to specify the algorithm that the Allocator must use. By default it is configured to use "random" algorithm.
 
 
-Volme Allocator
+Volume Allocator
 --------------
 
 Volume allocator returns suitable storage pools available in the cluster where volumes of the given instance can be created. 
-To decide the storage pools, it considers factors such as disk offering, storage capactiy, availability scope etc.
+To decide the storage pools, it considers factors such as disk offering, storage capacity, availability scope etc.
 
 Volume allocator supports following algorithms to select a host in the cluster:
 
diff --git a/source/developersguide/dev.rst b/source/developersguide/dev.rst
@@ -555,7 +555,7 @@ is added to the new class named CSExceptionErrorCode.
 
 4475 : "com.cloud.exception.InsufficientStorageCapacityException"
 
-4480 : "com.cloud.exception.InsufficientVirtualNetworkCapcityException"
+4480 : "com.cloud.exception.InsufficientVirtualNetworkCapacityException"
 
 4485 : "com.cloud.exception.InternalErrorException"
 
diff --git a/source/developersguide/get_help.rst b/source/developersguide/get_help.rst
@@ -38,7 +38,7 @@ The following guides are available:
 -  CloudStack Concepts and Terminology
 -  Quick Installation Guide
 -  Installation Guide
--  Upgradong CloudStack
+-  Upgrading CloudStack
 -  Usage Guide
 -  Developers Guide
 -  Plugins Guide
diff --git a/source/installguide/configuration.rst b/source/installguide/configuration.rst
@@ -678,7 +678,7 @@ Core Zone
       your XenServer or KVM install).
 
    .. note::
-      For security reasons there are ways to use non-adminstrative users for
+      For security reasons there are ways to use non-administrative users for
       adding a host. Please refer to the hypervisor setup guides for further information.
 
    -  **Host Tags.** Any labels that you use to categorize
@@ -814,7 +814,7 @@ To work with limited compute resources, an Edge zone will not deploy system VMs.
    -  **Password.** (Obligatory if Password authentication is selected) This is the password for the user named above.
 
    .. note::
-      For security reasons there are ways to use non-adminstrative users for
+      For security reasons there are ways to use non-administrative users for
       adding a host. Please refer to the hypervisor setup guides for further information.
 
    -  **Host Tags.** Any labels that you use to categorize
@@ -1450,8 +1450,8 @@ leads to the dynamic creation of a StorPool volume, which has guaranteed
 performance. Such a StorPool volume is associated with one CloudStack volume,
 so performance of the CloudStack volume does not vary depending on how
 heavily other tenants are using the system. The volume migration is supported
-accross non-managed storage pools (e.g. NFS/Local storage/Ceph) to StorPool, and
-accross StorPool storage pools.
+across non-managed storage pools (e.g. NFS/Local storage/Ceph) to StorPool, and
+across StorPool storage pools.
 
 For detailed information about *Command*, *Scope*, *Hypervisor*, and other
 parameters you need to specify when setting up the StorPool plug-in, see the
diff --git a/source/installguide/hypervisor/vsphere.rst b/source/installguide/hypervisor/vsphere.rst
@@ -270,7 +270,7 @@ Configure Virtual Switch
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 During the initial installation of an ESXi host a default virtual switch
-vSwitch0 is created. You may need to create additional vSwiches depending
+vSwitch0 is created. You may need to create additional vSwitches depending
 on your required architecture. CloudStack requires all ESXi hosts in the cloud
 to use consistently named virtual switches. If
 you change the default virtual switch name, you will need to configure
@@ -878,7 +878,7 @@ The three fields to fill in are:
 
    **nexusdvs**: Represents Cisco Nexus 1000v distributed virtual switch.
 
-   If nothing specified (left empty), zone-level default virtual switchwould 
+   If nothing specified (left empty), zone-level default virtual switch would
    be defaulted, based on the value of global parameter you specify.
 
    Following are the global configuration parameters:
diff --git a/source/plugins/cloudstack-kubernetes-service.rst b/source/plugins/cloudstack-kubernetes-service.rst
@@ -253,7 +253,7 @@ On successful creation, the new cluster will automatically be started and will s
 
 .. note::
    - A minimum of 2 cores of CPU and 2GB of RAM is needed for deployment. Therefore, the serviceofferingid parameter of createKubernetesCluster API must be provided with the ID of such compute offerings that conform to these requirements.
-   - Private docker registry related parameters of createKubenetesCluster API (dockerregistryusername, dockerregistryusername, dockerregistryurl, dockerregistryemail) provides experimental functionality. To use them during cluster deployment value for global setting, cloud.kubernetes.cluster.experimental.features.enabled, must be set to true by admin beforehand.
+   - Private docker registry related parameters of createKubernetesCluster API (dockerregistryusername, dockerregistryusername, dockerregistryurl, dockerregistryemail) provides experimental functionality. To use them during cluster deployment value for global setting, cloud.kubernetes.cluster.experimental.features.enabled, must be set to true by admin beforehand.
 
 Listing Kubernetes clusters
 ############################
diff --git a/source/releasenotes/about.rst b/source/releasenotes/about.rst
@@ -54,7 +54,7 @@ This means that Centos7 (EL7) is no longer supported.
 
 Events Message Bus Change
 =========================
-On upgrading from 4.19.x or lower, existing AMQP or Kafka intergration
+On upgrading from 4.19.x or lower, existing AMQP or Kafka integration
 configurations should be moved from folder
 ``/etc/cloudstack/management/META-INF/cloudstack/core`` to
 ``/etc/cloudstack/management/META-INF/cloudstack/event``
