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.

The deployer image has two commands.

  • deploy: Deploys or updates an Airnode using configuration files.
  • remove: Removes an Airnode using its receipt.json file.

Quick Deploy Demo

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

# Cloud Provider Credentials

In order to deploy Airnode to a serverless cloud provider like AWS, you need to provide could provider credentials to the Airnode deployer image. The deployer image currently supports deploying to AWS. If you are new to AWS watch this video (opens new window) to set up an AWS account and create cloud provider credentials.

# 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

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

Permissions: Linux/Mac/WSL2

Normally the deployer image 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 line #3 below -e USER_ID=$(id -u) -e GROUP_ID=$(id -g) \.

# remove

When an Airnode was deployed using the deploy command a receipt.json file was created. Use this file to remove an Airnode.

# Manual Removal

Airnode has a presence in several areas of AWS. An Airnode has a airnodeAddressShort (e.g., 0ab830c) that is included in the named elements of the following AWS features.

Remember: Only delete elements of a feature with an airnodeAddressShort in the name you are targeting. There can be more than one Airnode.

Select the region where your Airnode lives.

Click the following links and delete all elements in each feature.

Last Updated: 12/11/2021, 8:23:57 PM