A newer release of the API3 Technical documentation is available.

📂 API Providers > Docker Images

# Airnode Deployer Image

Table of Contents

Use the deployer image to deploy or remove an Airnode with a cloud provider such as AWS. The simplest way is to use the pre-built packages. If you would rather build the images yourself see the README (opens new window) in the deployer package.

Quick Deploy Demos

See the Quick Deploy Demos to quickly deploy and remove a preconfigured Airnode using the deployer image.

# Configuration Files

The files config.json and secrets.env are used to configure the Airnode. The aws.env and gcp.json files are used to define environment information the deployer uses to connect to these cloud providers.

my-airnode
├── aws.env     <- Used for AWS deployment
├── gcp.json    <- Used for GCP deployment
├── config.json
└── secrets.env

1
2
3
4
5

# Cloud Provider Credentials

In order to deploy Airnode to a serverless cloud provider, you need to provide could provider credentials to the Airnode deployer image. The deployer image currently supports deploying to AWS and GCP. For AWS deployment, see the AWS Setup and for GCP deployment, see the GCP Setup.

# Deployer Image Commands

All three commands are similar for AWS and GCP, with differences noted where they exist.

# `deploy`

The deploy command will create the Airnode with a cloud provider or update it if it already exists. Three files are needed to run the deploy command.

config.json
secrets.env
aws.env (AWS only)
gcp.json (GCP only)

See Deploying an Airnode for deployment commands specific to various operating systems and cloud providers.

Note that a receipt.json file will be created upon completion. It contains some deployment information and is used to remove the Airnode.

Warning about simultaneous deployments

Avoid running multiple deployments simultaneously as doing so might result in a broken deployment. If this occurs, the standard removal approach may not succeed and Manual Removal may be required.

Normally (for Linux/Mac/WSL2) the deployer image deploy command is run by the user root. This may cause permission issues when the receipt.json file is generated. Optionally you can specify the UID (user identifier) and GID (group identifier) that the deployer image should use. Do so by setting the environment variables USER_ID and GROUP_ID, otherwise omit the line containing the variables.

Re-deployments

A unique deployment is defined by the value of nodeSetting.stage. If you deploy again, using the same nodeSetting.stage value, then you are re-deploying or updating the previous deployment.

By default the deployer will attempt to remove the Airnode should either a deployment or re-deployment fail. But if either fails (and --auto-remove is false) then the Airnode will not be removed, however it could be left in an unstable state. You can alter the deploy command to change this behavior using the following.

--auto-remove true|false: defaults to true
--no-auto-remove

Auto removal is usually recommended for development deployments. For production deployments, consider changing the value of nodeSetting.stage to create a new deployment and follow-up by removing the previous deployment.

Use the following example to avoid the automatic removal of the Airnode.

docker run -it --rm \
-e USER_ID=$(id -u) -e GROUP_ID=$(id -g) \
-v "$(pwd):/app/config" \
api3/airnode-deployer:0.9.2 deploy --auto-remove false

1
2
3
4

# `remove-with-receipt`

When an Airnode was deployed using the deploy command, a receipt.json file was created. This file is used to remove the Airnode. The remove-with-receipt command (identical for AWS and GCP) is the recommended way to remove a deployment, but there are alternatives as described below.

# `remove-with-deployment-details`

The remove-with-deployment-details command is available as an alternative to remove-with-receipt and uses the Airnode short address and cloud provider specifications. All values, other than airnodeShortAddress, can be found in config.json. Note that relative to AWS Airnode removal, GCP Airnode removal requires an additional parameter: projectId.

--airnode-address: Can be found in the receipt.json file or obtained via Admin CLI command derive-airnode-address
--stage: nodeSetting.stage
--cloud-provider: nodeSetting.cloudProvider.type
--region: nodeSetting.cloudProvider.region
--project-id: (GCP only) nodeSetting.cloudProvider.projectId

Note that the example commands below use placeholder values for a GCP deployment that should be replaced.

# Manual Removal

Optionally you can remove an Airnode manually though it is highly recommended that you do so using the deployer image's remove-with-receipt or remove-with-deployment-details commands. When removing manually, you will need the short Airnode address, airnodeAddressShort (e.g., 0ab830c) and the Airnode stage name (e.g., production). These are included in the element name of AWS and GCP deployed features. Airnode has a presence in several areas of both AWS and GCP as listed below.

Remember

Only delete elements of a feature with the airnodeAddressShort address and stage name contained in the element's name. There can be more than one Airnode. Example: (airnode-6a6cf2d-production-run), where 6a6cf2d is the airnodeShortAddress and production is the stage name.

Learn more about AWS or GCP resources that Airnode uses in the Cloud Resources doc.

← Overview Airnode Client Image →