Updating docs to match new images / api params

Author: davidjumani

source/adminguide/autoscale_without_netscaler.rst

@@ -17,27 +17,32 @@
 Configuring AutoScale without using NetScaler
 =============================================
 
-.. warning:: 
-   This feature is currently only available on the master branch and will be 
+.. warning::
+   This feature is currently only available on the master branch and will be
    released in the 4.4 release.
 
+.. note::
+   AutoScaling is currently not supported in the new UI.
+   To manage AutoScaling, please directly invoke the
+   respective APIs or use `cloudmonkey <https://github.com/apache/cloudstack-cloudmonkey>`_,
+   the CLI tool for cloudstack
 
 What is AutoScaling?
 --------------------
 
-AutoScaling allows you to scale your back-end services or application VMs up 
-or down seamlessly and automatically according to the conditions you define. 
-With AutoScaling enabled, you can ensure that the number of VMs you are using 
-seamlessly scale up when demand increases, and automatically decreases when 
-demand subsides. Thus it helps you save compute costs by terminating underused 
-VMs automatically and launching new VMs when you need them, without the need 
+AutoScaling allows you to scale your back-end services or application VMs up
+or down seamlessly and automatically according to the conditions you define.
+With AutoScaling enabled, you can ensure that the number of VMs you are using
+seamlessly scale up when demand increases, and automatically decreases when
+demand subsides. Thus it helps you save compute costs by terminating underused
+VMs automatically and launching new VMs when you need them, without the need
 for manual intervention.
 
 
 Hypervisor support
 ------------------
 
-At that time, AutoScaling without NetScaler only supports for Xenserver. We 
+At that time, AutoScaling without NetScaler only supports for Xenserver. We
 are working to support KVM also.
 
 
@@ -46,10 +51,10 @@ Prerequisites
 
 Before you configure an AutoScale rule, consider the following:
 
--  Ensure that the necessary template is prepared before configuring AutoScale. 
-   Firstly you must install the PV-driver, which helps Xenserver collect 
-   performance parameters (CPU and memory) into VMs. Beside, When a VM is 
-   deployed by using a template and when it comes up, the application should be 
+-  Ensure that the necessary template is prepared before configuring AutoScale.
+   Firstly you must install the PV-driver, which helps Xenserver collect
+   performance parameters (CPU and memory) into VMs. Beside, When a VM is
+   deployed by using a template and when it comes up, the application should be
    up and running.
 
 
@@ -60,77 +65,77 @@ Specify the following:
 
 .. image:: /_static/images/autoscale-config.png
 
--  Template: A template consists of a base OS image and application. A 
-   template is used to provision the new instance of an application on a 
-   scaleup action. When a VM is deployed from a template, the VM can start 
-   taking the traffic from the load balancer without any admin intervention. 
-   For example, if the VM is deployed for a Web service, it should have the 
+-  Template: A template consists of a base OS image and application. A
+   template is used to provision the new instance of an application on a
+   scaleup action. When a VM is deployed from a template, the VM can start
+   taking the traffic from the load balancer without any admin intervention.
+   For example, if the VM is deployed for a Web service, it should have the
    Web server running, the database connected, and so on.
 
--  Compute offering: A predefined set of virtual hardware attributes, 
-   including CPU speed, number of CPUs, and RAM size, that the user can select 
-   when creating a new virtual machine instance. Choose one of the compute 
-   offerings to be used while provisioning a VM instance as part of scaleup 
+-  Compute offering: A predefined set of virtual hardware attributes,
+   including CPU speed, number of CPUs, and RAM size, that the user can select
+   when creating a new virtual machine instance. Choose one of the compute
+   offerings to be used while provisioning a VM instance as part of scaleup
    action.
 
--  Min Instance: The minimum number of active VM instances that is assigned to 
-   a load balancing rule. The active VM instances are the application 
-   instances that are up and serving the traffic, and are being load balanced. 
-   This parameter ensures that a load balancing rule has at least the 
+-  Min Instance: The minimum number of active VM instances that is assigned to
+   a load balancing rule. The active VM instances are the application
+   instances that are up and serving the traffic, and are being load balanced.
+   This parameter ensures that a load balancing rule has at least the
    configured number of active VM instances are available to serve the traffic.
 
--  Max Instance: Maximum number of active VM instances that should be assigned 
-   to a load balancing rule. This parameter defines the upper limit of active 
+-  Max Instance: Maximum number of active VM instances that should be assigned
+   to a load balancing rule. This parameter defines the upper limit of active
    VM instances that can be assigned to a load balancing rule.
 
-   Specifying a large value for the maximum instance parameter might result in 
-   provisioning large number of VM instances, which in turn leads to a single 
-   load balancing rule exhausting the VM instances limit specified at the 
+   Specifying a large value for the maximum instance parameter might result in
+   provisioning large number of VM instances, which in turn leads to a single
+   load balancing rule exhausting the VM instances limit specified at the
    account or domain level.
 
 Specify the following scale-up and scale-down policies:
 
