Contents

The only host dependency is docker-compose; nothing is directly installed; docker-machine can be used if directory mounting is set up and/or paths are specified in an override file -- with a cloud-based host, the first run should take less than a minute, and the daemons should bootstrap within 2-3

The only remote dependency is a pristine default VPC and security group in an AWS account

.
├── default.env
├── docker-compose.yml
├── (override.yml)
├── .gitignore
├── README.md
├── build
├── infrastructure
└── source

1. The build directory is for integrating these artifacts with a CI system; e.g. an image that can manage the infrastructure and deployment of the workload
2. The infrastructure directory is for declarative code-config describing the deployment target infrastructure
3. The source directory is for building and packaging the workload itself

Overview

The design is based on a subset of the following parameters:

• ✅ coin daemon: the workload above is the btcd daemon
• ✅ playbook: an ansible playbook stands in for a CI file
• ✅ verify sources: git tag signature is checked on go-get cloned repo
• ✅ compile sources: package is go-get compiled
• ✅ registry: ecr is used
• ❌ ec2: fargate is used
• ❌ atomic (Dockerfile and daemon requirements too simple)
• ❌ k8s (scheduler requirements too simple)
• ❌ ansible-container (Dockerfile too simple to benefit; does not cache image layers)

The invocation layers that emulate a CI process (and can be integrated into one at any layer) are the following:

1. Compose builds the CI image
2. CI container invokes Ansible
3. Ansible invokes local tools and APIs

Quick Start

The expected environment variables without reasonable defaults (i.e. credentials) are pass-thru declared (no values given) in default.env. There are two methods of setting them before executing the CI process, which provisions a small-footprint cluster and deploys the btcd daemon.

The build, infrastructure and source directories can also be used directly with their respective tools, Ansible, Terraform and Docker.

RPC is enabled on the coin daemon, but ingress is not added to the default security group automatically; daemon operation can be monitored via CloudWatch

Environment Option

Set variables in the shell environment: AWS_ACCESS_KEY_ID=**** ... docker-compose up --build. On subsequent runs the rebuild will short-circuit and the build switch is not necessary.

Override File Option

Create an override file to use with docker-compose, and set the variables there: docker-compose -f docker-compose.yml -f override.yml up --build. On subsequent runs the rebuild will short-circuit and the build switch is not necessary.

Configuration

The file default.env exposes basic configuration, some of which overrides ./source/btcd.conf; keys that are not commented out are sourced from that file, and any additional ones can be added to it from the doc: https://github.com/btcsuite/btcd/blob/BTCD_0_12_0_BETA/sample-btcd.conf

Cleanup

After building the CI image, you can clean up everything at once with the run subcommand: ... run ci destroy=everything, where the part before "run" remains like the part before "up". The CMD is passed to Ansible as extra variables to the playbook executable. There is also the option to pass destroy=infrastructure, which leaves the low-cost remote state resources in place.