APIIDA API Gateway Manager

Automations

Owned by Markus Müller
Last updated: Feb 05, 2024 by Mirco Hoffmann
2 min read

Automations allow you to perform certain actions when a trigger happens. Beside the basic automations provided by the API Gateway Manager out of the box, integrations can add their own automations.

Automations can be accessed using different ways. All of them can be managed via the “Automations” link in the left-hand menu. Automations limited to a certain environment, a certain service or a certain gateways can additionally be managed right within the details of the corresponding resource.

Triggers

The following triggers are availabe to attach an automation to:

  • Recommendation Created: This trigger is fired whenever the Advisor feature creates new recommandaten for you. See the Advisor documentation for a list of available recommendations. The trigger can be limited to a certain recommendation type, i.e. the automation is only started when a recommendation of a certain type is created.

  • Migration Assigned: Start an automation (like creating a issue in Jira or send a reminder via Slack) whenever a migration is assigned to a user.

  • Migration Started: This trigger is fired whenever a migration is started. The trigger can be limited to certain environments. It is fired in every case regardless if the migration was started using the UI, the API or the command line utiilty.

  • Migration Completed: You can start automations whenever a migration completes. This trigger fires regardless if the migration was successful or not.

  • Migration Successful: In contrast to the “Migration Completed” trigger this one only fires if the migration is successful.

  • Migration Failed: Corresponding to the “Migration Successful” trigger this one only fires if a migration fails.

  • Entity Created|Updated|Deleted: This trigger is released whenever an entity such as a user or environment is created, updated or deleted. The trigger can be limited to certain environments for entities such as clusters or nodes.

Recipes

Automations are based on recipes. Each recipes contains at least a trigger and a action that is about to be done.

Create Automation

If you have created a certain number of integrations, it may be useful to filter the recipes because the selection of (INTEGRATION) within the recipe is also filtered by the type of integration.

 

Example: Create a issue in Jira if a migration fails.

Besides the recipes the API Gateway Manager has out of the box, each integration can provide new recipes.