--  Duration: The duration, in seconds, for which the conditions you specify 
-   must be true to trigger a scaleup action. The conditions defined should 
-   hold true for the entire duration you specify for an AutoScale action to be 
+-  Duration: The duration, in seconds, for which the conditions you specify
+   must be true to trigger a scaleup action. The conditions defined should
+   hold true for the entire duration you specify for an AutoScale action to be
    invoked.
 
--  Counter: The performance counters expose the state of the monitored 
+-  Counter: The performance counters expose the state of the monitored
    instances. We added two new counter to work with that feature:
 
    -  Linux User CPU [native] - percentage
    -  Linux User RAM [native] - percentage
 
-   Remember to choose one of them. If you choose anything else, the 
+   Remember to choose one of them. If you choose anything else, the
    autoscaling will not work.
 
--  Operator: The following five relational operators are supported in 
-   AutoScale feature: Greater than, Less than, Less than or equal to, Greater 
+-  Operator: The following five relational operators are supported in
+   AutoScale feature: Greater than, Less than, Less than or equal to, Greater
    than or equal to, and Equal to.
 
--  Threshold: Threshold value to be used for the counter. Once the counter 
-   defined above breaches the threshold value, the AutoScale feature initiates 
+-  Threshold: Threshold value to be used for the counter. Once the counter
+   defined above breaches the threshold value, the AutoScale feature initiates
    a scaleup or scaledown action.
 
 -  Add: Click Add to add the condition.
 
-   Additionally, if you want to configure the advanced settings, click Show 
+   Additionally, if you want to configure the advanced settings, click Show
    advanced settings, and specify the following:
 
--  Polling interval: Frequency in which the conditions, combination of counter, 
-   operator and threshold, are to be evaluated before taking a scale up or 
+-  Polling interval: Frequency in which the conditions, combination of counter,
+   operator and threshold, are to be evaluated before taking a scale up or
    down action. The default polling interval is 30 seconds.
 
--  Quiet Time: This is the cool down period after an AutoScale action is 
-   initiated. The time includes the time taken to complete provisioning a VM 
-   instance from its template and the time taken by an application to be ready 
-   to serve traffic. This quiet time allows the fleet to come up to a stable 
+-  Quiet Time: This is the cool down period after an AutoScale action is
+   initiated. The time includes the time taken to complete provisioning a VM
+   instance from its template and the time taken by an application to be ready
+   to serve traffic. This quiet time allows the fleet to come up to a stable
    state before any action can take place. The default is 300 seconds.
 
--  Destroy VM Grace Period: The duration in seconds, after a scaledown action 
-   is initiated, to wait before the VM is destroyed as part of scaledown 
-   action. This is to ensure graceful close of any pending sessions or 
-   transactions being served by the VM marked for destroy. The default is 120 
+-  Destroy VM Grace Period: The duration in seconds, after a scaledown action
+   is initiated, to wait before the VM is destroyed as part of scaledown
+   action. This is to ensure graceful close of any pending sessions or
+   transactions being served by the VM marked for destroy. The default is 120
    seconds.
 
 -  Apply: Click Apply to create the AutoScale configuration.
@@ -139,39 +144,39 @@ Specify the following scale-up and scale-down policies:
 Disabling and Enabling an AutoScale Configuration
 -------------------------------------------------
 
-If you want to perform any maintenance operation on the AutoScale VM instances, 
-disable the AutoScale configuration. When the AutoScale configuration is 
-disabled, no scaleup or scaledown action is performed. You can use this 
-downtime for the maintenance activities. To disable the AutoScale 
+If you want to perform any maintenance operation on the AutoScale VM instances,
+disable the AutoScale configuration. When the AutoScale configuration is
+disabled, no scaleup or scaledown action is performed. You can use this
+downtime for the maintenance activities. To disable the AutoScale
 configuration, click the Disable AutoScale button.
 
-The button toggles between enable and disable, depending on whether AutoScale 
-is currently enabled or not. After the maintenance operations are done, you 
-can enable the AutoScale configuration back. To enable, open the AutoScale 
+The button toggles between enable and disable, depending on whether AutoScale
+is currently enabled or not. After the maintenance operations are done, you
+can enable the AutoScale configuration back. To enable, open the AutoScale
 configuration page again, then click the Enable AutoScale button.
 
 
 Updating an AutoScale Configuration
 -----------------------------------
 
-You can update the various parameters and add or delete the conditions in a 
-scaleup or scaledown rule. Before you update an AutoScale configuration, 
-ensure that you disable the AutoScale load balancer rule by clicking the 
+You can update the various parameters and add or delete the conditions in a
+scaleup or scaledown rule. Before you update an AutoScale configuration,
+ensure that you disable the AutoScale load balancer rule by clicking the
 Disable AutoScale button.
 
-After you modify the required AutoScale parameters, click Apply. To apply the 
-new AutoScale policies, open the AutoScale configuration page again, then 
+After you modify the required AutoScale parameters, click Apply. To apply the
+new AutoScale policies, open the AutoScale configuration page again, then
 click the Enable AutoScale button.
 
 
 Runtime Considerations
 ----------------------
 
-An administrator should not assign a VM to a load balancing rule which is 
+An administrator should not assign a VM to a load balancing rule which is
 configured for AutoScale.
 
