Support docker for gitian builds

Building with docker is arguably easier and more familiar to most people
than either kvm, or lxc.

This commit also relaxes the back compat requirement a bit. 32 bit linux
now uses glibc version 2.0. Also, the docker shell could not handle gcc arguments
containing spaces, so the explicit '-DFELT_TYPE' declaration was dropped.

Lastly, this removes some packages from the osx descriptor.

1 files changed, 60 insertions, 14 deletions

diff --git a/contrib/gitian/README.md b/contrib/gitian/README.md
index 0b13df344..b869bde87 100644
--- a/contrib/gitian/README.md
+++ b/contrib/gitian/README.md
@@ -1,7 +1,7 @@
 Gitian building
 ================
 
-*Setup instructions for a Gitian build of Monero using a VM or physical system.*
+*Setup instructions for a Gitian build of Monero.*
 
 Gitian is the deterministic build process that is used to build the Monero CLI
 executables. It provides a way to be reasonably sure that the
@@ -13,6 +13,10 @@ Multiple developers build the source code by following a specific descriptor
 These results are compared and only if they match, the build is accepted and provided
 for download.
 
+Gitian runs compilation steps in an isolated container. It is flexible and gives you full
+control over the build environment, while still ensuring reproducibility and consistent output
+formats.
+
 More independent Gitian builders are needed, which is why this guide exists.
 It is preferred you follow these steps yourself instead of using someone else's
 VM image to avoid 'contaminating' the build.
@@ -22,11 +26,17 @@ Preparing the Gitian builder host
 
 The first step is to prepare the host environment that will be used to perform the Gitian builds.
 This guide explains how to set up the environment, and how to start the builds.
+Gitian offers to build with either `kvm`, `docker` or `lxc`. The default build
+path chosen is `lxc`, but its setup is more complicated. You need to be logged in as the `gitianuser`. 
+If this user does not exist yet on your system, create it. Gitian can use
+either kvm, lxc or docker as a host environment. This documentation will show
+how to build with lxc and docker. While the docker setup is easy, the lxc setup
+is more involved.
+
+LXC
+---
 
-Gitian builds are for now executed on Ubuntu 18.04 "Bionic Beaver". A solution is being worked on to run 
-it in docker in the future. Please run Ubuntu in either a VM, or on your physical machine.
-You need to be logged in as the `gitianuser` in order to build gitian builds. If this user does not exist yet on your system, 
-create it. 
+LXC builds should be run on Ubuntu 18.04 "Bionic Beaver".
 
 Note that a version of `lxc-execute` higher or equal to 2.1.1 is required.
 You can check the version with `lxc-execute --version`.
@@ -63,15 +73,28 @@ reboot
 
 This setup is required to enable networking in the container.
 
+Docker
+------
+
+Building in docker does not require much setup. Install docker on your host, then type the following:
+
+```bash
+sudo apt-get install git make curl
+sudo usermod -aG docker gitianuser
+```
+
 
 Manual and Building
 -------------------
-The instructions below use the automated script [gitian-build.py](https://github.com/betcoin/bitcoin/blob/master/contrib/gitian-build.py) which only works in Ubuntu. 
-It calls all available descriptors. Help for the build steps taken can be accessed with `./gitian-build.py --help`.
+
+The instructions below use the automated script [gitian-build.py](gitian-build.py) which only works in Ubuntu. 
+It calls all available .yml descriptors, which in turn pass the build configurations for different platforms to gitian.
+Help for the build steps taken can be accessed with `./gitian-build.py --help`.
 
 Initial Gitian Setup
 --------------------
-The `gitian-build.py` script will checkout different release tags, so it's best to copy it:
+
+The `gitian-build.py` script will checkout different release tags, so it's best to copy it to the top level directory:
 
 ```bash
 cp monero/contrib/gitian/gitian-build.py .
@@ -79,11 +102,16 @@ cp monero/contrib/gitian/gitian-build.py .
 
 Setup the required environment, you only need to do this once:
 
-```
+```bash
 ./gitian-build.py --setup fluffypony v0.14.0
 ```
 
-Where `fluffypony` is your Github name and `v0.14.0` is the version tag you want to build.
+Where `fluffypony` is your Github name and `v0.14.0` is the version tag you want to build. 
+If you are using docker, run it with:
+
+```bash
+./gitian-build.py --setup --docker fluffypony v0.14.0
+```
 
 While gitian and this build script does provide a way for you to sign the build directly, it is recommended to sign in a seperate step. 
 This script is only there for convenience. Seperate steps for building can still be taken.
@@ -98,9 +126,11 @@ git remote add fluffypony git@github.com:fluffypony/gitian.sigs.git
 
 Build Binaries
 -----------------------------
-To build the most recent tag:
+To build the most recent tag (pass in `--docker` after setting up with docker):
 
- `./gitian-build.py --detach-sign --no-commit -b fluffypony v0.14.0`
+```bash
+./gitian-build.py --detach-sign --no-commit -b fluffypony v0.14.0
+```
 
 To speed up the build, use `-j 5 -m 5000` as the first arguments, where `5` is the number of CPU's you allocated to the VM plus one, and 5000 is a little bit less than then the MB's of RAM you allocated. If there is memory corruption on your machine, try to tweak these values.
 
@@ -108,7 +138,7 @@ If all went well, this produces a number of (uncommited) `.assert` files in the
 
 If you do detached, offline signing, you need to copy these uncommited changes to your host machine, where you can sign them. For example:
 
-```
+```bash
 export NAME=fluffypony
 export VERSION=v0.14.0
 gpg --output $VERSION-linux/$NAME/monero-linux-$VERSION-build.assert.sig --detach-sign $VERSION-linux/$NAME/monero-linux-$VERSION-build.assert
@@ -119,7 +149,7 @@ gpg --output $VERSION-win-unsigned/$NAME/monero-win-$VERSION-build.assert.sig --
 Make a pull request (both the `.assert` and `.assert.sig` files) to the
 [monero-project/gitian.sigs](https://github.com/monero-project/gitian.sigs/) repository:
 
-```
+```bash
 git checkout -b v0.14.0
 git commit -S -a -m "Add $NAME v0.14.0"
 git push --set-upstream $NAME v0.14.0
@@ -131,3 +161,19 @@ git push --set-upstream $NAME v0.14.0
     gpg --detach-sign ${VERSION}-osx-unsigned/${SIGNER}/monero-osx-*-build.assert
 ```
 
+More Build Options
+------------------
+
+You can choose your own remote and commit hash by running for example:
+```bash
+./gitian-build.py --detach-sign --no-commit --url https://github.com/moneromooo-monero/bitmonero -b moneromooo 1f5680c8db8f4cc7acc04a04c724b832003440fd
+```
+
+Note that you won't be able to build commits authored before the gitian scripts
+were added. Gitian clones the source files from the given url, be sure to push
+to the remote you provide before building.
+To get all build options run:
+```bash
+./gitian-build.py --help
+```
+