ploy

Ploy

Ploy is a simple terminal-based deployment tool. It lets you define services in a configuration file together with the desired versions of these services. It can verify if the desired versions are deployed and, if not, it can deploy the right versions.

It can currently verify and deploy services of the following types:

• AWS Lambda - with the code packaged as a Docker image and published to ECR
• AWS ECS

Installation

Install the tool with go

go install github.com/DandyDev/ploy

Usage

First, you have to create one or more Ploy configuration files. A Ploy configuration file contains a list of services and their desired versions. It's written in YAML.

Example:

deployments:
  - id: my-lambda # in case of Lambda, this is the function name
    type: lambda
    version: v2
    version-environment-key: VERSION # optional, updates the given environment variable with the version when deploying
    post-deploy-command: ["./my-script.sh", "arg1", "arg2"] # optional, runs the specified command after succesful deployment. The deployed version is availabe as the $VERSION environment variable 
  - id: my-container # in case of ECS, this is the service name
    type: ecs
    cluster: my-cluster
    version: v666
    version-environment-key: VERSION # optional, updates the given environment variable in the container with the version when deploying
    wait-for-service-stability: true # optional, defaults to false
    wait-for-minutes: 5 # optional, how long to wait for service stability, defaults to 30
    force-new-deployment: true # optional, defaults to false

Typically, you'll have one configuration file for each environment (e.g. dev, prod, staging).

After defining the configuration files, you can use the ploy command to verify or deploy the services.

ploy verify development.yml
ploy deploy development.yml

Ploy will only deploy new versions of services if the desired version is different from the currently deployed version.

Engines

There are currently two supported deployment engines:

• AWS Lambda (type: lambda) - with the code packaged as a Docker image. Version is the image tag.
• AWS ECS (type: ecs) - with the code packaged as a Docker image. Version is the image tag.

Contributing

Fork the repo, make your changes, and submit a pull request.

TODO

• Better error handling
• Add support for deploying new ECS task definitions for one-off tasks that are not part of a service
• Add support for other deployment engines. See github.com/DandyDev/ploy/engine for examples of how engines are implemented
• Create command that serves a simple dashboard the visualizes the services that are deployed and their versions. Should do periodic checks in the background to verify versions
• Create a Homebrew tap + formula for Ploy

Authors

• @DandyDev