Binary releases are published on the project release page.
Alternatively, you can build from source. The tool is written in haskell, and requires the stack build tool to be installed.
Then to build a native executable, run in the repository root directory:
stack setup
stack build
Alternatively, stack can build under docker. This is useful if you wish to build a linux executable suitable for deployment. This script
./scripts/docker-build.sh
leaves a compressed executable at /tmp/camus2.x86_64-linux.gz
First copy the c2 binary to tests directory.
The integration tests rely on localstack running under docker to simulate AWS. Also note that port 80 on localhost must be available for the tests to work. To run:
Start localstack:
cd tests/localstack
docker network prune
docker-compose up -d
Confirm localstack is working (should complete without error):
export AWS_ACCESS_KEY_ID=DUMMY
export AWS_SECRET_ACCESS_KEY=DUMMY
aws --endpoint-url=http://localhost:4572 s3 ls
Run the tests:
export AWS_ACCESS_KEY_ID=DUMMY
export AWS_SECRET_ACCESS_KEY=DUMMY
cd tests
yarn test
Finally, shut down localstack, and clean up networks
cd tests/localstack
docker-compose down
docker network prune
camus2 is a standalone executable, which loads a single configuration
file on startup. But default this is expected at ../etc/camus2.yaml or
../etc/camus2.jsonrelative to the installed executable, although the
config file path can be overidden by setting the CAMUS2_CONFIG environment variable.
The configuration file must be json formatted, and be consistent with the ToolConfig ADL type (ADL is the Algebraic Data Language). Example configuration files can be found at:
Additionally, aws credentials must be supplied and will be expected at either:
$HOME/.aws/credentials file
standard environment variables
EC2 instance metadata
as per Credentials Discover mode in the amazonka library:
http://hackage.haskell.org/package/amazonka-1.6.1/docs/Network-AWS-Auth.html