Manage action plans
Introduction to action plans
To enable more control over cloud operations, users can create no-code action plans that can automatically run tasks on VMs and scaling groups, and to run general tasks, such as sending an email or web hook.
Action plans are an important automation functionality of 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, built-in metrics, budget alerts, and schedules.Â
Users can select groups of VMs or scaling groups to run actions based on tags. And multiple action plans can apply to a VM or scaling group.
Display action plans
To display action plans:
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:
Go to Control → Action plans, and click the + add buttonÂ
Enter the action plan details
Create action plan: general informationGo to Actions to add actions:Â
Click the + add button
Select the action Type: general action, VM, scaling group, VMs by tags, scaling groups by tags
If you are selecting by tags, then enter the tag filter.
See Search for resources by tag and filter searchÂEnter action details
Decrease CPU/RAM: you cannot use this with hot-reconfigure and you must check that the OS is compatible
Instance: Name for Instance (clone) template. The platform will append the date to the name supplied
Webhook action -Â Expected HTTP status code:Â If this status code is returned, continue running the action plan. Default:Â
204 No Content
Email action - To, CC:Â Enter email addresses as a comma separated list
Â
For more details, see Action plan actions table and Webhook actions table below.
Â
Put the actions in run order using the arrow buttons
To run the action plan automatically, go to the Triggers tab and create an alert or schedule trigger.Â
When you create actions on VMs also consider the following constraints.
User constraints:Â e.g. allocation limits
Platform constraints: e.g. to create an instance, the VM must be deployed and powered offÂ
Hypervisor constraints: e.g. with hot reconfigure on ESXi, you cannot reduce CPU or RAM
For the API 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
Â
Action plan actions table
Action | Notes and Parameters |
---|---|
Virtual machine | Â |
Increase CPU | vCPUs |
Decrease CPU | vCPUs. Not supported by hot-reconfigure. Check OS compatibility |
Increase RAM |
|
Decrease RAM |
|
Increase hardware profile | Use the same family and type |
Decrease hardware profile | Use the same family and type |
Resize disk |
|
Instance |
|
Set hardware profile | Select from the available hardware profiles |
General | Â |
Send email |
Enter email addresses as a comma separated list |
Send webhook | See webhook attributes table |
Scaling group | Â |
Start maintenance | Â |
End maintenance | Â |
Scale in | Â |
Scale out | Â |
Â
Webhook action attributes table
Attribute | Description | Required | Default value |
---|---|---|---|
Endpoint | Where to submit the request | true | Â |
HTTP Method | The type of request can be GET, POST, or PUT | false | GET |
Expected HTTP status code | If this status code is returned, continue running the action plan | false | 204 No Content |
Request headers | Headers such as, secret, authentication, and content-type | false | Â |
Request content | Request body | false | Â |
Run an action plan now
To run an action plan immediately to test it, do these steps:
Go to Control → Action plans
Select the action planÂ
On the Actions pane, 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:
Go to Control → Action plans
Select an action plan
Below the Alerts panel, click the + add button
Select an alert. For details about creating an alert, see Manage alerts.Â
Â
To run your action plan automatically at selected dates and times, cre
ate a schedule trigger with these steps:
Go to Control → Action plans
Select an action plan
Below the Schedules panel, click the + add button
Enter the details of the schedule using the calendar or time and repeat interval as described below
Â
 To run the action plan at intervals of a fixed number of seconds within a set timeframe:
Select an Interval schedule
Enter the following parameters
Interval seconds: the number of seconds from when the action plan execution starts to when it will start again
Repeat count: the number of times to run the action plan. A value of
0
means repeat foreverStart time: date and time
End time: date and time
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 the action plan using a Cron-type schedule:
Select an Advanced schedule
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.Â
Copyright © 2006-2024, Abiquo Holdings SL. All rights reserved