consul-deployment-agent

[TeamCity pipeline] (http://infra.teamcity.ci.ttldev/project.html?projectId=PlatformServices_ConsulDeploymentAgent&tab=projectOverview)

Command line options

$ python agent/core.py -h
usage: core.py [-h] [-config-dir CONFIG_DIR] [-v]

optional arguments:
  -h, --help            show this help message and exit
  -config-dir CONFIG_DIR
                        Location of configuration files (e.g. config.yml and
                        config-logging.yml)
  -v, --version         show program's version number and exit

Configuration

Deployment agent supports multiple configuration files. The agent will look for configuration files in the same directory as the executable.

Filename	Description	Example
config-logging.yml	(optional) Python logging module configuration. If not specified, logs will be sent to stdout with level set to DEBUG.	[sample-config-logging.yml] (https://github.thetrainline.com/PlatformServices/consul-deployment-agent/blob/master/config/sample-config-logging.yml)
config.yml	(optional) Various configuration settings. See example for supported options.	[sample-config.yml] (https://github.thetrainline.com/PlatformServices/consul-deployment-agent/blob/master/config/sample-config.yml)

Development

Prerequisites (Linux and Windows)

1. Python (using 2.7+)
2. Consul agent

Linux development

First, initialise the dependencies by running:

  sudo make init

Start Consul agent in development mode:

  consul agent -dev

To start the deployment agent:

  python agent/core.py

Running the tests:

  sudo make init-test
  make test

Windows development

First, initialise the dependencies by running:

  pip install -r requirements.txt

Start Consul agent in development mode:

  consul agent -dev -advertise=127.0.0.1

Start the deployment agent:

  python agent/core.py

Running the tests:

  pip install -r test-requirements.txt
  nosetests --verbosity=2 tests

Deployment simulation

Follow these steps to perform a deployment simulation:

1. Upload a deployment package to tl-deployment-sandbox S3 bucket in the Sandbox account
2. Start Consul agent as per instructions above.
3. Start Consul deployment agent as per instructions above.
4. Run the following script to trigger the deployment:

  ./scripts/deploy_service.py -n <service_name> -p <service_port> -v <version> -s <slice_name> -t <environment_type> -c <cluster_name> -b tl-deployment-sandbox -k <s3_object_key>