Gerrit/Upgrade

Gerrit

• Administration
• Bot account
• Events ingestion
• NewUser
• Operations
• Phabricator integration
• Replica
• Running in Cloud VPS
• Upgrade
• test instance

[]

Since Feb 2nd 2021, we deploy the upstream war file as is. It is fetched from https://www.gerritcodereview.com/ , stored using git-fat in operations/software/gerrit under a deploy/wmf/stable-X.Y branch. We still build extra plugins from sources, the build relies on the source code held in the Gerrit repository operations/software/gerrit in branch wmf/stable-X.Y

The upstream branches (master, stable-3.2) are manually kept in sync. We have a forked branch wmf/stable-3.2 which has our extra plugins registered as sub-modules as well as some Wikimedia specific build scripts at the root of the repository. Our branch can be used to cherry pick patches for plugins build purpose, but must eventually be send to upstream, reviewed and merged there. The branch overview:

operations/software/gerrit branches layout

Branch	Description
stable-3.2	Gerrit core, updated from upstream
wmf/stable-3.2	Fork holding our build script and our plugins as submodules
wmf/deploy/stable-3.2	scap deployment repository holding Gerrit .war and plugins .jar with git-fat

Build prerequisites

The full list of requirements can be found at https://gerrit.wikimedia.org/r/Documentation/dev-bazel.html or from source at https://gerrit.wikimedia.org/g/operations/software/gerrit/+/refs/heads/stable-3.2/Documentation/dev-bazel.txt

Install OpenJDK 8, git, NodeJS, Python 3. On Debian:

$ sudo apt install git openjdk-8-jdk-headless nodejs python3

Gerrit and its plugins are build using Bazel. Since the exact version to use might differ between branches or can be updated by upstream at any point, one should install Bazelisk. It is a frontend to Bazel which automatically installs the needed Bazel version for the Gerrit branch you are working on. You will require the Go programming language in order to build it. The following will build Bazelisk 1.6.1 from source and copy the resulting binary in your user bin directory (~/.local/bin):

$ which go || sudo apt install golang-go
$ mkdir /tmp/bazelisk-build
$ (/tmp/bazelisk-build && go mod init . && go get github.com/bazelbuild/bazelisk@v1.6.1)
$ mkdir -p "$HOME"/.local/bin && cp /tmp/bazelisk-build/gopath/bin/bazelisk "$HOME"/.local/bin/bazelisk
$ rm -fR /tmp/bazelisk-build

Update our repository

Upgrade Gerrit core branch

Even if we deploy Gerrit core from the upstream released .war, we still need an up-to-date Gerrit copy in order to build our plugins.

1. Clone Gerrit and submodules from Wikimedia, add upstream as a remote:

   git clone https://gerrit.wikimedia.org/r/operations/software/gerrit
   cd gerrit
   git remote add upstream https://gerrit.googlesource.com/gerrit
   

2. Our repository HEAD points to the branch holding the material for the deployment deploy/wmf/stable-3.2. Checkout the stable-3.2 branch (as of November 2020) which is a copy of the upstream release we currently use:

   git checkout stable-3.2 origin/stable-3.2
   

3. Fetch the upstream branch and fast-forward our copy of their branch to the latest tag. Then push the stable-3.2 directly to Gerrit:

   git fetch --tags upstream stable-3.2
   git merge --ff-only v3.2.10
   git push --tags origin HEAD:stable-3.2
   

4. Checkout wmf/stable-3.2 and merge the latest tag, push the resulting SINGLE merge commit up for review:

   git checkout wmf/stable-3.2
   git merge v3.2.10
   

Update bundled submodules

Gerrit core comes with bundled plugins and a specific version of jgit which are registered as submodules. The .gitmodules file comes from upstream and uses relative urls. Since your workspace copy points to the Wikimedia Gerrit, the submodules would be fetched from our Gerrit which will would fail since the repositories do not exist. Instead we have to instruct git to rewrite the URLs to use upstream repositories. This can be done using the git configuration setting url.<base>.insteadOf = <our url>.

1. Ensure you are in our forked branch:

   git checkout wmf/stable-3.2
   # update as needed
   

