solana/ci

Our CI infrastructure is built around BuildKite with some additional GitHub integration provided by https://github.com/mvines/ci-gate

Running Locally

To run the CI suite locally, you can run the run-local.sh script.

Before you do, there are a few dependencies that need to be installed:

cargo install cargo-audit cargo-sort grcov

macOS

On macOS, you will need to install coreutils:

brew install coreutils

Make sure to update your PATH environment variable:

export PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"

If you notice the error UnableToSetOpenFileDescriptorLimit you may need to increase the number of available file descriptors:

sudo launchctl limit maxfiles 100000
ulimit -n 1000000

Agent Queues

We define two Agent Queues: queue=default and queue=cuda. The default queue should be favored and runs on lower-cost CPU instances. The cuda queue is only necessary for running tests that depend on GPU (via CUDA) access -- CUDA builds may still be run on the default queue, and the buildkite artifact system used to transfer build products over to a GPU instance for testing.

Buildkite Agent Management

Manual Node Setup for Colocated Hardware

This section describes how to set up a new machine that does not have a pre-configured image with all the requirements installed. Used for custom-built hardware at a colocation or office facility. Also works for vanilla Ubuntu cloud instances.

Pre-Requisites

• Install Ubuntu 18.04 LTS Server
• Log in as a local or remote user with sudo privileges

Install Core Requirements

Non-GPU enabled machines

sudo ./setup-new-buildkite-agent/setup-new-machine.sh

GPU-enabled machines

• 1 or more NVIDIA GPUs should be installed in the machine (tested with 2080Ti)

sudo CUDA=1 ./setup-new-buildkite-agent/setup-new-machine.sh

Configure Node for Buildkite-agent based CI

• Install buildkite-agent and set up its user environment with:

sudo ./setup-new-buildkite-agent/setup-buildkite.sh

• Copy the pubkey contents from ~buildkite-agent/.ssh/id_ecdsa.pub and add the pubkey as an authorized SSH key on github.
  • In net/scripts/solana-user-authorized_keys.sh
  • Bug mvines to add it to the "solana-grimes" github user
• Edit /etc/buildkite-agent/buildkite-agent.cfg and/or /etc/systemd/system/buildkite-agent@* to the desired configuration of the agent(s)
• Copy ejson keys from another CI node at /opt/ejson/keys/ to the same location on the new node.
• Start the new agent(s) with sudo systemctl enable --now buildkite-agent

Reference

This section contains details regarding previous CI setups that have been used, and that we may return to one day.

Buildkite Azure Setup

Create a new Azure-based "queue=default" agent by running the following command:

$ az vm create \
   --resource-group ci \
   --name XYZ \
   --image boilerplate \
   --admin-username $(whoami) \
   --ssh-key-value ~/.ssh/id_rsa.pub

The "boilerplate" image contains all the required packages pre-installed so the new machine should immediately show up in the Buildkite agent list once it has been provisioned and be ready for service.

Creating a "queue=cuda" agent follows the same process but additionally:

1. Resize the image from the Azure port to include a GPU
2. Edit the tags field in /etc/buildkite-agent/buildkite-agent.cfg to tags="queue=cuda,queue=default" and decrease the value of the priority field by one

Updating the CI Disk Image

1. Create a new VM Instance as described above
2. Modify it as required
3. When ready, ssh into the instance and start a root shell with sudo -i. Then prepare it for deallocation by running: waagent -deprovision+user; cd /etc; ln -s ../run/systemd/resolve/stub-resolv.conf resolv.conf
4. Run az vm deallocate --resource-group ci --name XYZ
5. Run az vm generalize --resource-group ci --name XYZ
6. Run az image create --resource-group ci --source XYZ --name boilerplate
7. Goto the ci resource group in the Azure portal and remove all resources with the XYZ name in them

Buildkite AWS CloudFormation Setup

AWS CloudFormation is currently inactive, although it may be restored in the future

AWS CloudFormation can be used to scale machines up and down based on the current CI load. If no machine is currently running it can take up to 60 seconds to spin up a new instance, please remain calm during this time.

AMI

We use a custom AWS AMI built via https://github.com/solana-labs/elastic-ci-stack-for-aws/tree/solana/cuda.

Use the following process to update this AMI as dependencies change:

$ export AWS_ACCESS_KEY_ID=my_access_key
$ export AWS_SECRET_ACCESS_KEY=my_secret_access_key
$ git clone https://github.com/solana-labs/elastic-ci-stack-for-aws.git -b solana/cuda
$ cd elastic-ci-stack-for-aws/
$ make build
$ make build-ami

Watch for the "amazon-ebs: AMI:" log message to extract the name of the new AMI. For example:

amazon-ebs: AMI: ami-07118545e8b4ce6dc

The new AMI should also now be visible in your EC2 Dashboard. Go to the desired AWS CloudFormation stack, update the ImageId field to the new AMI id, and apply the stack changes.

Buildkite GCP Setup

CI runs on Google Cloud Platform via two Compute Engine Instance groups: ci-default and ci-cuda. Autoscaling is currently disabled and the number of VM Instances in each group is manually adjusted.

Updating a CI Disk Image

Each Instance group has its own disk image, ci-default-vX and ci-cuda-vY, where X and Y are incremented each time the image is changed.

The manual process to update a disk image is as follows:

1. Create a new VM Instance using the disk image to modify.
2. Once the VM boots, ssh to it and modify the disk as desired.
3. Stop the VM Instance running the modified disk. Remember the name of the VM disk
4. From another machine, gcloud auth login, then create a new Disk Image based off the modified VM Instance:

 $ gcloud compute images create ci-default-$(date +%Y%m%d%H%M) --source-disk xxx --source-disk-zone us-east1-b --family ci-default

or

  $ gcloud compute images create ci-cuda-$(date +%Y%m%d%H%M) --source-disk xxx --source-disk-zone us-east1-b --family ci-cuda

5. Delete the new VM instance.
6. Go to the Instance templates tab, find the existing template named ci-default-vX or ci-cuda-vY and select it. Use the "Copy" button to create a new Instance template called ci-default-vX+1 or ci-cuda-vY+1 with the newly created Disk image.
7. Go to the Instance Groups tag and find the applicable group, ci-default or ci-cuda. Edit the Instance Group in two steps: (a) Set the number of instances to 0 and wait for them all to terminate, (b) Update the Instance template and restore the number of instances to the original value.
8. Clean up the previous version by deleting it from Instance Templates and Images.