@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
• 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.

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

• Make sure you have config.json and secrets.env ready. Then, use the deploy command to trigger your first deployment.
• In order to update the Airnode configuration:
  • Update the config.json file
  • Run the deploy command again
• 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"]
      --interactive                      Run in interactive mode                               [boolean] [default: true]

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, --airnodeAddressShort Airnode address (short version)                                                         [string]
  -s, --stage               Stage (environment)                                                                     [string]
  -c, --cloudProvider       Cloud provider                                                                          [string]
  -e, --region              Region                                                                                  [string]