Docker-Compose Deploy

Quickly and easily deploy Docker Compose projects to your CentOS machine with minimal effort.

This project is experimental and may very likely not work as expected. Use at your own risk.

Features

• Automatically prepares your machine, installing Git, Docker and Docker-Compose.

Requirements

• A deploy target server(s) running CentOS 6+

Usage

Reference this repository in a GitHub Actions Workflow file. See below for a working implementation of this.

For example: .github/workflows/cd.yml

runs-on: ubuntu-latest
steps:
  # Step 1: Checkout  
  - uses: actions/checkout@v2
  
  # Step 2: Add SSH credentials to your GitHub CI/CD instance 
  - name: Add SSH Credentials
    uses: shimatoro/ssh-key-action@v2
    with:
      key: ${{ secrets.SSH_PRIVATE_KEY }} # required, this will be used when transferring files to your deploy targets
      known_hosts: ${{ secrets.SSH_KNOWN_HOSTS }} # required, should match up with your deploy targets (see below)
    
  # Step 3: Deploy!
  - name: Deploy to Staging
    uses: JorgenVatle/docker-compose-deploy@v1.0
    with:
      deploy_targets: 'server-1.example.com, server-2.example.com' # required, comma separated list of servers to deploy to.

      ssh_user: 'root' # optional, user to connect to deploy targets with. Defaults to 'root'
      compose_file: 'docker-compose.yml' # optional, path/filename of your docker-compose file. Defaults to 'docker-compose.yml'
      validate_container: 'app' # optional, validate that the given container name is running. Otherwise, throw an error. Defaults to 'app' 

Make sure that your SSH_PRIVATE_KEY can be used on your deploy targets by appending it's associated public key to the targets' ~/.ssh/authorized_keys file. If you start seeing permission issues, your private key is most likely not authorized for use on the target server.

What happens in the background?

1. We synchronize your entire repository to your destination servers. Path: /opt/live/{your-repository-name}
2. After your repository has been synchronized, we build, start and detach from your repository's Docker containers. docker-compose -f docker-compose.yml up --build -d
3. We validate that the container specified in validate_container is running. If it's not running, we'll cancel the deploy process and throw an error.

How do I ...?

Get my known_hosts?

Run ssh keyscan {deploy target hostname} >> known_hosts. This will create a known_hosts file in your current directory containing your server's host ID. Do this for each of your deploy targets and store in your GitHub repository's secrets.

Heads up!

It is very important that you limit the events that can trigger your workflow. You probably don't want new experimental branches being deployed to production. 😅

Appending the following bit to your workflow file should keep you from shooting yourself in the foot.

on:
  push:
    branches:
      - master

The on documentation is worth a read if you're planning on deploying to production and staging servers.

License

This repository is licensed under the ISC license.

Copyright (c) 2020, Jørgen Vatle.