Project

shipitron

0.0
There's a lot of open issues
No release in over a year
A deployment tool for use with Docker and ECS.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Dependencies

Development

~> 2.1
~> 1.3
~> 0.4
~> 13.0
~> 3.10

Runtime

~> 2.0
~> 0.82
~> 3.6
~> 4.1
~> 0.6
~> 1.0
~> 0.7
~> 1.0
~> 1.0
~> 0.9
~> 1.96
 Project Readme

shipitron

A deployment tool for use with Docker and ECS

Usage

Example config file:

applications:
  dummy-app:
    repository: git@github.com:outstand/dummy-app
    cache_bucket: bucket
    build_cache_location: tmp/build-cache.tar.gz
    image_name: outstand/dummy-app
    build_script: shipitron/build.sh
    post_builds:
      - ecs_task: dummy-app
        container_name: dummy-app
        command: echo postbuild
    cluster_discovery: _ecs-prod._tcp.example.com
    shipitron_task: shipitron
    ecs_task_defs:
      - dummy-app
    ecs_services:
      - dummy-app
  • Create shipitron.yml file
  • Add needed ssh known hosts to shipitron/<app name>/git_host_key in consul k/v
  • Add git ssh deploy key to shipitron/<app name>/git_deploy_key in consul k/v
  • Add docker auth config (~/.docker/config.json after docker login) to shipitron/<app name>/docker_auth in consul k/v
  • Add deploy ref key to shipitron/<app name>/deploy_ref_key
  • docker run -it --rm -v shipitron.yml:/shipitron/config/shipitron.yml outstand/shipitron:<version> deploy <app>

New shipitron config file keys:

  • registry (specifies an alternate docker registry):
---
applications:
  foobar:
    registry: 12345.dkr.ecr.us-east-1.amazonaws.com
  • skip_push (shipitron will skip pushing the docker images; use if the build script takes care of this):
---
applications:
  foobar:
    skip_push: true

Additionally, the build script will receive the named tag in use as $2.

Containerized tool support

Shipitron now supports starting other containers as part of the build process. We're using this to use the aws cli to transfer files to/from s3. Shipitron's task definition needs to have a task scoped docker volume added with the name shipitron-home. This volume will be mounted at /home/shipitron and should be shared with any new containers:

shipitron_home_volume = FindDockerVolumeName.call!(
  container_name: 'shipitron',
  volume_search: /shipitron-home/
).volume_name

docker run ... -v #{shipitron_home_volume}:/home/shipitron ...

This allows the containers to share data with each other. ECS will automatically clean up the task scoped container.

If a containerized tool requires access to AWS resources, be sure to pass the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI to it so it can inherit any task roles.

Development

  • desk go
  • dev build --pull shipitron
  • rspec specs to run specs
  • Set the application path in the volumes section in compose.yml.
  • shipitron deploy <app> to run client side
  • shipitron deploy <app> --simulate-store-deploy to save the deploy options to S3 and generate deploy id
  • dev run --rm -v /bin/docker:/bin/docker -v /var/run/docker.sock:/var/run/docker.sock shipitron server_deploy --deploy-id <deploy_id> to run server side

Running a dev version in production:

  • Ensure SHIPITRON_STARTED_BY env var is set for your shipitron-staging task def
  • docker build --pull -t outstand/shipitron:staging -f Dockerfile.staging .
  • docker push outstand/shipitron:staging
  • Update config to use shipitron_task: shipitron-staging and outstand/shipitron:staging
  • shipitron deploy <app> --debug

To release a new version:

  • Update the version number in version.rb and Dockerfile.release and commit the result.
  • dev build --pull shipitron
  • release_gem
  • VERSION=<version>
  • docker build -t outstand/shipitron:$VERSION -f Dockerfile.release .
  • docker push outstand/shipitron:$VERSION
  • docker tag outstand/shipitron:$VERSION outstand/shipitron:latest
  • docker push outstand/shipitron:latest
  • Update ECS task definition with new version