/genova

AWS ECS Deployment manager

Primary LanguageRubyMIT LicenseMIT

genova

CircleCI Maintainability Test Coverage MIT License

Description

genova provides feature to deploy and manage applications on AWS ECS.

Overview

genova is integrated package for deploying applications to ECS. You can deploy services, execute tasks, and execute scheduled tasks. As deployment method, interactive deployment using Slack, CLI, and continuous delivery with GitHub is supported. When you request deployment, starts deployment as follows.

  1. Get target repository code
  2. Find Dockerfile from deploy configuration (config/deploy.yml)
  3. Build Docker and create image
  4. Create new task based on task definition (config/deploy/*.yml)
  5. Send image to ECR based on new task definition
  6. Request ECS task update
  7. ECS switches to new task

Features

genova supports following features.

  • YAML-based task definition
    • Compatible with ECS and Fargate
    • Encrypt environment variables using KMS
  • Various deployment methods
    • CLI Deploy
    • Slack interactive deploy
    • GitHub push detect deploy
  • Web console
  • Tagging after deployment

Application directory structure

Please place following files in your application.

- config
  # Deploy configuration
  - deploy.yml

  - deploy
    # Task configurations
    - development.yml
    - staging.yml
    - production.yml

Setup genova

# Please specify GitHub repository account in github.account.
$ cp config/settings.yml config/settings.local.yml
$ cp .env.default .env

$ docker-compose build
$ docker-compose up

You can access web console by launching http://localhost:3000/.

CLI Deploy

Service deploy

# help
$ docker-compose run --rm rails thor genova:deploy help service

# command
$ docker-compose run --rm rails thor genova:deploy service -r {repository} -c {cluster} -s {service}

# e.g.
$ docker-compose run --rm rails thor genova:deploy service -r api -c production-app -s backend

More usage and documentation

Please refer to Wiki.