Skip to content

Latest commit

 

History

History
103 lines (73 loc) · 3.9 KB

README.md

File metadata and controls

103 lines (73 loc) · 3.9 KB
Raw

droot Latest Version Travis Build Status Go Report Card License

Droot is A simple chroot-based application container engine to build, ship, run with chroot instead of docker run. Droot aims to simply escape dependency hell.

Overview

Docker has a powerful concept about an application deployment process, that is Build, Ship, Run. But there are many cases that docker runtime is too complicated and beyond our current capabilities, especially on production. Then Droot provides a simpler container runtime without complicated stacks including linux namespaces and union filesystems like AUFS. It depends on simple Linux functions such as chroot(2), Linux capabilities(7) and a bind mount, and helps you to chroot a container image built by docker and to import/export container images on Amazon S3.

  • Build: Build archives by docker build and docker export
  • Ship: Upload the archives to a storage (like Amazon S3), and Download archives from it.
  • Run: chroot(2), Linux capabilities(7), and a bind mount.

droot architecture

Requirements

  • Docker (droot export only depends on it)
  • Linux (droot run and droot umount only supports it)

Installation

Homebrew

$ brew tap yuuki/droot
$ brew install droot

Download binary from GitHub Releases

Releases・yuuki/droot - GitHub

Build from source

 $ go get github.com/asmyasnikov/droot/cmd/droot

Usage

$ docker build -t dockerfiles/app
$ droot export dockerfiles/app | gzip -cq | aws s3 cp - s3://drootexamples/app.tar.gz
$ for ID in $(docker ps --format "{{.ID}}"); do droot export -o $(docker inspect $ID --format "{{.Config.Image}}") $ID; done;
$ sudo droot umount --root /var/containers/app # it is safe to umount before run if you use `--bind` option
$ mkdir -p /tmp/app /var/containers/app
$ aws s3 cp s3://drootexamples/app.tar.gz - | tar -xpzf - -C /tmp/app
$ mv -T /tmp/app /var/containers/app
$ sudo droot run --cp --user appuser --group appgroup --bind /var/log/app --root /var/containers/app -- command
$ sudo droot umount --root /var/containers/app

Integration with capze

https://github.com/yuuki/capze

$ aws s3 cp s3://drootexamples/app.tar.gz - | tar xzf - -C /tmp/app
$ capze --keep 5 /tmp/app /var/containers/app

How to set docker endpoint

Droot supports the environment variables same as docker-machine such as DOCKER_HOST, DOCKER_TLS_VERIFY, DOCKER_CERT_PATH. ex.

DOCKER_TLS_VERIFY=1
DOCKER_HOST=tcp://192.168.x.x:2376
DOCKER_CERT_PATH=/home/yuuki/.docker/machine/machines/dev

Presentations (Japanese)

Development

Droot uses a package using cgo, so it is necessary to build in Linux for a Linux binary. It is recommanded to use Docker for development if you are on OSX and other OSs.

build in Docker container

$ ./script/build_in_container.sh make build

Contribution

  1. Fork (https://github.com/asmyasnikov/droot/fork)
  2. Create a feature branch
  3. Commit your changes
  4. Rebase your local changes against the master branch
  5. Run test suite with the make test command and confirm that it passes
  6. Create a new Pull Request

Author

y_uuki