README.md

ansible-avalanche-getting-started

How to use the ash.avalanche Ansible collection to provision Avalanche resources.

Documentation

The complete documentation related to this project starts by the Local Test Network Creation tutorial.

Requirements

• Python >=3.9 with venv module installed
• For the local test network:
  • 7+GiB of free RAM
  • Multipass installed (see Install Multipass)
  • Terraform installed (see Install Terraform)
• For filtering outputs:
  • jq (see Download jq)

Setup the environment

1. Clone the Getting Started repository:

   git clone https://github.com/AshAvalanche/ansible-avalanche-getting-started
   cd ansible-avalanche-collection-getting-started

2. Setup and activate Python venv:

   bin/setup.sh
   source .venv/bin/activate

3. Install the ash.avalanche collection:

   ansible-galaxy collection install git+https://github.com/AshAvalanche/ansible-avalanche-collection.git

4. Initialize the Terraform modules:

   terraform -chdir=terraform/multipass init

Bootstrap the local test network

1. Create the virtual machines that will host the validator nodes using Terraform (enter yes when prompted):

   terraform -chdir=terraform/multipass apply

2. Bootstrap the Avalanche nodes:

   ansible-playbook ash.avalanche.bootstrap_local_network -i inventories/local

Docker Compose

It is possible to build Docker images for the Avalanche nodes using Packer and run them using Docker Compose. See docker/README.md for more information.