@api3/airnode-deployer

@api3/airnode-deployer

Airnode deployment CLI and its docker image

User documentation

You can find documentation on how to use the deployer in the deployer docs.

For developers

The rest of the README contains instructions on how to build and use the deployer CLI. However, the intended way to run the deployer for users is using the deployer docker image.

Prerequisites

• Install Terraform v0.15.x and make sure that the terraform binary is available in your PATH
• AWS deployment - Make sure your AWS credentials are stored in the configuration file or exported as environment variables. If you need help setting up an AWS IAM user you can follow this video tutorial.
• GCP deployment
  • Create a Google Cloud project
  • Install Google Cloud SDK and obtain your Application Default Credentials
  • Enable CloudFunction API, Cloud Build API and Cloud Scheduler API for your project

Setup

• Build all the Airnode packages

# Run from the root
yarn build

• Make sure config.json and secrets.env are available in the config directory. You can use the provided example config.json and secrets.env templates to get started quickly, but you will need to edit these with your own API details and secrets.

# From this package (/packages/airnode-deployer)
cp config/config.json.example config/config.json
cp config/secrets.env.example config/secrets.env
# Edit both `config.json` and `secrets.env` to reflect your configuration

Common user flow

1. Make sure you have config.json and secrets.env ready. Then, use the deploy command to trigger your first deployment.
2. In order to update the Airnode configuration:
   • Update the config.json file
   • Run the deploy command again
3. Use the remove command to remove the Airnode deployment. Use the -r option to provide the receipt file from the latest deployment.

Commands

deploy

Deploys an Airnode instance using the `config.json` and `secrets.env` files. This can be used for a new deployment or to update an existing deployment.

Options:
      --version                          Show version number                                                   [boolean]
      --debug                            Run in debug mode                                    [boolean] [default: false]
      --help                             Show help                                                             [boolean]
  -c, --configuration, --config, --conf  Path to configuration file             [string] [default: "config/config.json"]
  -s, --secrets                          Path to secrets file                   [string] [default: "config/secrets.env"]
  -r, --receipt                          Output path for receipt file          [string] [default: "output/receipt.json"]

remove

Removes a deployed Airnode instance

Options:
      --version                Show version number                                                             [boolean]
      --debug                  Run in debug mode                                              [boolean] [default: false]
      --help                   Show help                                                                       [boolean]
  -r, --receipt                Path to receipt file                                                             [string]
  -a, --airnode-address-short  Airnode Address (short version)                                                  [string]
  -s, --stage                  Stage (environment)                                                              [string]
  -c, --cloud-provider         Cloud provider                                                    [choices: "aws", "gcp"]
  -e, --region                 Region                                                                           [string]
  -p, --project-id             Project ID (GCP only)                                                            [string]