Abiquo 5.1

Skip to end of metadata
Go to start of metadata




Introduction to Action plans

To enable more control over cloud operations, users can create action plans that will automatically run tasks on VMs and scaling groups, and to run general tasks. 

Action plans are an important automation functionality on the platform. They can combine general tasks with tasks that run on VMs and scaling groups in different providers and have multiple triggers including alerts from custom metrics or built-in metrics. Each VM or scaling group can have multiple action plans.



Display action plans

To display action plans:
  1. Go to Control → Action plans



Create an action plan

Before you create an action plan, consider the elements that you wish to automate with the action plan. Create VMs or scaling groups, fetch metrics, and create alarms and alerts.

To create an action plan:

  1. Go to Control → Action plans, and click the + add button 
  2. Enter the action plan details
  3. Add actions: 
    1. Click the + Add button
    2. Select a general action or select a VM or scaling group and a specific action type
    3. Enter parameters as described below

Put the actions in run order using the arrow buttons. Delete actions as required using the trash can button to the left of the action name.

General information



Field

Description

Name

The name of the action plan

DescriptionA description of the action plan

Actions


Action Notes and Parameters table

ActionNotes and Parameters
Virtual machine
Increase CPUvCPUs
Decrease CPUvCPUs. Not supported by hot-reconfigure. Check OS compatibility
Increase RAM
  • RAM
  • RAM unit of GB or MB
Decrease RAM
  • RAM. Not supported by hot-reconfigure. Check OS compatibility
  • RAM unit of GB or MB 
Increase hardware profileUse the same family and type
Decrease hardware profileUse the same family and type
Resize disk
  • Amount
  • Disk unit of GB or MB
  • Selected disk
Instance
  • Name for Instance (clone) template. The platform will append the date to the name supplied
  • All disks or selected disks
Set hardware profileSelect from the available hardware profiles
General
Send email
  • Subject
  • Body
  • To (email addresses). Click the add + button to add an email address
  • Cc (copy to these addresses)
Send webhookSee webhook parameters table
Scaling group
Start maintenance


End maintenance
Scale in
Scale out

Webhook action attributes table


AttributeDescriptionRequiredDefault value
EndpointWhere to submit the requesttrue 
HTTP MethodThe type of request can be GET, POST, or PUTfalseGET
Expected HTTP status codeIf this status code is returned, continue running the action planfalse204 No Content
Request headersHeaders such as, secret, authentication, and content-typefalse 
Request contentRequest bodyfalse 


When you create actions on VMs also consider the following constraints.

  • User constraintse.g. allocation limits
  • Platform constraints: e.g. to create an instance, the VM must be deployed and powered off 
  • Hypervisor constraints: e.g. when using hot reconfigure on ESXi, you cannot decrement CPU or RAM

For the API, note that you can request the JSON schema for each action plan entry type from the API.
See: https://wiki.abiquo.com/api/latest/ActionPlansResource.html#list-action-plan-entry-templates


To run the action plan automatically, go to the Triggers tab and create an alert or schedule trigger. 




Run an action plan now

To run an action plan immediately to test it, do these steps:
  1. Go to Control → Action plans
  2. Select the action plan 
  3. On the Actions panel, click the Run action plan button  

Abiquo recommends that you run an action plan manually to test it before you create a trigger to run it automatically




Create a trigger for an action plan

The platform supports two types of triggers to run action plans: Alerts and Schedules.

To run your action plan based on metrics, select an existing alert with these steps:

  1. Go to Control → Action plans
  2. Select an action plan
  3. Below the Alerts panel, click the + add button
  4. Select an alert. For details about creating an alert, see Manage Alerts


To run your action plan automatically at selected dates and times, create a schedule trigger with these steps:

  1. Go to Control → Action plans
  2. Select an action plan
  3. Below the Schedules panel, click the + add button
  4. Enter the details of the schedule

  • To run the action plan at intervals of a fixed number of seconds within a set timeframe:
    1. Select an Interval schedule
    2. Enter the following parameters
      1. Interval seconds: the number of seconds from when the action plan excution starts to when it will start again
      2. Repeat count: the number of times to run the action plan. A value of 0 means repeat forever
      3. Start time: date and time
      4. End time: date and time
  1. After you create an interval schedule, the platform will display the execution count of how many times the action plan has run. If the repeat count is 0, the execution count is null
  • To run an action plan as specified using a Cron-type schedule, select an Advanced schedule and use the calendar selector.




Delete an action plan

If you delete an action plan, Abiquo will also delete the schedule associated with that action plan.