-Making API calls outside the context of AutoScale, such as destroyVM, on an 
-autoscaled VM leaves the load balancing configuration in an inconsistent state. 
-Though VM is destroyed from the load balancer rule, it continues be showed as 
+Making API calls outside the context of AutoScale, such as destroyVM, on an
+autoscaled VM leaves the load balancing configuration in an inconsistent state.
+Though VM is destroyed from the load balancer rule, it continues be showed as
 a service assigned to a rule inside the context of AutoScale.
 

source/adminguide/backup_and_recovery.rst

@@ -12,7 +12,7 @@
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
- 
+
 About Backup And Recovery
 --------------------------
 
@@ -41,7 +41,7 @@ Backup and recovery has been designed to support two modes:
 - Adhoc and user scheduled backups
 
 'SLA' based backups are ones where the Cloud provider (ie the root admin) controls the time, and frequency of a backup scheme.
-A user signs up for a 'Gold' offering, which might give them a RPO of 12 hours and the last 14 backups kept; however the user would not be 
+A user signs up for a 'Gold' offering, which might give them a RPO of 12 hours and the last 14 backups kept; however the user would not be
 allowed to perform additional backups nor set the exact time that these backups took place.  The user might be charged
 a fix rate for these backups regardless of the size of the backups.
 
@@ -89,7 +89,7 @@ backups. Users can list and consume the imported backup offerings, only root adm
 delete offerings.
 
 Supported APIs:
-~~~~~~~~~~~~~~~~ 
+~~~~~~~~~~~~~~~~
 
 - **listBackupProviders**: lists available backup provider plugins
 - **listBackupProviderOfferings**: lists external backup policy/offering from a provider
@@ -109,18 +109,18 @@ To import a backup provider offering;
 #. Enter your user-friendly name and description and select the applicable zone.  The External ID will then be populated with the
    template jobs which CloudStack retrieves from the connected provider.
 
-   |B&R-backup_offering_policy.jpg|  |B&R-backup_offering.jpg|
+   |B&R-backup_offering_policy.png|  |B&R-backup_offering.png|
 
 Creating VM Backups
 ---------------------
 
 SLA/Policy Based backups
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-With the backup and recovery feature enabled for a zone, users simply add and 
+With the backup and recovery feature enabled for a zone, users simply add and
 remove a VM from a backup offering.
 
-|B&R-assignOffering.jpg|
+|B&R-assignOffering.png|
 
 Adhoc and Scheduled Backups
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -133,16 +133,16 @@ allowed to add/remove volumes similar to VM snapshots.
 To trigger an adhoc backup of a VM, navigate to the instance and click on the 'Create Backup'
 icon.
 
-|B&R-createBackup.jpg|
+|B&R-createBackup.png|
 
 To setup a recurring backup schedule, navigate to the instance and click on the 'Backup Schedule'
 icon.
 
-|B&R-BackupSchedule.jpg|
+|B&R-BackupSchedule.png|
 
 Then set the time and frequency of the backups, click 'Configure' and then 'Close'
 
-|B&R-BackupScheduleEntry.jpg|
+|B&R-BackupScheduleEntry.png|
 
 Restoring VM Backups
 ---------------------
@@ -169,21 +169,21 @@ Supported APIs:
 - **restoreVolumeFromBackup**: restore and attach a backed-up volume (of a VM backup) to a specified VM.
 
 
-.. |B&R-assignOffering.jpg| image:: /_static/images/B&R-assignOffering.jpg
+.. |B&R-assignOffering.png| image:: /_static/images/B&R-assignOffering.png
    :alt: Assigning an SLA/Policy to a VM.
    :width: 400 px
-.. |B&R-backup_offering_policy.jpg| image:: /_static/images/B&R-backup_offering_policy.jpg
+.. |B&R-backup_offering_policy.png| image:: /_static/images/B&R-backup_offering_policy.png
    :alt: Importing an SLA/Policy offering.
    :width: 300 px
-.. |B&R-backup_offering.jpg| image:: /_static/images/B&R-backup_offering.jpg
+.. |B&R-backup_offering.png| image:: /_static/images/B&R-backup_offering.png
    :alt: Importing a template backup offering.
    :width: 300 px
-.. |B&R-createBackup.jpg| image:: /_static/images/B&R-createBackup.jpg
+.. |B&R-createBackup.png| image:: /_static/images/B&R-createBackup.png
    :alt: Triggering an adhoc backup for a VM.
    :width: 400 px
-.. |B&R-BackupSchedule.jpg| image:: /_static/images/B&R-BackupSchedule.jpg
+.. |B&R-BackupSchedule.png| image:: /_static/images/B&R-BackupSchedule.png
    :alt: Creating a backup schedule for a VM.
    :width: 400 px
-.. |B&R-BackupScheduleEntry.jpg| image:: /_static/images/B&R-BackupScheduleEntry.jpg
+.. |B&R-BackupScheduleEntry.png| image:: /_static/images/B&R-BackupScheduleEntry.png
    :alt: Creating a backup schedule for a VM.
    :width: 400px