Vitess Releases

The point of this repository is currently to build a Vitess tar package that we upload to github rather than the docker images at https://github.com/vitessio/vitess/tree/master/docker.

Install Latest Vitess Release (Linux)

The install_latest.sh script is a helper to install the latest release from github on Linux:

git clone https://github.com/planetscale/vitess-releases.git
cd vitess-releases/bin
./install_latest.sh

Create A New Release

The builder.sh script is a shell script that can build and package a new Vitess release on Ubuntu suitable for upload to github. It's recommended that you run this on a fresh VM to reduce variability.

This is the quick version of building a new release, suitable for upload to github:

Before You Begin

1. Check that you have an existing SSH key

2. If you have not, follow the steps to setup a new SSH key and add your key to your GitHub account

3. Send your public key pair to Adrianna or Lucy

4. Once they have confirmed the addition of your public key pair, add the following to your ~/.ssh/config file:

   Host planet-build
   Hostname ec2-52-53-190-177.us-west-1.compute.amazonaws.com
   User planetscale
   

5. Check that you have the access you need by typing ssh planet-build in a terminal

Software Release Process

• In a terminal, do ssh planet-build. If you are successful, you will see that you have logged in to an Ubuntu server on AWS.
• cd ~/go/src
• If you not see the vitess-releases dirrectory, clone the vitess-releases repo: git clone https://github.com/planetscale/vitess-releases.git github.com/planetscale/vitess-releases
• cd github.com/planetscale/vitess-releases/bin. ls to check that you see the following files:
  • builder.sh
  • install_latest.sh
  • release_README.md
• Run git pull to ensure you have the latest files
• Now, we will run the builder script: ./builder.sh. If the script runs successfully, you will see that dependencies have been installed, and the script has ended with the following example output:

bootstrap finished - run 'source build.env' in your shell before building.
Wed Mar 6 22:53:57 UTC 2019: Building source tree
cp -Lrpf /home/planetscale/go/bin/. /home/planetscale/releases/vitess-release-5b135f4/bin
cp -Lrpf /home/planetscale/go/lib/. /home/planetscale/releases/vitess-release-5b135f4/lib
cp -Lrpf /home/planetscale/go/dist/. /home/planetscale/releases/vitess-release-5b135f4/dist
cp -Lrpf /home/planetscale/go/config/. /home/planetscale/releases/vitess-release-5b135f4/config
cp -Lrpf /home/planetscale/go/pkg/. /home/planetscale/releases/vitess-release-5b135f4/pkg
cp -Lrpf /home/planetscale/go/vthook/. /home/planetscale/releases/vitess-release-5b135f4/vthook
Release Notes
vitess-release-5b135f4.tar.gz created as of 03-06-19 at 10:55:23 PM UTC
SHA256: 67a4d9164d8fa8d3adc64d2614bf502cc9821fd605abbf9bad41976671dc90b0

• Check the timestamp of the files in the release directory: ls -l ~/releases
• If you see a binary that was recently created, you have successfully built and created a release tar.gz. (Note: if the file was created at a later time, check the timestamp against UTC time: type date in a terminal)
• In a local terminal window, copy the .tar.gz file to your local working folder: scp planet-build:~/releases/vitess-release-xxxxxxx.tar.gz ., replacing the file name with the 7-character binary you just built
• Navigate to the releases view in vitess-releases repo
• If you have privileges to release software in this repo, you will see a button named Draft a new release in the top right corner of the releases view (If you do not see this, reach out to Adrianna or Lucy)
• Now, you are ready to draft a new release. Upload the binary from your local working folder. Fill in the details for tag and title. For description, you can just copy the final two lines printed after 'Release Notes' from the builder.sh output.
• Click publish release
• This document will be added with additional instructions on best practices on tagging, versioning semantices and release notes.