2. Update git submodules from the upstream repository using:

   git -c url."https://gerrit.googlesource.com".insteadOf="$(dirname $(git config --get remote.origin.url))" submodule update --init
   

3. Push for review. At this point, you will likely be ahead of wmf/stable-3.2 by...quite a bit (hundreds of patches). This is all within a single merge commit though, so Be Bold — push up your changes:

   git commit --ammend --no-edit # to add Change-Id and Phabricator tracking bug to the merge commit
   git push origin HEAD:refs/for/wmf/stable-3.2
   

Fetch our additional plugins

As our Gerrit instance runs some plugins which are not part of Gerrit upstream set of plugins, we have those extra plugins registered as submodules in our branch. They will need to be updated to match the new Gerrit version. You will need ssh admin access to Gerrit to be able to list the installed plugins as well as jq (sudo apt install jq).

List our plugins:

$ ./wmf-plugins-list.sh 
plugins/go-import
plugins/healthcheck
plugins/its-base
plugins/its-phabricator
plugins/javamelody
plugins/lfs
plugins/metrics-reporter-jmx
plugins/metrics-reporter-prometheus
plugins/motd
plugins/reviewers
plugins/zuul
$

Most plugins come with a set of stable- branches, some support multiple versions and solely have a master branch. The proper branch to use for our extra plugins is indicated in .gitmodules , we thus just have to update them from the remote branch (git submodule update --remote plugins/foo). To update our plugins:

$ ./wmf-plugins-update.sh
Updating Wikimedia specific plugins
<the list of our plugins is shown here>
<git submodule update if relevant>
Done
$

Fix-up of gitiles plugin

TODO we should fork it.

The gitiles plugin per default fetches fonts directly from Google. Since that's a third party dependency that we do not want, we instead want gitiles to use the fonts that Gerrit itself offers.

To achieve that, make sure your gitiles code includes change I4f4a0b7dd575cbc27641063e05d13b8a43a51d8b. The change did not get much traction upstream, so it probably won't land there. We nonetheless want to include that change.

Once done updating our plugins submodules, git add them, update your commit and send it for review:

git add $(./wmf-plugins-list.sh)
git commit --amend
git push origin HEAD/refs/for/wmf/stable-3.2

CI will build Gerrit core as well as all the extra plugins, the resulting .war and .jar files are attached to the build.

Build

For Gerrit core and its bundled plugins, just use the upstream released .war. This instructions are left here for reference in case we have to build Gerrit ourselves at some point although the logic has been ported to a Jenkins job and CI will happily build Gerrit and the plugins for you.

Gerrit core

Upstream .war

The gerrit.war can be retrieved simply by running mvn package:

$ mvn package
...
[INFO] --- maven-dependency-plugin:2.8:copy (copy) @ gerrit ---
[INFO] Configured Artifact: com.google.gerrit:gerrit-war:3.2.7:war
[INFO] com.google.gerrit:gerrit-war:3.2.7:war already exists in /home/hashar/projects/operations/software/gerrit
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

That downloads the Gerrit war released by Google on Maven Central and replace the /gerrit.war at the root of the repository.

To update the Gerrit version, edit pom.xml and adjust the gerrit.version property:

  <properties>
    <gerrit.version>3.2.7</gerrit.version>
  </properties>

Then run mvn, add the result and craft the commit:

$ mvn package
...
$ git add pom.xml gerrit.war
$ git commit -m 'Update Gerrit to vX.Y.Z'

Build our own

As of Feb 2nd 2021 we no more build Gerrit ourselves, we instead use the upstream .war, see previous section. The build instructions are left there in case we have to build a fork.

Plugins

Most plugins come with build instructions usually available at src/main/resources/Documentation/build.md.

Since we use the upstream war, we do not need to build the plugins provided with Gerrit core. Instead we only build our extra plugins. wmf-plugins-list.sh can list our plugins:

$ ./wmf-plugins-list.sh 
plugins/go-import
plugins/healthcheck
plugins/its-base
plugins/its-phabricator
plugins/javamelody
plugins/lfs
plugins/metrics-reporter-jmx
plugins/metrics-reporter-prometheus
plugins/motd
plugins/reviewers
plugins/zuul
$

