Bob

Bob the Buildah

Bob is a collection of scripts for easily, and repeatedly building custom containers, with an emphasis on lean images, and targeting the Buildah tool. Bob likes both rkt and docker containers. If you think there is a better build tool for this use case, please let us know - we can change.

It is inspired by and builds on Veewee

Opinionated

Bob tries not to be grumpy or inflexible, but he is opinionated. He currently holds the following opinions:

• Documentation is removed: unless the containers purpose is to serve documents, e.g. a Jupyter container would be expected to have the documents related to the Jupyter Lab tools, but not, say, cron man files. The same reasoning applies to caches and logs.
• Convention over configuration: Always happy to hear convention proposals, and why they work - open an issue, or pull request.

Conventions

• Folder naming/hierarchy: The folder hierarchy SHALL be resolved within a container as

 /home/bob/scripts/${DISTRIB_ID}/${DISTRIB_RELEASE}/<component>/{install|config|uninstall}/.sh

• Shell variable names: The name communicates context and location. An example. Setting a variable WORKER_NAME in the file ./alpine/3.7/nomad/install.sh means it SHALL have the name INSTALL_NOMAD_WORKER_NAME.
• Buildah Configuration scripts: SHALL be named buildah-config.sh. Example: Once copied into the container:

/home/bob/scripts/${DISTRIB_ID}/${DISTRIB_RELEASE}/<component>/buildah-config.sh

• All Bob's scripts are removed before an image save/commit/push.

Setting up an OCI build

If you change the directories/files you would like checked out from Bob:

1. edit the file .git/info/sparse-checkout
2. run git read-tree -mu HEAD (note -mu is merge then update).

New repository

WARNING: INCOMPLETE-DO-NOT-BLINDLY-APPLY NOTE: Requires git version > 2.12

sudo add-apt-repository ppa:git-core/ppa
sudo apt-get update
sudo apt-get install git

To add bob (squashes all commits, like a git clone --depth=1 ... ):

BOB_REPO=jupyter-base
BOB_DIST=alpine
BOB_DIST_RELEASE=3.7

cd ${BOB_REPO}
git init
git remote add origin https://your.origin/repo/here.git
## Make and commit a change before adding subtree
git subtree add --prefix bob https://github.com/taqtiqa/bob.git master --squash

To update bob:

git subtree pull --prefix bob https://github.com/taqtiqa/bob.git master --squash

Using submodules is more intricate:

BOB_REPO=oci-jupyter-base
BOB_DIST=alpine
BOB_DIST_RELEASE=3.7

mkdir ${BOB_REPO} 
cd ${BOB_REPO}
git init
git remote add origin https://your.origin/repo/here.git
git clone --depth=1 --no-checkout https://github.com/taqtiqa/bob.git bob
git submodule add https://github.com/taqtiqa/bob.git bob
git submodule absorbgitdirs
git -C bob config core.sparseCheckout true
echo 'scripts/${BOB_DIST}/${BOB_DIST_RELEASE}/*' >>.git/modules/bob/info/sparse-checkout
git submodule update --force --checkout bob

Existing repository

WARNING: INCOMPLETE-DO-NOT-BLINDLY-APPLY NOTE: Requires git version > 2.12

BOB_REPO=jupyter-base
BOB_DIST=alpine
BOB_DIST_RELEASE=3.7

cd ${BOB_REPO}
git clone --depth=1 --no-checkout https://github.com/taqtiqa/bob.git bob
git submodule add https://github.com/taqtiqa/bob.git bob
git submodule absorbgitdirs
git -C bob config core.sparseCheckout true
echo 'scripts/${BOB_DIST}/${BOB_DIST_RELEASE}/*' >>.git/modules/bob/info/sparse-checkout
git submodule update --force --checkout bob

To add bob:

BOB_REPO=jupyter-base
BOB_DIST=alpine
BOB_DIST_RELEASE=3.7

cd ${BOB_REPO}
git subtree add --prefix bob https://github.com/taqtiqa/bob.git master --squash

To update bob:

git subtree pull --prefix bob https://github.com/taqtiqa/bob.git master --squash

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

All contributions welcome for any distribution and any application. Please try to adhere to the stated conventions, or propose a change with the reasons why.

Unless you explicitly state otherwise, any contribution submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.