Differential D2418 Diff 6940 contrib/teamcity/README.md

Changeset View

Standalone View

contrib/teamcity/README.md

	# TeamCity Contrib			# TeamCity Contrib

	This directory contains files necessary for running builds on the Bitcoin-ABC Teamcity Instance.			This directory contains scripts and other files necessary for running builds on
				the Bitcoin-ABC TeamCity agent instance.

	# build.sh			# TeamCity Agent Setup

	Basic build script for building Bitcoin-ABC under a basic ubuntu install.			Basic steps for creating a new TeamCity build agent.

	# teamcitybot.py			## Create a new, empty VM

	Reports build output to phabricator in an intelligible manner. Generally it accepts junit files as command line arguments. A build.status file is also accepted for more general failures.			Select the following options:
				1. OS: Debian (Stretch; Ubuntu works as a backup option)
				2. Disk Space: 20GB (Disk space can be increased later. Always start with the smallest disk space necessary to reduce overhead costs)
				3. CPUs: 4+ (recommended 8+ for IBD and gitian builds)
				4. Memory: 8GB+ (minimum 32GB for running IBD)

				## Stepup user to run builds

				```
				# Create the build user
				sudo useradd teamcity

				# Login to this user for the next step
				sudo su teamcity
				cd ~
				```

				## Install TeamCity Agent Software

				In general, the instructions provided by TeamCity may be followed for setting up a new agent image: https://confluence.jetbrains.com/display/TCD18/Setting+up+and+Running+Additional+Build+Agents

				However, the instructions are not step-by-step and require a lot of decision making. Below is an attempt to break the instructions down so they can be executed quickly:

				```
				# Install Java JRE
				sudo apt-get install default-jre
				sudo vim /etc/environment

				# Add the following line to /etc/environment:
				JAVA_HOME="/usr/lib/jvm/default-java"

				# If this link is not available, it can be found at:
				# https://build.bitcoinabc.org/agents.html -> "Install Build Agents"
				wget https://build.bitcoinabc.org/update/buildAgent.zip

				# Location of where to untar this is up to you, but home directory works fine
				tar xf buildAgent.tar.gz
				cd conf
				cp buildAgent.dist.properties buildAgent.properties
				vim buildAgent.properties

				# Edit the serverUrl line to the following:
				serverUrl=https://build.bitcoinabc.org/

				# Make sure agent.sh is executable
				cd ../bin
				chmod +x agent.sh

				# Setup automatic start for the TeamCity agent
				cd /etc/init.d
				sudo vim buildAgent

				# Copy the contents of the buildAgent-autostart script in the directory of
				# this README into buildAgent. Modify the cd ~/bin and/or USER as needed.

				sudo chmod 755 buildAgent
				sudo update-rc.d buildAgent defaults
				```

				## Install necessary build dependencies for bitcoin-abc

				See [build-unix.md](doc/build-unix.md)