vidar

vidar is a set of docker & k8s deployment tools based on thor gem

Installation

Add this line to your application's Gemfile:

gem 'vidar'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vidar

Requirements :

• multistage Dockerfile, with at least 2 stages defined: base, release.
• docker-compose.ci.yml file with defined services for all mentioned stages, e.g.

version: '3.7'

services:
  base:
    image: [docker-registry-url]:base-${CURRENT_BRANCH:?err}
    build:
      dockerfile: Dockerfile
      context: .
      target: base
    env_file:
      - .env
    environment:
      - RACK_ENV=test

  release:
    image: [docker-registry-url]:release
    build:
      dockerfile: Dockerfile
      context: .
      target: release
      args:
        - REVISION=${REVISION:?err}

• vidar.yml file to the project root directory, which following content:

# docker image name, required
image: [docker-registry-url]
# k8s namespace, required
namespace: borrower
# github name used to build deployment notification content
github: RenoFi/vidar
# The key to use for creating honeycomb markers, defaults to HONEYCOMB_API_KEY env var
honeycomb_api_key: secret
# deployments config per kubectl context, required for `monitor_deploy_status` command
deployments:
  gke_project_us-east4_staging:
    # Deployment Name
    name: staging cluster
    # Color of successful notification, default value: 008800
    success_color: "00ff00"
    # Color of failed notification, default value: ff1100
    failure_color: "ff0000"
    # Deployment url, e.g. url to gke cluster workloads filtered by namespace
    # Similar to all other values it may contain references to others using mustache-like interpolation.
    url: "https://console.cloud.google.com/kubernetes/workload?project=project&namespace={{namespace}}"
    # Sentry webhook url used to send deploy notifications
    # (make sure you use the exact url with trailing slash provided by sentry), optional
    sentry_webhook_url: https://sentry.io/api/hooks/release/builtin/123/asdf/
    # Slack webhook url used to send deploy notifications, optional
    slack_webhook_url: https://hooks.slack.com/services/ASCKNZ0vug2R3Ydo/ASCKNZ0vug2R3Ydo/ASCKNZ0vug2R3Ydo
    # Name of the Honeycomb dataset to create a deployment marker in
    honeycomb_dataset: staging
    # https_proxy address used to connect private k8s control plane endpoint
    https_proxy: localhost:8888
# docker-compose file, optional, default value: docker-compose.ci.yml
compose_file: docker-compose.ci.yml
# default_branch, optional, default value: main or master (auto-detected from local branches)
default_branch: dev
# console_command, optional, default value: bin/console
console_command: rake console

Usage

Available commands are:

vidar pull - pulls existing docker images from repository to levarage docker caching and make build faster

vidar build - builds docker images

vidar cache - caches intermediate stages

vidar publish - publishes docker images

vidar release - a set of pull, build, cache and publish

vidar deploy - deploys/applies release image with REVISION tag in given k8s namespace and cluster (unser the hood it's kubectl set image command). Before calling the command you must have kubectl context set. If you use GCP/GKE simply call gcloud container clusters get-credentials you-cluser-name --zone=us-east4. If you have deploy-hook-template job defined, it creates deploy-hook job with given REVISION.

vidar monitor_deploy_status - monitors if all containers are up and running, if slack_webhook_url if defined, sends a noficiation (on both failure and success).

vidar kube_exec --name=web --command='bin/console' - execute given command (/bin/ssh by default) inside the first pod with given name (all pods by default).

vidar console --name=web - execute console command (bin/console by default) inside the first pod with given name (all pods by default).

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/RenoFi/vidar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.