Install an integration
Install a Marketplace integration in your account, then run it on an application or a firewall with a function instance and a Rules Engine rule.
You install an integration from Azion Marketplace, then run it on an application or a firewall from Azion Console. This page is the procedure every integration shares. Each integration also has its own guide, with the arguments it takes. For that list and where each integration runs, refer to Marketplace integrations.
Integrations install in one of two ways. Some open an install drawer that sets the integration up on an application you select. Others add the integration’s function to your account at once. You then turn on the Functions module of an application or a firewall, create a function instance there, and create a Rules Engine rule that runs the instance.
Prerequisites
- An Azion account. To sign in, refer to How to access Azion Console.
- An application served by a workload. To create one, refer to Applications quickstart.
- For an integration that runs on a firewall, a firewall and the Azion CLI installed and authorized. The CLI binds the firewall to the workload.
- Turning on a product or a module can generate usage costs. For more information, refer to Pricing.
Install the integration
You install an integration once per account. To install it from Azion Console:
Access Azion Console > Marketplace.
Enter the integration’s name in the Search on Marketplace field, then select its card. Browsing the cards and the Categories reaches the same page.
What happens next depends on the integration.
If the Install an Integration drawer opens, the integration ships an install template. To complete the drawer:
In the Select an Application section, select an Application. To create one, select Create New.
The drawer renders a form with the integration’s own arguments. The integration’s guide describes each one.
The drawer lists the privileges Azion Marketplace requires on the selected application. For what each one allows, refer to Marketplace permissions.
Azion Console confirms that the integration was installed, and the integration runs on the selected application. The sections below do not apply to it.
If no drawer opens, the install completes at once. The card shows Successfully installed! and Latest version installed!, and the function is listed in the Function list of the Create Instance drawer. Continue with Run it on an application or Run it on a firewall, as the integration’s guide states.
Run it on an application
An integration that runs on an application needs three changes on that application. Do them in the order below.
Turn on the Functions module
An application runs an installed function only while its Functions module is on. To turn on the module:
Access Azion Console > Applications > your application.
In the Main Settings tab, go to the Modules section.
The application shows a Functions Instances tab where you instantiate the function.
Create the function instance
A function instance holds the arguments the integration reads on one application. To create the instance:
In Applications, select your application, then select the Functions Instances tab.
An application with no instance yet offers the same action as Function Instance. The Create Instance drawer opens.
In Name, enter a unique name that identifies the instance.
In Function, select the integration. The Arguments editor fills with the integration’s default arguments in JSON.
In Arguments, replace the default values with your own. The integration’s guide describes each key.
The instance appears in the Functions Instances tab with the name you entered.
Create the rule
The instance runs only when a Rules Engine rule calls it with the Run Function behavior. The rule below matches every request. To create it:
In Applications, select your application, then select the Rules Engine tab.
In Name, enter a name. For example: Run my integration.
In the Phase section, select Request Phase.
In the Criteria section, keep the ${uri} variable and the starts with operator, then enter / as the argument.
In the Behaviors section, select Run Function, then select the instance by the name you gave it.
The rule appears in the Rules Engine tab, under the request phase, and runs the instance on every request. Some integrations need more behaviors in the same rule, such as Bypass Cache or Forward Cookies. Those behaviors and extra criteria require the Application Accelerator module, and the integration’s guide lists them.
Run it on a firewall
An integration that runs on a firewall needs three changes on the firewall, then a binding between the firewall and your workload.
Turn on the Functions module
A firewall shows its Functions Instances tab only while its Functions module is on. To turn on the module:
Access Azion Console > Firewalls > your firewall.
In the Main Settings tab, go to the Modules section.
The firewall shows the Functions Instances tab. For every setting on this form, refer to Set a firewall’s main settings.
Create the function instance
A firewall function instance holds the arguments the integration reads on that firewall. To create the instance:
In Firewalls, select your firewall, then select the Functions Instances tab.
A firewall with no instance yet offers the same action as Function Instance. The Create Instance drawer opens.
In Name, enter a unique name that identifies the instance.
In Function, select the integration. The list holds only the functions that run on a firewall.
In Arguments, replace the default values in the JSON editor with your own. The integration’s guide describes each key.
The instance is listed in the Functions Instances tab.
Create the rule
A Rules Engine for Firewall rule selects the requests that reach the instance, through the Run Function behavior. To create the rule:
In Firewalls, select your firewall, then select the Rules Engine tab.
In Name, enter a name. For example: Run my integration.
In the Criteria section, select the requests that run the integration. For example: if Hostname is equal xxxxxxxxxxxx.map.azionedge.net.
In the Behaviors section, select Run Function, then select the instance by the name you gave it.
The firewall runs the instance on every request that matches the criterion.
Bind the firewall to the workload
A firewall inspects a workload’s requests only when the workload’s deployment names it. To create a deployment that names both the application and the firewall:
The command prints the ID of the new deployment:
Requests to the workload’s domain reach the firewall, and the rule runs the instance on the requests that match its criterion.
Third-party integrations
Some integrations call a tool from another vendor. Before you install one of them, you may need an account with that vendor or an initial setup on its side. Some of these integrations can also generate usage costs with the vendor.
The Third-party account column of Marketplace integrations says which integrations need a vendor account. The integration’s own guide describes the setup.
Find and update installed integrations
Each installed integration is listed in the Function list of the Create Instance drawer. The Functions list can also show an installed integration, marked by a cart icon in the Vendor column.
Azion and its partners publish new versions of integrations. Updating creates a new instance of the integration’s function. To update an integration and move your instances to the new version, refer to Update an integration.