Skip to content

Latest commit

 

History

History
156 lines (102 loc) · 4.09 KB

README.md

File metadata and controls

156 lines (102 loc) · 4.09 KB
Raw

Overview

Containerized development environment with optional Duo two-factor authentication that consists of two containers per user:

  • App: stateless, upgradable, ephemeral applications
  • State: persistent user data

Source: https://github.com/jumanjihouse/devenv

Docker Hub:

How-to

Background

For authentication, we assume two things:

  • Duo configuration variables are properly set in global.conf, probably controlled by an organization's administrator(s) with proper config management.

  • The user controls their own SSH authorized public keys on Github. The app container fetches these public keys at each login attempt.

The instructions below rely on systemd instantiated units to create per-user development environments.

  • /etc/systemd/system/devenv\@.service is the systemd unit file.

  • /etc/devenv/global.conf is a set of default configuration parameters.

  • /etc/devenv/<user>.conf provides per-user parameters, such as the user's SSH port, Github handle, and Duo username.

  • /etc/devenv/login_duo.conf is a template that gets copied into the per-user app container and adapted for each user based on both global.conf and <user>.conf.

⚠️ If you do not use Duo for two-factor authentication, set DUO=false in /etc/devenv/global.conf.

Quick-start

  1. Spin up a systemd-based host, such as a CoreOS VM on Digital Ocean, then login to the new host.

  2. Clone this repo to the new host:

    git clone https://github.com/jumanjihouse/devenv.git
cd devenv/

  3. Copy the startup configs to the new host:

    sudo cp -r host-configs/* /

  4. Edit /etc/devenv/global.conf to specify options that should apply by default to every devenv instance.

  5. Copy /etc/devenv/user.conf to a per-user config and edit:

    sudo cp /etc/devenv/user.conf /etc/devenv/yourname.conf
sudo vi /etc/devenv/yourname.conf

    The name of the per-user config file only matters for systemd. The name of the file is ignored.

  6. Start the per-user instance:

    sudo systemctl daemon-reload
sudo systemctl start devenv@yourname

journalctl -fu devenv@yourname

Upgrade the app image

  1. Edit the global config to specify a recent docker tag:

    sudo vi /etc/devenv/global.conf

  2. Restart your devenv instance:

    sudo systemctl restart devenv@yourname
journalctl -fu devenv@yourname

Administrivia

Build integrity

An unattended test harness builds the images on CircleCI and runs tests with BATS.
If all tests pass on master branch, push the built images to Docker Hub.

workflow

Docker tags for app image:

  • optimistic: latest
  • pessimistic: ${build_date}-git-${hash}

Docker tags for state image:

  • pessimistic: ${hash-of-state/Dockerfile}

SSH Configuration Checks

Tools to check ssh configuration:

License

GPLv2. See LICENSE in this repo.