An attempt to centralize the configuration and building of application environments at eLife, locally (Vagrant) and remotely (AWS).
Download:
git clone ssh://git@github.com/elifesciences/builder
Install:
./update.sh
Fix any missing pre-requisites and call ./update.sh again until you see the happy
all done
message. Updating in the future is as simple as:
git pull
./update.sh
If you are outside of the eLife organization, make sure to set the write-context-to-s3 and write-keypairs-to-s3 keys in settings.yml keys are False. Their use is related to backing up information about the generated resources on an S3 bucket, but the customization of this bucket is not supported yet.
Your settings.yaml file was created automatically and contains options for tweaking the behaviour of builder, like the project file it should be using.
By default it points to the ./projects/elife.yaml project file. This file describes all eLife projects that can be built and their environments. See here for more
project file documentation.
Project files and the settings.yml file are the only two places where configuration is supported.
'configuration' also exists in
./src/buildercore/config.pyif you're abuilderdev.
After successfully installing and configuring builder, launching a Vagrant instance is a good test that all is working correctly.
The Vagrantfile can build any project, you just need to tell it which one:
$ vagrant up
You must select a project:
1 - journal--vagrant
2 - api-gateway--vagrant
3 - ...
>
... or it can be done with environment variables:
$ PROJECT=journal vagrant up
Note: if you with to use a private key not in ~/.ssh/id_rsa, you can customize the SSH key path.
Note: if you wish to use a hypervisor other than virtualbox, you can use the vagrant-mutate plugin
to rebuild the ubuntu/trusty64 box for your own hypervisor. See the vagrant and virtualbox documentation.
The other half of the builder project is the ability to create and manage AWS resources. This is controlled with the "bldr" script:
$ ./bldr -l
Will list all builder tasks found in src/. These tasks are just Python functions.
builder relies on a ~/.aws/credentials file containing configuration for accessing your AWS account.
A master-server instance must exist before project instances can be brought up. See here for a walkthrough.
To launch a project backed by a code repository to AWS:
$ ./bldr deploy
// or specify project and environment
$ ./bldr deploy:journal,prod
To launch a instance of any project to AWS, use:
// or specify project and environment
$ ./bldr launch:api-gateway,prod
To ssh into one of these machines:
$ ./bldr ssh:journal--prod
General:
AWS:
Troubleshooting:
Development
The builder project is MIT licenced.
The builder project was GPL3 licensed until this commit on 2016-07-13.