The whole build logic is implemented in the wmf-build.py script:

$ ./wmf-build.py
Building Wikimedia specific plugins

> Building go-import

...

Done building
Copying build artifacts
plugins-wmf/go-import.jar
plugins-wmf/healthcheck.jar
plugins-wmf/its-base.jar
plugins-wmf/its-phabricator.jar
plugins-wmf/javamelody.jar
plugins-wmf/lfs.jar
plugins-wmf/metrics-reporter-jmx.jar
plugins-wmf/metrics-reporter-prometheus.jar
plugins-wmf/motd.jar
plugins-wmf/reviewers.jar
plugins-wmf/zuul.jar

Those should be copied to the wmf/deploy branch
Done
$

Make sure to remove all content from ./plugins before copying the build artifacts.

Add a new plugin

In our wmf/stable-3.2 branch and the plugin upstream repository as a submodule. It should point to the current stable branch (stable-3.2) if supported, else master.

git submodule add -f -b stable-3.2 -- https://gerrit.googlesource.com/plugins/rename-project plugins/rename-project
git add .gitmodules plugins/rename-project
git commit -m 'Add rename-project plugin'

Then follow the instructions from the previous section to build it and add the resulting .jar to our deployment branch.

If we were to fork a plugin, the process is similar. The repository is forked on our Gerrit instance and then registered as a submodule pointing to our Gerrit.

Upload artifacts

After you have imported Gerrit releases.war from upstream and build the plugins (wmf-build.py), the artifacts have to be added to the deploy/wmf/stable-X branch. Since they are rather large, we use git-fat to offload the git repository and those artifacts have to be uploaded to our Archiva.

1. Set up git-fat: Archiva#Setting_up_git-fat_for_your_project
2. Initialization: git fat init
3. Checkout the deploy/wmf/stable-X branch that aligns with the build branch
4. Remove all the plugins in ./plugins: rm -f plugins/*.jar

If you have build locally:

1. Copy all the previously build plugin jars from ./plugins-wmf to ./plugins in the deploy branch

If you want to rely on CI:

1. Head to the last merged change and follow the link to the gerrit-docker job build
2. On the build page follow the Build artifacts link
3. Download a zip via (all files in zip)
4. Extract the archive: cd plugins && rm -f *.jar && unzip -o -j /path/to/archive.zip
5. Remove the release.war built by CI: rm plugins/release.war

1. Ensure Gerrit bundled plugins are not included since they will be provided by the releases.war
   1. rm plugins/its-base.jar

1. Commit the changes and upload to Gerrit
2. Run ./deploy_artifacts.py --version=3.2.10 gerrit.war plugins/foo.jar ... for the core application and all updated plugins (cf: Archiva, specifically setting up your ~/.m2/settings.xml

   Note: Alternatively, you can upload them by using the web UI, but that gets repetitive over a bunch of plugins hence why we wrote the above tool.

Deploying

1. SSH to the deployment master (ssh deployment.eqiad.wmnet)
2. Navigate to /srv/deployment/gerrit/gerrit
3. Fetch & checkout the appropriate deploy/wmf/stable-X branch
4. Deploy to gerrit2001 to ensure that there are no errors with git-fat et al
5. scap deploy -l gerrit2001.wikimedia.org 'Gerrit to [version] on gerrit2001'
6. Deploy to gerrit1001 scap deploy -l gerrit1001.wikimedia.org 'Gerrit to [version] on gerrit1001'
7. If you're only deploying plugins, you are done

When upgrading Gerrit releases.war to a new minor or major version, make sure to have taken in account upgrade steps that are mentioned in the upstream release notes.

Then on each server refresh the plugins from the .war and upgrade:

1. sudo service gerrit stop
2. sudo -u gerrit2 java -jar /var/lib/gerrit2/review_site/bin/gerrit.war init --install-all-plugins
3. sudo -u gerrit2 git checkout '/var/lib/gerrit2/review_site/plugins/*.jar'
4. sudo service gerrit start