From e97b7ddbda8d1bbaf2a9732475b94fd0ab916adb Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 14:27:23 -0200 Subject: [PATCH 01/28] Bump up to 1.0.0 --- mk-image | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mk-image b/mk-image index b820990..ec84892 100755 --- a/mk-image +++ b/mk-image @@ -2,7 +2,7 @@ set -e -tag='v0.4.0' +tag='v1.0.0' echo "===> Building fgrehm/devstep:${tag}" docker build -t fgrehm/devstep:${tag} . From 4028b0845371000eceac28d9aa1b1168e23016b9 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 14:30:31 -0200 Subject: [PATCH 02/28] Remove noisy comments --- Dockerfile | 21 ++------------------- 1 file changed, 2 insertions(+), 19 deletions(-) diff --git a/Dockerfile b/Dockerfile index 2004661..cf2951c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -9,33 +9,16 @@ ENV HOME=/home/devstep \ LC_ALL=en_US.UTF-8 \ LC_CTYPE=en_US.UTF-8 -##################################################################### -# Copy over our build scripts ADD image/ /tmp/build - -##################################################################### -# Install required packages and do some additional setup RUN /tmp/build/prepare.sh -##################################################################### -# Devstep goodies (ADDed at the end to increase image "cacheability") ADD stack $DEVSTEP_PATH -RUN for script in $DEVSTEP_PATH/buildpacks/*/bin/install-dependencies; do \ - $script; \ - done - -##################################################################### -# Fix permissions and set up init -RUN /tmp/build/fix-permissions.sh +RUN for script in $DEVSTEP_PATH/buildpacks/*/bin/install-dependencies; do $script; done \ + && /tmp/build/fix-permissions.sh -##################################################################### -# Setup default user USER developer ENV USER developer -##################################################################### -# Use our init ENTRYPOINT ["/opt/devstep/bin/entrypoint"] -# Start a bash session by default CMD ["/bin/bash"] From 63ebf2027bbb04fc4f4625fa4d82109887ab1ef7 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 14:31:18 -0200 Subject: [PATCH 03/28] Happy new year :fireworks: --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index a4c9bc4..006a992 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2014 Fabio Rehm +Copyright (c) 2014-2016 Fabio Rehm Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in From 7e73d22715b1b14cdb8db96b335279ed0c6a0b09 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 14:32:00 -0200 Subject: [PATCH 04/28] I havent used devstep to work on this project for a while now --- devstep.yml | 11 ----------- 1 file changed, 11 deletions(-) delete mode 100644 devstep.yml diff --git a/devstep.yml b/devstep.yml deleted file mode 100644 index 42eea87..0000000 --- a/devstep.yml +++ /dev/null @@ -1,11 +0,0 @@ -privileged: true -volumes: - # FIXME: This only work on my machine - - '{{env "HOME"}}/devstep/development/docker:/var/lib/docker' - - '{{env "HOME"}}/projects/oss/devstep-examples:/devstep-examples' - - '{{env "HOME"}}/projects/oss/devstep-cli/build/linux_amd64:/home/devstep/bin/devstep' -commands: - make: - # No custom options -provision: - - ['configure-addons', 'docker'] From 2adeaa4544cb8d281b70ec644f14a7754c7951aa Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 14:41:39 -0200 Subject: [PATCH 05/28] Remove postgresql / mysql clients and tmux --- CHANGELOG.md | 6 ++++++ image/prepare.sh | 7 ------- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d2339e..26c1c04 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [1.0.0](https://github.com/fgrehm/devstep/compare/v0.4.0...next) (unreleased) + +BREAKING CHANGES: + - baseimage: Removed PostgreSQL and MySQL clients + - baseimage: Removed tmux + ## [0.4.0](https://github.com/fgrehm/devstep/compare/v0.3.1...v0.4.0) (2015-07-06) BREAKING CHANGES: diff --git a/image/prepare.sh b/image/prepare.sh index 44ae294..8cb1e20 100755 --- a/image/prepare.sh +++ b/image/prepare.sh @@ -2,14 +2,10 @@ set -e - ##################################################################### -# * Install and configure PostgreSQL and MySQL clients # * Install bash-completion to save us a few keystrokes # * Install vim because editing files with plain old vi sucks # * Install `htop` because it has a nicer UI than plain old `top` -# * Install tmux so that we can run lots of shells within the same -# bash session (without the need of running through SSH) # * Install nodejs for Rails apps, Bazaar and Mecurial for Golang projects # (will be installed on demand by buildpacks on a future release) # * Python and runit are dependencies for our init script based on @@ -20,13 +16,10 @@ apt-get install -y --force-yes --no-install-recommends \ libreadline5 \ libmcrypt4 \ libffi-dev \ - postgresql-client \ - mysql-client \ sqlite3 \ libsqlite3-dev \ vim \ htop \ - tmux \ mercurial \ bzr \ nodejs-legacy \ From 9672fabb5480ff7d06063a90bafe49d5f6965906 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 14:43:31 -0200 Subject: [PATCH 06/28] buildpacks/ruby: Set default to 2.3.0 and bundler to 1.11.2 --- docs/buildpacks/ruby.md | 4 ++-- stack/buildpacks/ruby/bin/compile | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/buildpacks/ruby.md b/docs/buildpacks/ruby.md index 7e02ec2..8a5e5e3 100644 --- a/docs/buildpacks/ruby.md +++ b/docs/buildpacks/ruby.md @@ -6,8 +6,8 @@ use [Bundler](http://bundler.io/) for dependency management. It will be used if a `Gemfile` is found. The installed Ruby will be the same one that gets installed on Heroku's Cedar 14 -stack with a fallback to a Ruby from the Cedar stack. By default Ruby 2.2.2 and -Bundler 1.10.5 will be installed. +stack with a fallback to a Ruby from the Cedar stack. By default Ruby 2.3.0 and +Bundler 1.11.2 will be installed. To specify a Ruby version, use the [`ruby` directive](http://bundler.io/v1.6/gemfile_ruby.html) of your project's `Gemfile`, the `DEVSTEP_RUBY_VERSION` environmental variable or diff --git a/stack/buildpacks/ruby/bin/compile b/stack/buildpacks/ruby/bin/compile index 1f36486..b501e62 100755 --- a/stack/buildpacks/ruby/bin/compile +++ b/stack/buildpacks/ruby/bin/compile @@ -84,7 +84,7 @@ install_phantomjs() { DEVSTEP_RUBY_VERSION=${DEVSTEP_RUBY_VERSION:-$(version_from_ruby_version)} DEVSTEP_RUBY_VERSION=${DEVSTEP_RUBY_VERSION:-$(version_from_gemfile)} if [ -z "$DEVSTEP_RUBY_VERSION" ]; then - DEVSTEP_RUBY_VERSION='2.2.2' + DEVSTEP_RUBY_VERSION='2.3.0' echo "Unable to identify the project ruby version, setting to ${DEVSTEP_RUBY_VERSION}" fi @@ -118,7 +118,7 @@ fi source ${HOME}/.profile.d/ruby.sh -DEVSTEP_BUNDLER_VERSION=${DEVSTEP_BUNDLER_VERSION:-'1.10.5'} +DEVSTEP_BUNDLER_VERSION=${DEVSTEP_BUNDLER_VERSION:-'1.11.2'} if ! $(which bundle &> /dev/null); then tarball_path=$2/rubies/bundler-${DEVSTEP_BUNDLER_VERSION}.gem From 0ccae9126a77b78f68f6509a8767b6dc318e33b8 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 14:46:20 -0200 Subject: [PATCH 07/28] buildpacks: Remove `bats` support --- CHANGELOG.md | 1 + docs/buildpacks/bats.md | 5 ----- docs/introduction.md | 1 - docs/template.html | 1 - stack/buildpacks/bats/bin/compile | 19 ------------------- stack/buildpacks/bats/bin/detect | 11 ----------- 6 files changed, 1 insertion(+), 37 deletions(-) delete mode 100644 docs/buildpacks/bats.md delete mode 100755 stack/buildpacks/bats/bin/compile delete mode 100755 stack/buildpacks/bats/bin/detect diff --git a/CHANGELOG.md b/CHANGELOG.md index 26c1c04..2fbc406 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ BREAKING CHANGES: - baseimage: Removed PostgreSQL and MySQL clients - baseimage: Removed tmux + - buildpacks: Removed `bats` ## [0.4.0](https://github.com/fgrehm/devstep/compare/v0.3.1...v0.4.0) (2015-07-06) diff --git a/docs/buildpacks/bats.md b/docs/buildpacks/bats.md deleted file mode 100644 index 0defe90..0000000 --- a/docs/buildpacks/bats.md +++ /dev/null @@ -1,5 +0,0 @@ -# Bats buildpack ----------------- - -This buildpack will install the latest release of [Bats](https://github.com/sstephenson/bats) -if a file with the `.bats` extension is found. diff --git a/docs/introduction.md b/docs/introduction.md index 5b1359f..2c41b38 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -64,7 +64,6 @@ _For more information please have a look at the [Dockerfile](https://github.com/ ## Supported buildpacks -* [Bats](buildpacks/bats) * [Golang](buildpacks/golang) * [Inline](buildpacks/inline) * [Node.js](buildpacks/nodejs) diff --git a/docs/template.html b/docs/template.html index 833aa71..071afef 100644 --- a/docs/template.html +++ b/docs/template.html @@ -118,7 +118,6 @@
  • Buildpacks
      -
    • Bats
    • Golang
    • Inline
    • Node.js
      • diff --git a/stack/buildpacks/bats/bin/compile b/stack/buildpacks/bats/bin/compile deleted file mode 100755 index 51342e6..0000000 --- a/stack/buildpacks/bats/bin/compile +++ /dev/null @@ -1,19 +0,0 @@ -#!/usr/bin/env bash -# usage: bin/compile - -set -eo pipefail - -cache=$2/bats -mkdir -p $cache - -if $(which bats &>/dev/null); then - echo '-----> Bats already installed, skipping' -else - echo '-----> Downloading bats from GitHub...' - if ! [ -f $cache/bats.tar.gz ]; then - curl -sL --insecure http://github.com/sstephenson/bats/tarball/master > $cache/bats.tar.gz - fi - mkdir -p ${HOME}/bats - tar xfz $cache/bats.tar.gz -C ${HOME}/bats --strip-components=1 - (cd ${HOME}/bats && sudo ./install.sh ${HOME}) -fi diff --git a/stack/buildpacks/bats/bin/detect b/stack/buildpacks/bats/bin/detect deleted file mode 100755 index 4e014bf..0000000 --- a/stack/buildpacks/bats/bin/detect +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env bash -# usage: bin/detect - -set -eo pipefail - -if test -n "$(find "$1" -type f -name '*.bats' | sed 1q)"; then - echo Bats -else - echo no - exit 1 -fi From 66502cc69a35af11feb64d12a0c1b2bc793336a2 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 14:47:08 -0200 Subject: [PATCH 08/28] buildpacks: Remove `phantomjs` --- CHANGELOG.md | 2 +- docs/buildpacks/phantomjs.md | 12 ---------- docs/template.html | 1 - stack/buildpacks/phantomjs/bin/compile | 31 -------------------------- stack/buildpacks/phantomjs/bin/detect | 5 ----- 5 files changed, 1 insertion(+), 50 deletions(-) delete mode 100644 docs/buildpacks/phantomjs.md delete mode 100755 stack/buildpacks/phantomjs/bin/compile delete mode 100755 stack/buildpacks/phantomjs/bin/detect diff --git a/CHANGELOG.md b/CHANGELOG.md index 2fbc406..ab7ac56 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ BREAKING CHANGES: - baseimage: Removed PostgreSQL and MySQL clients - baseimage: Removed tmux - - buildpacks: Removed `bats` + - buildpacks: Removed `bats` and `phantomjs` ## [0.4.0](https://github.com/fgrehm/devstep/compare/v0.3.1...v0.4.0) (2015-07-06) diff --git a/docs/buildpacks/phantomjs.md b/docs/buildpacks/phantomjs.md deleted file mode 100644 index 05a30a9..0000000 --- a/docs/buildpacks/phantomjs.md +++ /dev/null @@ -1,12 +0,0 @@ -# PhantomJS buildpack ---------------------- - -This buildpack will install the latest release of [PhantomJS](http://phantomjs.org) -and currently does provide automatic detection. - -In order to use it, you'll need to manually invoke it with `build-project -b phantomjs` -from within your image or from a `Dockerfile`. - -By default it will install the 1.9.7 version but a specific version can be installed -by specifying the `PHANTOMJS_VERSION` env var during the build. For example: -`PHANTOMJS_VERSION='1.9.6' build-project -b phantomjs` will install PhantomJS 1.9.6. diff --git a/docs/template.html b/docs/template.html index 071afef..4ac6d1a 100644 --- a/docs/template.html +++ b/docs/template.html @@ -121,7 +121,6 @@
    • Golang
    • Inline
    • Node.js
      • -
    • PhantomJS
    • Python
    • Ruby
    • Custom
      • diff --git a/stack/buildpacks/phantomjs/bin/compile b/stack/buildpacks/phantomjs/bin/compile deleted file mode 100755 index a411969..0000000 --- a/stack/buildpacks/phantomjs/bin/compile +++ /dev/null @@ -1,31 +0,0 @@ -#!/bin/bash - -set -e - -# BUILD_DIR=$1 -CACHE_DIR=$2/phantomjs - -# config -PHANTOMJS_VERSION=${PHANTOMJS_VERSION:-"1.9.7"} - -# Buildpack URL -ARCHIVE_NAME=phantomjs-${PHANTOMJS_VERSION}-linux-x86_64 -FILE_NAME=${ARCHIVE_NAME}.tar.bz2 -BUILDPACK_PHANTOMJS_PACKAGE=https://bitbucket.org/ariya/phantomjs/downloads/${FILE_NAME} - -if [ -x ${HOME}/bin/phantomjs ]; then - echo "-----> PhantomJS already installed" - exit 0 -fi - -mkdir -p $CACHE_DIR -if ! [ -e $CACHE_DIR/$FILE_NAME ]; then - echo "-----> Fetching PhantomJS ${PHANTOMJS_VERSION} binaries at ${BUILDPACK_PHANTOMJS_PACKAGE}" - curl $BUILDPACK_PHANTOMJS_PACKAGE -L -s > $CACHE_DIR/$FILE_NAME -fi - -echo "-----> Extracting PhantomJS ${PHANTOMJS_VERSION} binaries to ${HOME}/phantomjs" -mkdir -p $CACHE_DIR/$ARCHIVE_NAME -tar jxf $CACHE_DIR/$FILE_NAME -C $CACHE_DIR -mv $CACHE_DIR/$ARCHIVE_NAME ${HOME}/phantomjs -ln -s ${HOME}/phantomjs/bin/phantomjs ${HOME}/bin/phantomjs diff --git a/stack/buildpacks/phantomjs/bin/detect b/stack/buildpacks/phantomjs/bin/detect deleted file mode 100755 index c5999e1..0000000 --- a/stack/buildpacks/phantomjs/bin/detect +++ /dev/null @@ -1,5 +0,0 @@ -#!/usr/bin/env bash -# usage: bin/detect - -# For now this buildpack needs to be manually installed -exit 1 From 5d6d70c3bda19b1905893371097f5ac568f87214 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 19:46:56 -0200 Subject: [PATCH 09/28] buildpacks/ruby: Grab bundler version from `Gemfile.lock` Closes GH-100 --- stack/buildpacks/ruby/bin/compile | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/stack/buildpacks/ruby/bin/compile b/stack/buildpacks/ruby/bin/compile index b501e62..47b258c 100755 --- a/stack/buildpacks/ruby/bin/compile +++ b/stack/buildpacks/ruby/bin/compile @@ -3,11 +3,12 @@ set -e GEMFILE_PATH=$1/Gemfile +GEMFILE_LOCK_PATH=$1/Gemfile.lock RUBY_VERSION_PATH=$1/.ruby-version # From https://github.com/aripollak/rbenv-bundler-ruby-version/blob/32bd1a63ed57c6fcfbd4f3766fed64fad21b61b0/bin/rbenv-bundler-ruby-version#L24-L33 version_from_gemfile() { - if [ -f ${GEMFILE_PATH} ]; then + if [ -f ${GEMFILE_PATH} ]; then # handles simple ruby statements, as well as engine and engine_version, # with single or double quotes and in either order grep '^\s*ruby' "$GEMFILE_PATH" | sed -e 's/\s*#.*//' -e 's/engine:/:engine =>/' \ @@ -24,6 +25,12 @@ version_from_ruby_version() { fi } +bundler_version_from_gemfile_lock() { + if [ -f ${GEMFILE_LOCK_PATH} ]; then + grep -Pzo "BUNDLED WITH\s+([0-9.])+" $GEMFILE_LOCK_PATH | tail -n 1 | tr -d '[[:space:]]' + fi +} + download_ruby() { cache=$1 stack=$2 @@ -118,6 +125,7 @@ fi source ${HOME}/.profile.d/ruby.sh +DEVSTEP_BUNDLER_VERSION=${DEVSTEP_BUNDLER_VERSION:-$(bundler_version_from_gemfile_lock)} DEVSTEP_BUNDLER_VERSION=${DEVSTEP_BUNDLER_VERSION:-'1.11.2'} if ! $(which bundle &> /dev/null); then From 96e562344bcb2a81e0798db514c4f1322ff9d913 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 19:50:56 -0200 Subject: [PATCH 10/28] buildpacks/inline: Simpler command invocation Fixes GH-97 --- stack/buildpacks/inline/bin/provision | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stack/buildpacks/inline/bin/provision b/stack/buildpacks/inline/bin/provision index e32d661..90c5c6e 100755 --- a/stack/buildpacks/inline/bin/provision +++ b/stack/buildpacks/inline/bin/provision @@ -5,7 +5,7 @@ require 'yaml' commands = YAML.load(File.read(ARGV[0]))['provision'] commands.each do |cmd| - if !(system *cmd) + if !system(cmd.join(' ')) exit $?.to_i end end From 01099503ea1476a0db483bad12e453135f6d8fbd Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 19:58:16 -0200 Subject: [PATCH 11/28] buildpacks/inline: Deal with provision exit codes properly Closes GH-99 --- stack/buildpacks/inline/bin/compile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stack/buildpacks/inline/bin/compile b/stack/buildpacks/inline/bin/compile index 5b16f58..fb6c173 100755 --- a/stack/buildpacks/inline/bin/compile +++ b/stack/buildpacks/inline/bin/compile @@ -7,7 +7,7 @@ if [ -f $1/devstep.yml ]; then provision_steps=$(ruby -ryaml -e "puts (YAML.load(File.read('$1/devstep.yml'))['provision'] || []).size") if [[ $provision_steps -gt 0 ]]; then bp_bin="$( cd -P "$( dirname "$0" )" && pwd )" - ${bp_bin}/provision "${1}/devstep.yml" + exec ${bp_bin}/provision "${1}/devstep.yml" elif [ -x $1/bin/compile ]; then exec "$1"/bin/compile "$@" fi From 5a15b2766ac6ef26b00be1c9c3b3d5546f7b9cce Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 19:58:30 -0200 Subject: [PATCH 12/28] Update CHANGELOG --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ab7ac56..190130d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,14 @@ BREAKING CHANGES: - baseimage: Removed tmux - buildpacks: Removed `bats` and `phantomjs` +BUG FIXES: + + - buildpacks/inline: Improve `devstep.yml` `provision` config handling [[GH-97]] + - buildpacks/inline: Return the same exit code returned by the `provision` command [[GH-99]] + +[GH-97]: https://github.com/fgrehm/devstep/issues/97 +[GH-99]: https://github.com/fgrehm/devstep/issues/99 + ## [0.4.0](https://github.com/fgrehm/devstep/compare/v0.3.1...v0.4.0) (2015-07-06) BREAKING CHANGES: From 630ba705cbe436805a603e2f2f1719223065ac85 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 20:37:41 -0200 Subject: [PATCH 13/28] buildpacks/inline: Allow `provision` config to be set with strings --- CHANGELOG.md | 4 ++++ stack/buildpacks/inline/bin/provision | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 190130d..8973919 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ BREAKING CHANGES: - baseimage: Removed tmux - buildpacks: Removed `bats` and `phantomjs` +IMPROVEMENTS: + + - buildpacks/inline: Support strings for the `provision` config on `devstep.yml` files + BUG FIXES: - buildpacks/inline: Improve `devstep.yml` `provision` config handling [[GH-97]] diff --git a/stack/buildpacks/inline/bin/provision b/stack/buildpacks/inline/bin/provision index 90c5c6e..a89677b 100755 --- a/stack/buildpacks/inline/bin/provision +++ b/stack/buildpacks/inline/bin/provision @@ -4,8 +4,8 @@ require 'yaml' commands = YAML.load(File.read(ARGV[0]))['provision'] -commands.each do |cmd| - if !system(cmd.join(' ')) +Array(commands).each do |cmd| + if !system(Array(cmd).join(' ')) exit $?.to_i end end From 8ad1d61ef0426dd715d00e7c4fbe3332d14af6b3 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 20:38:34 -0200 Subject: [PATCH 14/28] buildpacks/golang: Bump default to 1.5.2 --- CHANGELOG.md | 1 + stack/buildpacks/golang/bin/compile | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8973919..782e56d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ BREAKING CHANGES: IMPROVEMENTS: + - buildpacks/golang: Bump default Go to 1.5.2 - buildpacks/inline: Support strings for the `provision` config on `devstep.yml` files BUG FIXES: diff --git a/stack/buildpacks/golang/bin/compile b/stack/buildpacks/golang/bin/compile index 8344f81..4026b28 100755 --- a/stack/buildpacks/golang/bin/compile +++ b/stack/buildpacks/golang/bin/compile @@ -80,7 +80,7 @@ then name=$(git config --get-regexp '^remote.+\.url' | grep github | head -n1 | cut -f2 -d' ' | sed 's/^\(git\|https\):\/\///' | sed 's/^\w\+@//' | sed 's/:/\//' | sed 's/\.git$//') popd &> /dev/null fi -ver=${ver:-go${GOVERSION:-1.4.2}} +ver=${ver:-go${GOVERSION:-1.5.2}} file=${GOFILE:-$ver.$(uname|tr A-Z a-z)-amd64$(platext $ver).tar.gz} url=${GOURL:-$(urlfor $ver $file)} @@ -123,9 +123,9 @@ GOROOT=${HOME}/go export GOROOT # GOPATH=$build/.heroku/go export GOPATH GOPATH=${HOME}/gocode export GOPATH # PATH=$GOROOT/bin:$PATH +GOBIN=$GOPATH/bin export GOBIN PATH=$GOBIN:$GOROOT/bin:$PATH export PATH -GOBIN=$GOPATH/bin export GOBIN # if ! (test -d $build/Godeps || (which hg >/dev/null && which bzr >/dev/null)) # then From eea92f717c1e579975a317db61d9add32e144668 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 20:48:03 -0200 Subject: [PATCH 15/28] buildpacks/golang: Nicely handle blanky `git remote`s Fixes GH-94 --- CHANGELOG.md | 2 ++ stack/buildpacks/golang/bin/compile | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 782e56d..d5f7a23 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,9 +12,11 @@ IMPROVEMENTS: BUG FIXES: + - buildpacks/golang: Nicely handle blanky `git remote`s [[GH-94]] - buildpacks/inline: Improve `devstep.yml` `provision` config handling [[GH-97]] - buildpacks/inline: Return the same exit code returned by the `provision` command [[GH-99]] +[GH-94]: https://github.com/fgrehm/devstep/issues/94 [GH-97]: https://github.com/fgrehm/devstep/issues/97 [GH-99]: https://github.com/fgrehm/devstep/issues/99 diff --git a/stack/buildpacks/golang/bin/compile b/stack/buildpacks/golang/bin/compile index 4026b28..cdcf207 100755 --- a/stack/buildpacks/golang/bin/compile +++ b/stack/buildpacks/golang/bin/compile @@ -77,7 +77,7 @@ elif test -d $build/.git then pushd $build &> /dev/null # REFACTOR: I'm pretty sure this can be cleaned up - name=$(git config --get-regexp '^remote.+\.url' | grep github | head -n1 | cut -f2 -d' ' | sed 's/^\(git\|https\):\/\///' | sed 's/^\w\+@//' | sed 's/:/\//' | sed 's/\.git$//') + name=$(git config --get-regexp '^remote.+\.url' | grep github | head -n1 | cut -f2 -d' ' | sed 's/^\(git\|https\):\/\///' | sed 's/^\w\+@//' | sed 's/:/\//' | sed 's/\.git$//' || echo -n '') popd &> /dev/null fi ver=${ver:-go${GOVERSION:-1.5.2}} From 903238bed15a06635ee5c871121d2c1cee6f6d8b Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 20:57:47 -0200 Subject: [PATCH 16/28] buildpacks/python: Update default to 2.7.11 --- CHANGELOG.md | 1 + docs/buildpacks/python.md | 2 +- stack/buildpacks/python/bin/compile | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d5f7a23..b73e627 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ IMPROVEMENTS: - buildpacks/golang: Bump default Go to 1.5.2 - buildpacks/inline: Support strings for the `provision` config on `devstep.yml` files + - buildpacks/python: Bump default Python to 2.7.11 BUG FIXES: diff --git a/docs/buildpacks/python.md b/docs/buildpacks/python.md index 931efd2..a55bb9c 100644 --- a/docs/buildpacks/python.md +++ b/docs/buildpacks/python.md @@ -14,7 +14,7 @@ You can also provide arbitrary releases Python with a `runtime.txt` file. Runtime options include: -- python-2.7.10 (default) +- python-2.7.11 (default) - python-3.4.1 - pypy-1.9 (experimental) diff --git a/stack/buildpacks/python/bin/compile b/stack/buildpacks/python/bin/compile index 1c8d975..4b19fd6 100755 --- a/stack/buildpacks/python/bin/compile +++ b/stack/buildpacks/python/bin/compile @@ -54,7 +54,7 @@ PROFILE_PATH="$HOME/.profile.d/python.sh" # WEBCONCURRENCY_PROFILE_PATH="$BUILD_DIR/.profile.d/python.webconcurrency.sh" WEBCONCURRENCY_PROFILE_PATH="$HOME/.profile.d/python.webconcurrency.sh" -DEFAULT_PYTHON_VERSION="python-2.7.10" +DEFAULT_PYTHON_VERSION="python-2.7.11" # DEFAULT_PYTHON_STACK="cedar" DEFAULT_PYTHON_STACK="cedar-14" # PYTHON_EXE="/app/.heroku/python/bin/python" From 72577602aa2d0508fed7798331974daa7caf65fb Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 21:01:54 -0200 Subject: [PATCH 17/28] Update docs in prep for 1.0.0 --- docs/cli/commands.md | 6 +++--- docs/cli/configuration.md | 2 +- docs/cli/installation.md | 2 +- docs/getting-started.md | 6 +++--- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/cli/commands.md b/docs/cli/commands.md index ad281ef..ca6e844 100644 --- a/docs/cli/commands.md +++ b/docs/cli/commands.md @@ -15,7 +15,7 @@ This is the easiest way to get started with Devstep. By running the command from your project's root, Devstep will: -1. Create a Docker container based on `fgrehm/devstep:v0.4.0` with project +1. Create a Docker container based on `fgrehm/devstep:v1.0.0` with project sources bind mounted at `/workspace`. 2. Detect and install project's dependencies on the new container using the available buildpacks. @@ -44,7 +44,7 @@ devstep hack -p 80:8080 --link postgres:db --link memcached:mc -e DEVSTEP_BUNDLE By running the command from your project's root, Devstep will: -1. Create a Docker container based on `fgrehm/devstep:v0.4.0` with project +1. Create a Docker container based on `fgrehm/devstep:v1.0.0` with project sources bind mounted at `/workspace`. 2. Detect and install project's dependencies on the new container using the available buildpacks. @@ -53,7 +53,7 @@ By running the command from your project's root, Devstep will: The `devstep/` images act like snapshots of your project dependencies and will be used as the source image for subsequent `devstep` commands instead -of the `fgrehm/devstep:v0.4.0` image. +of the `fgrehm/devstep:v1.0.0` image. For example, running a `devstep hack` after building the image will use `devstep/:latest` as the base container for new "hacking sessions" so that you don't have to build diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md index 246ada9..7c92e6d 100644 --- a/docs/cli/configuration.md +++ b/docs/cli/configuration.md @@ -12,7 +12,7 @@ The available options are described below: repository: 'repo/name' # The image used by devstep when building environments from scratch -# DEFAULT: 'fgrehm/devstep:v0.4.0' +# DEFAULT: 'fgrehm/devstep:v1.0.0' source_image: 'source/image:tag' # The host cache dir that gets mounted inside the container at `/home/devstep/cache` diff --git a/docs/cli/installation.md b/docs/cli/installation.md index 27900ae..248fc0d 100644 --- a/docs/cli/installation.md +++ b/docs/cli/installation.md @@ -10,7 +10,7 @@ This one liner can handle it for you assuming that `$HOME/bin` is available on your `PATH`: ```sh -L=$HOME/bin/devstep && curl -sL https://github.com/fgrehm/devstep-cli/releases/download/v0.4.0/linux_amd64 > $L && chmod +x $L +L=$HOME/bin/devstep && curl -sL https://github.com/fgrehm/devstep-cli/releases/download/v1.0.0/linux_amd64 > $L && chmod +x $L ``` Please note that the CLI is currently limited to connecting to a local `/var/run/docker.sock` diff --git a/docs/getting-started.md b/docs/getting-started.md index 81f3854..6d825c8 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,7 +4,7 @@ Devstep comes in two flavors, you can either use the provided CLI or you can build on top of the provided images from `Dockerfile`s. -Regardless of the flavor you choose, it is a good idea to `docker pull fgrehm/devstep:v0.4.0` +Regardless of the flavor you choose, it is a good idea to `docker pull fgrehm/devstep:v1.0.0` before creating your first container / image for a better user experience. Docker will download that image as needed when using `Dockerfile`s but the Devstep CLI won't. @@ -38,7 +38,7 @@ line to your `~/devstep.yml` so that the image is used as a source for your proj To install the CLI, you can run the one liner below and read on for more: ```sh -L=$HOME/bin/devstep && curl -sL https://github.com/fgrehm/devstep-cli/releases/download/v0.4.0/linux_amd64 > $L && chmod +x $L +L=$HOME/bin/devstep && curl -sL https://github.com/fgrehm/devstep-cli/releases/download/v1.0.0/linux_amd64 > $L && chmod +x $L ``` _The snippet above assumes `$HOME/bin` is on your `PATH`, change `$HOME/bin` to @@ -180,7 +180,7 @@ The `fgrehm/devstep` image is the base image used for Devstep environments and requires you to manually trigger the build: ```Dockerfile -FROM fgrehm/devstep:v0.4.0 +FROM fgrehm/devstep:v1.0.0 # Add project to the image and build it ADD . /workspace From 2150873b96019b899352efd0efaf1952e11ea77f Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 6 Jan 2016 21:06:23 -0200 Subject: [PATCH 18/28] buildpacks/golang: Pass in `-t` to `go get` Closes GH-96 --- CHANGELOG.md | 2 ++ stack/buildpacks/golang/bin/compile | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b73e627..9272c77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ BREAKING CHANGES: IMPROVEMENTS: - buildpacks/golang: Bump default Go to 1.5.2 + - buildpacks/golang: Pass in `-t` to `go get` [[GH-96]] - buildpacks/inline: Support strings for the `provision` config on `devstep.yml` files - buildpacks/python: Bump default Python to 2.7.11 @@ -18,6 +19,7 @@ BUG FIXES: - buildpacks/inline: Return the same exit code returned by the `provision` command [[GH-99]] [GH-94]: https://github.com/fgrehm/devstep/issues/94 +[GH-96]: https://github.com/fgrehm/devstep/issues/96 [GH-97]: https://github.com/fgrehm/devstep/issues/97 [GH-99]: https://github.com/fgrehm/devstep/issues/99 diff --git a/stack/buildpacks/golang/bin/compile b/stack/buildpacks/golang/bin/compile index cdcf207..583998d 100755 --- a/stack/buildpacks/golang/bin/compile +++ b/stack/buildpacks/golang/bin/compile @@ -244,7 +244,7 @@ then echo "-----> Running: godep go install ${FLAGS[@]} ./..." godep go install "${FLAGS[@]}" ./... else - FLAGS=(-d -v) + FLAGS=(-d -v -t) echo "-----> Running: go get ${FLAGS[@]} ./..." go get "${FLAGS[@]}" ./... fi From cabf3bb2859856a346c81eca9c8f13dea3b7bdd2 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Fri, 8 Jan 2016 11:54:54 -0200 Subject: [PATCH 19/28] baseimage: Add `developer` to the `docker` group References https://github.com/fgrehm/devstep-cli/issues/39 --- image/prepare.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/image/prepare.sh b/image/prepare.sh index 8cb1e20..bd86aab 100755 --- a/image/prepare.sh +++ b/image/prepare.sh @@ -59,6 +59,7 @@ mkdir -p $DEVSTEP_CONF/init.d # directory bind mounted into the container. echo "developer:x:1000:1000:Developer,,,:/home/devstep:/bin/bash" >> /etc/passwd echo "developer:x:1000:" >> /etc/group +echo "docker:x:999:developer" >> /etc/group echo "developer ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers.d/developer echo -e "[client]\nprotocol=tcp\nuser=root" >> $HOME/.my.cnf echo "export PGHOST=localhost" >> $HOME/.profile.d/postgresql.sh From e10f9bb822c46dd148a09b6e9a203ec3ab0d03bb Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Fri, 8 Jan 2016 17:09:03 -0200 Subject: [PATCH 20/28] docs/cli: Support for aliases / binstubs / custom commands will be gone on 1.0 --- docs/cli/aliases-and-binstubs.md | 29 ----------------------------- docs/cli/configuration.md | 19 ------------------- docs/template.html | 1 - 3 files changed, 49 deletions(-) delete mode 100644 docs/cli/aliases-and-binstubs.md diff --git a/docs/cli/aliases-and-binstubs.md b/docs/cli/aliases-and-binstubs.md deleted file mode 100644 index 1c3dcfa..0000000 --- a/docs/cli/aliases-and-binstubs.md +++ /dev/null @@ -1,29 +0,0 @@ -# CLI Aliases and Binstubs - -The [`commands` configurations set from `devstep.yml` files](configuration) -can be used to enable some powerful aliases in case you need to frequently -run one off commands against a previously build project image. - -For example, you can keep a terminal session with a Rails server running on a -tab and on a separate tab you can keep a `devstep hack` session open for -development tasks so you can easily run tests or execute some `rake` tasks. - -By specifying the following command on your `devstep.yml` you'll be able to -`devstep run server` instead of `devstep run -p 3000:3000 -- bundle exec rails server`: - -```yaml -commands: - server: - cmd: ["bundle", "exec", "rails", "server"] - publish: ["3000:3000"] -``` - -## Using binstubs - -Given the configuration above, you might also want to skip the `devstep run` -part from `devstep run server` while keeping the specified configs like published -ports or volumes specified on `devstep.yml` files. - -By running the `devstep binstubs` command from your project's root, a bash script -will be created under `.devstep/bin` for each specified command, so you are a `export PATH=".devstep/bin:$PATH"` -away from running just `server` using the configs outlined above. diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md index 7c92e6d..1cc3d18 100644 --- a/docs/cli/configuration.md +++ b/docs/cli/configuration.md @@ -43,25 +43,6 @@ volumes: environment: RAILS_ENV: "development" -# Custom command aliases that can be used with `devstep run` to save some -# typing. It is also used for generating project specific binstubs. -# DEFAULT: -commands: - # This can be run with `devstep run server` - server: - cmd: ["rails", "server"] - # Here you can use some of the configs described above - publish: ["3000:3000"] - volumes: - - '{{env "HOME"}}/certs/some-certificate.crt:/home/devstep/some-certificate.crt' - - '{{env "HOME"}}/projects/some-gem-sources:/home/devstep/some-gem-sources' - links: - - 'redis:redis' - environment: - RAILS_ENV: "hacking" - ruby: - # No custom options, used only for generating binstubs - # Custom provisioning steps that can be used when the available buildpacks are not # enough. Use it to configure addons or run additional commands during the build. # DEFAULT: diff --git a/docs/template.html b/docs/template.html index 4ac6d1a..c369549 100644 --- a/docs/template.html +++ b/docs/template.html @@ -110,7 +110,6 @@
    • Installation
    • Commands
    • Configuration Options
      • -
    • Aliases and Binstubs
    • Plugins
    • Tips and tricks
    From 620f5801707550eaab6a9d18b7e7001934e13562 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Fri, 8 Jan 2016 17:27:38 -0200 Subject: [PATCH 21/28] buildpacks/inline: Always run commands at the end of the build process, after all of the other buildpacks have kicked in. --- CHANGELOG.md | 1 + stack/bin/build-project | 11 +++++++++++ 2 files changed, 12 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9272c77..d09c934 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ IMPROVEMENTS: - buildpacks/golang: Bump default Go to 1.5.2 - buildpacks/golang: Pass in `-t` to `go get` [[GH-96]] - buildpacks/inline: Support strings for the `provision` config on `devstep.yml` files + - buildpacks/inline: Always run inline `provision` commands at the end of the build process, after all of the other buildpacks have kicked in. - buildpacks/python: Bump default Python to 2.7.11 BUG FIXES: diff --git a/stack/bin/build-project b/stack/bin/build-project index 5fe13f0..b349e08 100755 --- a/stack/bin/build-project +++ b/stack/bin/build-project @@ -120,11 +120,22 @@ else exit 0 fi +# HACK to "move" inline buildpack to the end of the list (very hacky but works) +inline_path= for bp in "${selected_buildpacks[@]}"; do + if $(echo $bp | grep -q 'inline'); then + inline_path="$bp" + continue + fi echo_title "Building with $bp" $bp/bin/compile "$project_root" "$cache_root" | ensure_indent done +if [[ -n "$inline_path" ]]; then + echo_title "Building with $inline_path" + $inline_path/bin/compile "$project_root" "$cache_root" | ensure_indent +fi + echo_title "Build finished successfully!" ## Let the user know a reload is needed From 583d1b1694c69fae7945c7b547175f2c72a58116 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 9 Mar 2016 21:41:25 -0300 Subject: [PATCH 22/28] stack: Allow workspace dir to be owned by a different user This allows the image to be used with VMs with NFS squashing enabled like dinghy environments (aka we are getting close to being able to run devstep on OSX :muscle:) --- stack/bin/fix-permissions | 5 ----- 1 file changed, 5 deletions(-) diff --git a/stack/bin/fix-permissions b/stack/bin/fix-permissions index 5781306..ca4648c 100755 --- a/stack/bin/fix-permissions +++ b/stack/bin/fix-permissions @@ -15,11 +15,6 @@ elif [ "${uid}" = '0' ]; then echo "-----> Setting '`pwd`' owner to 'developer'" sudo chown -R developer: `pwd` fi - -else - # If the directory has some other uid, there's nothing we can do right now - echo "-----> The workspace directory is owned by a different user!" - exit 1 fi From 832e24ebfc612e7bd21b97a90d5564a29a0e2e99 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 9 Mar 2016 22:13:14 -0300 Subject: [PATCH 23/28] buildpacks/golang: Bump default verstion to 1.6 --- CHANGELOG.md | 2 +- stack/buildpacks/golang/bin/compile | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d09c934..d8ad792 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ BREAKING CHANGES: IMPROVEMENTS: - - buildpacks/golang: Bump default Go to 1.5.2 + - buildpacks/golang: Bump default Go to 1.6 - buildpacks/golang: Pass in `-t` to `go get` [[GH-96]] - buildpacks/inline: Support strings for the `provision` config on `devstep.yml` files - buildpacks/inline: Always run inline `provision` commands at the end of the build process, after all of the other buildpacks have kicked in. diff --git a/stack/buildpacks/golang/bin/compile b/stack/buildpacks/golang/bin/compile index 583998d..5c52e64 100755 --- a/stack/buildpacks/golang/bin/compile +++ b/stack/buildpacks/golang/bin/compile @@ -80,7 +80,7 @@ then name=$(git config --get-regexp '^remote.+\.url' | grep github | head -n1 | cut -f2 -d' ' | sed 's/^\(git\|https\):\/\///' | sed 's/^\w\+@//' | sed 's/:/\//' | sed 's/\.git$//' || echo -n '') popd &> /dev/null fi -ver=${ver:-go${GOVERSION:-1.5.2}} +ver=${ver:-go${GOVERSION:-1.6}} file=${GOFILE:-$ver.$(uname|tr A-Z a-z)-amd64$(platext $ver).tar.gz} url=${GOURL:-$(urlfor $ver $file)} From 13e218f7d94e13e1a47de31d50ea0b2fe73b15e8 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Wed, 9 Mar 2016 22:22:08 -0300 Subject: [PATCH 24/28] stack: Allow cache dir to be owned by users that are not root Yet another change to make things work fine on OSX --- stack/bin/fix-permissions | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stack/bin/fix-permissions b/stack/bin/fix-permissions index ca4648c..03a0ed1 100755 --- a/stack/bin/fix-permissions +++ b/stack/bin/fix-permissions @@ -23,7 +23,7 @@ user=${info[0]} gid=${info[1]} uid=${info[2]} -if [ $user != 'developer' ]; then +if [ $user == 'root' ]; then echo "-----> Changing cache dir owner to 'developer'" sudo chown developer: ${HOME}/cache fi From c394102ccfdce2f012dc3f9ad3d10ef771005930 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Thu, 10 Mar 2016 00:02:41 -0300 Subject: [PATCH 25/28] docs: Update documentation to reflect latest changes and document how to install the CLI on OSX --- docs/buildpacks/golang.md | 15 +++++++++----- docs/cli/commands.md | 2 +- docs/cli/installation.md | 37 ++++++++++++++++++---------------- docs/getting-started.md | 42 +++++++++++++++++++++++---------------- docs/introduction.md | 4 ++-- 5 files changed, 58 insertions(+), 42 deletions(-) diff --git a/docs/buildpacks/golang.md b/docs/buildpacks/golang.md index 6136f08..46561fa 100644 --- a/docs/buildpacks/golang.md +++ b/docs/buildpacks/golang.md @@ -9,9 +9,8 @@ If a `Godep` dir is found, this buildpack will download and install [godep](http into your `$PATH` and will parse the `GoVersion` and `ImportPath` attributes when setting things up. -Since currently devstep [does not support](https://github.com/fgrehm/devstep/issues/51) -setting the workspace directory used inside the container, this buildpack will -attempt to parse your project's import path for you using the following approach: +This buildpack will attempt to identify your project's import path for you using +the following priority: 1. `ImportPath` from Godep configs 2. `.godir` file @@ -19,9 +18,15 @@ attempt to parse your project's import path for you using the following approach 4. `GO_PROJECT_NAME` environmental variable After identifying the import path, the buildpack will symlink your project sources -into the appropriate path under the `$GOPATH/src` dir. +into the appropriate path under the `$GOPATH/src` dir. You can also configure +the `working_dir` to an appropriate path on your [project's `devstep.yml`](cli/configuration): -If godep is configured, the buildpack will attempt a `godep go build` for you, +```yml +# The directory where project sources should be mounted inside the container. +working_dir: '/home/devstep/gocode/src/github.com/fgrehm/devstep-cli' +``` + +If godep is configured, the buildpack will attempt a `godep go install` for you, otherwise it will download project's dependencies with `go get` so you can start hacking right away. diff --git a/docs/cli/commands.md b/docs/cli/commands.md index ca6e844..79cf0c6 100644 --- a/docs/cli/commands.md +++ b/docs/cli/commands.md @@ -3,7 +3,7 @@ 1. [Hack](#user-content-hack) 1. [Build](#user-content-build) -1. [Boostrap](#user-content-bootstrap) +1. [Bootstrap](#user-content-bootstrap) 1. [Other commands](#user-content-other-commands) -------------- diff --git a/docs/cli/installation.md b/docs/cli/installation.md index 248fc0d..fd25980 100644 --- a/docs/cli/installation.md +++ b/docs/cli/installation.md @@ -1,40 +1,43 @@ # CLI Installation ------------------ -The CLI is [written in Golang](https://github.com/fgrehm/devstep-cli) and precompiled -binaries are available for each GitHub tagged release. Installing it is a matter -of downloading it from GitHub, placing the binary on a directory available on your -`PATH` and making it executable. - -This one liner can handle it for you assuming that `$HOME/bin` is available -on your `PATH`: +Precompiled binaries are available for each GitHub tagged release: ```sh +# On Linux (assumes `$HOME/bin` is on your `PATH`) L=$HOME/bin/devstep && curl -sL https://github.com/fgrehm/devstep-cli/releases/download/v1.0.0/linux_amd64 > $L && chmod +x $L + +# On OSX +brew tap fgrehm/devstep +brew install devstep ``` -Please note that the CLI is currently limited to connecting to a local `/var/run/docker.sock` +Please note that the CLI currently defaults to connecting to a local `/var/run/docker.sock` socket only and the user that runs `devstep` commands will need [non-root access to it](http://docs.docker.io/installation/ubuntulinux/#giving-non-root-access). -Support for execution over TCP is likely to be added at some point. - +On OSX we rely on the environmental variables set by `docker-machine` (like +`DOCKER_HOST` and `DOCKER_CERT_PATH` for example) and also on the fact that the +`$HOME` dir is automagically shared with the VM that runs the docker daemon. > **IMPORTANT**: A `developer` user will be used by Devstep and it assumes your -user and group ids are equal to `1000` when using the CLI or the container's init -process will be aborted. This is to guarantee that files created within Docker -containers have the appropriate permissions so that you can manipulate them -on the host without the need to use `sudo`. This is currently a Devstep limitation -that will be worked around in case there is enough demand or will be fixed once -Docker adds support for user namespaces. +user and group ids are equal to `1000` when using the CLI. This is to guarantee +that files created within Docker containers have the appropriate permissions so +that you can manipulate them on the host without the need to use `sudo`. This is +currently a Devstep limitation that will be handled on a future release. > The `1000` id was chosen because it is the default uid / gid of Ubuntu Desktop users that are created during the installation process. To work around this limitation you can build your own image with the appropriate ids and add a `source_image: ':'` line to your `~/devstep.yml` so that the image is used as a source for your projects. +> When on OSX using dinghy, this should not be a problem thanks to how it sets up +NFS shares. + ## Bash autocomplete -An autocompletion script can be installed using the one liner below: +An autocompletion script for Linux can be installed using the one liner below: ```sh curl -sL https://github.com/codegangsta/cli/raw/master/autocomplete/bash_autocomplete | sed 's/$PROG/devstep/' | sudo tee /etc/bash_completion.d/devstep ``` + +On OSX it gets installed automatically thanks to Homebrew. diff --git a/docs/getting-started.md b/docs/getting-started.md index 6d825c8..4846985 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -12,37 +12,44 @@ will download that image as needed when using `Dockerfile`s but the Devstep CLI --------------- This project is being developed and tested on an Ubuntu 14.04 host with Docker -1.7.0, while it is likely to work on other distros / Docker versions / -[boot2docker](http://boot2docker.io/), I'm not sure how it will behave on the wild. +1.9.0+ and on OSX using [dinghy VMs](https://github.com/codekitchen/dinghy) powered +by the [xhyve docker-machine driver](https://github.com/zchee/docker-machine-driver-xhyve). +While it is likely to work on other distros / Docker versions / boot2docker setups, +I'm not sure how it will behave on the wild. -Please note that the CLI is currently limited to connecting to a local `/var/run/docker.sock` +Please note that the CLI currently defaults to connecting to a local `/var/run/docker.sock` socket only and the user that runs `devstep` commands will need [non-root access to it](http://docs.docker.io/installation/ubuntulinux/#giving-non-root-access). -Support for execution over TCP is likely to be added at some point in the future. +On OSX we rely on the environmental variables set by `docker-machine` (like +`DOCKER_HOST` and `DOCKER_CERT_PATH` for example) and also on the fact that the +`$HOME` dir is automagically shared with the VM that runs the docker daemon. ## Getting started with the CLI ------------------------------- > **IMPORTANT**: A `developer` user will be used by Devstep and it assumes your -user and group ids are equal to `1000` when using the CLI or the container's init -process will be aborted. This is to guarantee that files created within Docker -containers have the appropriate permissions so that you can manipulate them -on the host without the need to use `sudo`. This is currently a Devstep limitation -that will be worked around in case there is enough demand or will be fixed once -Docker adds support for user namespaces. +user and group ids are equal to `1000` when using the CLI. This is to guarantee +that files created within Docker containers have the appropriate permissions so +that you can manipulate them on the host without the need to use `sudo`. This is +currently a Devstep limitation that will be handled on a future release. > The `1000` id was chosen because it is the default uid / gid of Ubuntu Desktop users that are created during the installation process. To work around this limitation you can build your own image with the appropriate ids and add a `source_image: ':'` line to your `~/devstep.yml` so that the image is used as a source for your projects. -To install the CLI, you can run the one liner below and read on for more: +> When on OSX using dinghy, this should not be a problem thanks to how it sets up +NFS shares. + +To install the CLI: ```sh +# On Linux (assumes `$HOME/bin` is on your `PATH`) L=$HOME/bin/devstep && curl -sL https://github.com/fgrehm/devstep-cli/releases/download/v1.0.0/linux_amd64 > $L && chmod +x $L -``` -_The snippet above assumes `$HOME/bin` is on your `PATH`, change `$HOME/bin` to -an appropriate path in case your system is not configured like that._ +# On OSX +brew tap fgrehm/devstep +brew install devstep +``` ### Doing a quick hack on a project @@ -50,7 +57,8 @@ With the CLI and Docker in place, just `cd` into your project and run `devstep h it should be all you need to start working on your project. Devstep will create a Docker container, will install your project dependencies in it and at the end you'll be dropped on a `bash` session inside the container with project sources -available at `/workspace`. +available at `/workspace`. **Don't forget to `eval $(docker-machine env )` / +`eval $(dinghy env)` in case you are on OSX.** From inside the container, you can do your work as you would on your own machine. For example, you can use `rake test` to run your Ruby tests or `go build` to @@ -84,8 +92,8 @@ devstep hack -p 8080:8080 ``` And it will redirect the `8080` port on your host to the `8080` port within the -container so you can just hit `http://localhost:8080` on your browser to see your -app running after it is up. +container so you can just hit `http://localhost:8080` (or `http://DOCKER_HOST:8080`) +on your browser to see your app running after it is up. ### Using databases or other services from within containers diff --git a/docs/introduction.md b/docs/introduction.md index 2c41b38..b787312 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -52,8 +52,8 @@ Heroku apps) will be available for `fgrehm/devstep` environments. On top of `heroku/cedar:14`, we: * Create a `developer` user to avoid using `root` and creating files with wrong permissions during development. -* Install some extra devel packages (like `libyaml-dev`) and other "nice to have" - packages and utilities (like `tmux` and `vim`). +* Install some extra devel packages (like `libreadline`) and other "nice to have" + packages and utilities (like `vim` and `sqlite3`). * Configure PostgreSQL and MySQL clients. * Set the image `ENTRYPOINT` to our own init system and the default command to a `bash` login shell. * Configure a couple of startup scripts (like automatic port forwading to linked containers). From 49d12faf9709609814bd4afe60c59663faf6903a Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Thu, 10 Mar 2016 00:34:03 -0300 Subject: [PATCH 26/28] docs/cli: `binstubs` command is gone --- docs/cli/commands.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/cli/commands.md b/docs/cli/commands.md index 79cf0c6..73af3f0 100644 --- a/docs/cli/commands.md +++ b/docs/cli/commands.md @@ -129,7 +129,6 @@ of choice. * `info` - Show information about the current environment * `run` - Run a one off command against the current base image * `exec` - Run a one off command against the last container created for the current project -* `binstubs` - Generate binstubs for the commands specified on devstep.yml * `clean` - Remove previously built images for the current environment * `pristine` - Rebuild project image from scratch * `help, h` - Shows a list of commands or help for one command From 099e1842e45c230f283f3fa0a4e7fc6b84248671 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Thu, 10 Mar 2016 00:38:05 -0300 Subject: [PATCH 27/28] addons: Remove docker Used it only or twice in the past --- CHANGELOG.md | 2 + docs/addons/docker.md | 13 ----- docs/template.html | 1 - stack/addons/docker/bin/configure | 43 -------------- stack/addons/docker/bin/start-daemon | 15 ----- stack/addons/docker/bin/wrapdocker | 87 ---------------------------- 6 files changed, 2 insertions(+), 159 deletions(-) delete mode 100644 docs/addons/docker.md delete mode 100755 stack/addons/docker/bin/configure delete mode 100755 stack/addons/docker/bin/start-daemon delete mode 100755 stack/addons/docker/bin/wrapdocker diff --git a/CHANGELOG.md b/CHANGELOG.md index d8ad792..d6a16f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,10 @@ ## [1.0.0](https://github.com/fgrehm/devstep/compare/v0.4.0...next) (unreleased) BREAKING CHANGES: + - baseimage: Removed PostgreSQL and MySQL clients - baseimage: Removed tmux + - addons: Removed `docker` - buildpacks: Removed `bats` and `phantomjs` IMPROVEMENTS: diff --git a/docs/addons/docker.md b/docs/addons/docker.md deleted file mode 100644 index af31e66..0000000 --- a/docs/addons/docker.md +++ /dev/null @@ -1,13 +0,0 @@ -# Docker Addon --------------- - -This addon will install Docker 1.3.0 from https://get.docker.io/builds/Linux/x86_64 -and will set things up for running nested Docker containers based on https://github.com/jpetazzo/dind. - -In order to use it, you need to provide both the `--privileged` flag and because -`/var/lib/docker` cannot be on AUFS, so we need to make it a volume with `-v /var/lib/docker`. - -To install it you can run `configure-addons docker` from within the container. - -To specify a Docker version, use the the `DEVSTEP_DOCKER_VERSION` environmental -variable. diff --git a/docs/template.html b/docs/template.html index c369549..f675346 100644 --- a/docs/template.html +++ b/docs/template.html @@ -128,7 +128,6 @@
  • Addons
      -
    • Docker
    • Memcached
    • PostgreSQL
    • Redis
      • diff --git a/stack/addons/docker/bin/configure b/stack/addons/docker/bin/configure deleted file mode 100755 index b13a4e6..0000000 --- a/stack/addons/docker/bin/configure +++ /dev/null @@ -1,43 +0,0 @@ -#!/usr/bin/env bash - -set -e # fail fast -set -o pipefail # dont ignore exit codes when piping output -# set -x # enable debugging - -CACHE_DIR=${2:-"${HOME}/cache/docker"} -DOCKER_CMD="${HOME}/bin/docker" -DEVSTEP_DOCKER_VERSION=${DEVSTEP_DOCKER_VERSION:-"1.5.0"} -URL=https://get.docker.com/builds/Linux/x86_64/docker-${DEVSTEP_DOCKER_VERSION} - -mkdir -p $CACHE_DIR - -if ! [ -x "${DOCKER_CMD}" ]; then - if ! [ -f "${CACHE_DIR}/docker-${DEVSTEP_DOCKER_VERSION}" ]; then - echo "-----> [docker] Downloading ${DEVSTEP_DOCKER_VERSION} version from ${URL}" - curl -l -s $URL > ${CACHE_DIR}/docker-${DEVSTEP_DOCKER_VERSION} - fi - - cp ${CACHE_DIR}/docker-${DEVSTEP_DOCKER_VERSION} ${DOCKER_CMD} - chmod +x "${DOCKER_CMD}" -fi - -if ! [ -x /sbin/iptables ] || ! [ -x /sbin/apparmor_parser ]; then - echo "-----> [docker] Installing iptables and apparmor" - sudo apt-get update -q && sudo apt-get install iptables apparmor -y --force-yes -q -fi - -echo "-----> [docker] Installed $(${HOME}/bin/docker --version)" - -addon_basedir="$( cd -P "$( dirname "$0" )" && pwd )" - -cp ${addon_basedir}/wrapdocker "$DEVSTEP_CONF/init.d/00-wrapdocker.sh" -chmod +x "$DEVSTEP_CONF/init.d/00-wrapdocker.sh" -${addon_basedir}/wrapdocker - -cp $addon_basedir/start-daemon $DEVSTEP_CONF/init.d/01-start-docker.sh -chmod +x $DEVSTEP_CONF/init.d/01-start-docker.sh - -echo "-----> [docker] Starting daemon" -$DEVSTEP_CONF/init.d/01-start-docker.sh &>/dev/null || true - -echo "-----> [docker] Finished configuration!" diff --git a/stack/addons/docker/bin/start-daemon b/stack/addons/docker/bin/start-daemon deleted file mode 100755 index 54cb126..0000000 --- a/stack/addons/docker/bin/start-daemon +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env bash - -set -e # fail fast -set -o pipefail # dont ignore exit codes when piping output -# set -x # enable debugging - -# If a pidfile is still around (for example after a container restart), -# delete it so that docker can start. -mkdir -p ${HOME}/run -rm -f ${HOME}/run/docker.pid - -! [ -L /var/run/docker.sock ] && - sudo ln -s ${HOME}/run/docker.sock /var/run/docker.sock - -sudo ${HOME}/bin/docker -d -p ${HOME}/run/docker.pid -G developer -H unix://${HOME}/run/docker.sock &> ${HOME}/log/docker.log & &>/dev/null diff --git a/stack/addons/docker/bin/wrapdocker b/stack/addons/docker/bin/wrapdocker deleted file mode 100755 index 3b30bd6..0000000 --- a/stack/addons/docker/bin/wrapdocker +++ /dev/null @@ -1,87 +0,0 @@ -#!/bin/bash - -set -e # fail fast -set -o pipefail # dont ignore exit codes when piping output -# set -x # enable debugging - -# FROM https://github.com/jpetazzo/dind/blob/master/wrapdocker - -# First, make sure that cgroups are mounted correctly. -CGROUP=/sys/fs/cgroup -: {LOG:=stdio} - -[ -d $CGROUP ] || - sudo mkdir $CGROUP - -sudo mountpoint -q $CGROUP || - sudo mount -n -t tmpfs -o uid=0,gid=0,mode=0755 cgroup $CGROUP || { - echo "Could not make a tmpfs mount. Did you use --privileged?" - exit 1 - } - -if [ -d /sys/kernel/security ] && ! sudo mountpoint -q /sys/kernel/security -then - sudo mount -t securityfs none /sys/kernel/security || { - echo "Could not mount /sys/kernel/security." - echo "AppArmor detection and --privileged mode might break." - } -fi - -# Mount the cgroup hierarchies exactly as they are in the parent system. -for SUBSYS in $(cut -d: -f2 /proc/1/cgroup) -do - [ -d $CGROUP/$SUBSYS ] || sudo mkdir $CGROUP/$SUBSYS - sudo mountpoint -q $CGROUP/$SUBSYS || - sudo mount -n -t cgroup -o $SUBSYS cgroup $CGROUP/$SUBSYS - - # The two following sections address a bug which manifests itself - # by a cryptic "lxc-start: no ns_cgroup option specified" when - # trying to start containers withina container. - # The bug seems to appear when the cgroup hierarchies are not - # mounted on the exact same directories in the host, and in the - # container. - - # Named, control-less cgroups are mounted with "-o name=foo" - # (and appear as such under /proc//cgroup) but are usually - # mounted on a directory named "foo" (without the "name=" prefix). - # Systemd and OpenRC (and possibly others) both create such a - # cgroup. To avoid the aforementioned bug, we symlink "foo" to - # "name=foo". This shouldn't have any adverse effect. - echo $SUBSYS | grep -q ^name= && { - NAME=$(echo $SUBSYS | sed s/^name=//) - if ! [ -L $CGROUP/$NAME ]; then - sudo ln -s $SUBSYS $CGROUP/$NAME - fi - } - - # Likewise, on at least one system, it has been reported that - # systemd would mount the CPU and CPU accounting controllers - # (respectively "cpu" and "cpuacct") with "-o cpuacct,cpu" - # but on a directory called "cpu,cpuacct" (note the inversion - # in the order of the groups). This tries to work around it. - [ $SUBSYS = cpuacct,cpu ] && sudo ln -s $SUBSYS $CGROUP/cpu,cpuacct -done - -# Note: as I write those lines, the LXC userland tools cannot setup -# a "sub-container" properly if the "devices" cgroup is not in its -# own hierarchy. Let's detect this and issue a warning. -grep -q :devices: /proc/1/cgroup || - echo "WARNING: the 'devices' cgroup should be in its own hierarchy." -grep -qw devices /proc/1/cgroup || - echo "WARNING: it looks like the 'devices' cgroup is not mounted." - -# Now, close extraneous file descriptors. -pushd /proc/self/fd >/dev/null -for FD in * -do - case "$FD" in - # Keep stdin/stdout/stderr - [012]) - ;; - # Nuke everything else - *) - eval exec "$FD>&-" - ;; - esac -done -popd >/dev/null From 3eb3a7228009143dcc0c8b5f6430aae217635784 Mon Sep 17 00:00:00 2001 From: Fabio Rehm Date: Thu, 10 Mar 2016 14:39:07 -0300 Subject: [PATCH 28/28] v1.0.0 --- CHANGELOG.md | 3 +-- docs/introduction.md | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d6a16f0..5258059 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,7 @@ -## [1.0.0](https://github.com/fgrehm/devstep/compare/v0.4.0...next) (unreleased) +## [1.0.0](https://github.com/fgrehm/devstep/compare/v0.4.0...v1.0.0) (2016-03-10) BREAKING CHANGES: - - baseimage: Removed PostgreSQL and MySQL clients - baseimage: Removed tmux - addons: Removed `docker` - buildpacks: Removed `bats` and `phantomjs` diff --git a/docs/introduction.md b/docs/introduction.md index b787312..7c0fb5a 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -67,7 +67,6 @@ _For more information please have a look at the [Dockerfile](https://github.com/ * [Golang](buildpacks/golang) * [Inline](buildpacks/inline) * [Node.js](buildpacks/nodejs) -* [PhantomJS](buildpacks/phantomjs) * [Python](buildpacks/python) * [Ruby](buildpacks/ruby)