View source for Heterogeneous deployment/Train deploys

[[File:MTR_CSR_Sifang_EMU_in_Shek_Kong_Stabling_Sidings_201710.jpg|thumb|500x500px|Bring new code in a fast, safe and efficient way!]]
{{Navigation MediaWiki deployment}}
== Pairing on the Train  ==

As of October 2019, there are two people assigned to each week's train:  One as primary, and one as backup.  These are rough guidelines for sharing the work, and should be improved as we learn more.

* On Monday, communicate with your partner and establish how you'll collaborate over the course of the week.
** Updates on IRC while your partner is working and updates on the train blocker ticket if they're offline seems to be a useful pattern.
** Liberal use of video chat for pairing on hard problems is encouraged.
** It seems to work well to have the primary do the work of cutting the branch, syncing wikis, etc., while the backup keeps an eye on logs, works on improvements to deploy tooling, and is generally an extra pair of eyes for the whole process.
** If you are in doubt about any part of the process and it's during your partner's working hours, consult them first and get their help in resolving your questions.
* If one member of the pair is in the European window and one is in the American window, both train deployment windows should be reserved on the [[Deployments]] calendar.  This gives a backup deployer a defined window for moving the train forward outside the primary's working hours, if it becomes necessary.
* If the train is blocked or there are any other issues, communicate the transfer of responsibility on the train blocker ticket by assigning it to the responsible party and leaving a note.

== Initial setup==

SSH into '''deploy1002.eqiad.wmnet''' and run
<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:~$ git clone https://gerrit.wikimedia.org/r/mediawiki/tools/release
</syntaxhighlight>

==Breakage==

There will be times when this process does not go smoothly. There are [[Deployments/Holding_the_train|guidelines]] for what do to when that happens.

In general, '''if there is an unexplained error that occurs within 1 hour of a train deployment — always roll back the train'''. Rolling back the train to eliminate it as the cause of unexplained breakage can be especially important if there are many ongoing possible causes for issues as this helps to eliminate one of those causes as the source of problems.

===Rollback===

To rollback a wikiversion change, it should be pretty quick. Go ahead and rollback production before you send patches up to gerrit since waiting on Jenkins may take a while:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1001:/srv/mediawiki-staging$ git revert $(git log -1 --format=%H -- wikiversions.json)
USERNAME@deploy1001:/srv/mediawiki-staging$ scap sync-wikiversions 'Revert "group[0|1] wikis to [VERSION]"'
USERNAME@deploy1001:/srv/mediawiki-staging$ # Now that you've synced the revert, push patches up to gerrit, you have to run git commit --amend to get the changeid
USERNAME@deploy1001:/srv/mediawiki-staging$ git commit --amend
USERNAME@deploy1001:/srv/mediawiki-staging$ git push origin HEAD:refs/for/master%topic=[VERSION],l=Code-Review+2
</syntaxhighlight>

Example:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1001:/srv/mediawiki-staging$ git push origin HEAD:refs/for/master%topic=1.34.0-wmf.0,l=Code-Review+2
</syntaxhighlight>

*Wait for the patch to merge and the fetch back down to the deployment server

*[[#Update roadmap]].

===Places to Watch for Breakage===

Train deployers should check for breakage as they are rolling out the train as they are effectively the first line of defense for train deploys. Some of the places to watch for breakage:

*IRC
**Primary channel is {{irc|wikimedia-operations}}
**Useful channels are {{irc|mediawiki-core}} {{irc|wikimedia-dev}}
**For more channels see [[mw:MediaWiki_on_IRC|MediaWiki on IRC]] and [[metawiki:IRC/Channels|IRC/Channels]]
*Logs
**[[mwlog1001]]:
***[[Wikimedia_binaries#logspam-watch|logspam-watch]]
*** logfiles in <code>/srv/mw-log</code>
**[https://logstash.wikimedia.org/app/kibana#/dashboard/mediawiki-errors Logstash MediaWiki Errors]
**Logstash "mediawiki-new-errors" dashboard (linked from logstash front page)
***[https://logstash.wikimedia.org/app/kibana#/dashboard/dfcf7b70-1aaa-11e9-b4bc-db12fe15ab31 Showing only timeout errors] (see T204871)
**Group-specific Logstash Dashboards:
***[https://logstash.wikimedia.org/app/kibana#/dashboard/group0 group0]
***[https://logstash.wikimedia.org/app/kibana#/dashboard/group1 group1]
**See the [[phab:tag/wikimedia-production-error/|Wikimedia-production-error workboard]] for known issues
**Logstash [https://logstash.wikimedia.org/app/dashboards#/view/AXDBY8Qhh3Uj6x1zCF56 mw-client-errors] dashboard
***New errors appearing more than 1000 times in a 12 hour period should be considered blockers
***See also [https://grafana.wikimedia.org/d/000000566/overview?viewPanel=16&orgId=1 Grafana dashboard] with summary of average error rate over time
*[https://grafana.wikimedia.org/ Grafana]
**[https://grafana.wikimedia.org/dashboard/db/varnish-http-errors?refresh=5m&orgId=1 Varnish error-rate dashboard] (HTTP 5XX % should have 3+ 0s after the decimal point, e.g. 0.0001%)
**[https://grafana.wikimedia.org/d/000000612/frontend-responses-nginx-vs-varnish?orgId=1&from=now-15m&to=now Frontend Responses NGINX vs Varnish]
**[https://grafana.wikimedia.org/d/000000102/production-logging Production Logging]
**[https://grafana.wikimedia.org/d/000000566/overview?panelId=15&fullscreen&orgId=1&from=now-7d&to=now Minerva Client Errors] - Browser JS errors count (only wikipedias on mobile)
**[https://grafana.wikimedia.org/d/RIA1lzDZk/application-servers-red-dashboard?orgId=1&from=now-1h&to=now&refresh=30s Application Servers RED Dashboard]

===If the train is blocked===

*A task will be assigned to you, for example [[phab:T191059|T191059]] (1.32.0-wmf.13 deployment blockers) (you can see that week's task at https://train-blockers.toolforge.org)
*Any open subtasks block the train from moving forward. This means no further deployments until the blockers are resolved.

'''Checklist'''

If there are blocking tasks, please do the following:

* Make sure all tasks blocking train are set to <code>UBN!</code> priority in phabricator
*Comment on the task asking for an ETA or if this can be solved by reverting a recent commit.
*Send e-mail to:
**[[mail:ops|ops@lists.wikimedia.org]]
**[[mail:wikitech-l|wikitech-l@lists.wikimedia.org]]
** Ping private [https://app.slack.com/client/T024KLHS4/C01R06P8D1B/ #engineering-all Slack channel]
**Subject: <code>[Train] {version} status update</code>
**Body<syntaxhighlight lang="text">The {version} version of MediaWiki is blocked[0].

The new version is deployed to {group(s){0,1,2}}[1], but can proceed no
further until these issues are resolved:

* {Phab task name} - {phab task link}

Once these issues are resolved train can resume. If these issues are
resolved on a Friday the train will resume Monday.

Thank you for your help resolving these issues!

-- Your humble train toiler

[0]. <{link to phab task for train}>
[1]. <https://versions.toolforge.org/></syntaxhighlight>
*Add relevant people (see [[mw:Developers/Maintainers|Developers/Maintainers]]) to the blocking task
*Ping relevant people in IRC
*Once train is unblocked be sure to thank the folks who helped unblock it

==Weekly steps==

=== Monday: Sync up with your deployment partner===

See the [[#Pairing on the Train|train pairing]] section above.

===Tuesday: New branch creation and deploy===
====Before the deploy window====

Depending on how practiced you are and where you choose to run commands (full clones of mediawiki-core from outside the cluster can take a while), the steps will typically take 45 to 90 minutes.

; Short-form instructions
{| class="wikitable"
! colspan="2" |Step
!host
! command
!example
|-
| P-0
|'''Verify branch cut job worked'''
|Your laptop
| colspan="2" |The branch cut runs in a periodic jenkins job that runs on Tuesdays at 02:00 UTC on the releases-jenkins instance. Navigate to [[gerrit:#/q/owner:%22TrainBranchBot+%253Cmmodell%252Btrainbranchbot%2540wikimedia.org%253E%22|gerrit]] to find the branch commit that the job created. There is now automation to CR+2 the change in Gerrit automatically.

If there are no open commits shown in gerrit using the link above, you can troubleshoot via the [https://releases-jenkins.wikimedia.org/job/Automatic%20branch%20cut/ releases-jenkins job].
<br>
This will also build and post the changelog for you.
|-
|P-1
|'''Note the MW core commit from which you've just created the branch'''
|IRC
(<code>#wikimedia-operations)</code>
|<syntaxhighlight lang="irc">
!log [VERSION] was branched at [BRANCH POINT] for [TASK]
</syntaxhighlight>
|<syntaxhighlight lang="irc">
!log 1.35.0-wmf.14 was branched at fb16374c5bdb9d14729f358fb81638fc91640b4f for T233862
</syntaxhighlight>
|-
|P-2
|'''Merge the branch commit'''
|Gerrit ([[gerrit:c/mediawiki/core/+/595915|example]])
| colspan="2" |C+2 on the patch.  It takes about 25 minutes for the branch to be tested and merged.
|-
|P-3
|'''Enter screen (or tmux if you prefer)'''


Note<ref>If you need to leave in the middle you can do <code>ctrl-a d</code> to detach and <code>screen -r train</code> to attach.</ref>
|'''deploy1002.eqiad.wmnet'''
| colspan="2" |<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:~$ screen -D -RR train
</syntaxhighlight>
|-
|P-4
|'''Set local ssh-agent in session'''
|deploy1002
| colspan="2" |<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:~$ eval $(ssh-agent)
USERNAME@deploy1002:~$ ssh-add .ssh/id_ed25519
</syntaxhighlight>
|-
|P-5
|'''Clone new branch in production''' (once the branch commit from P-2 has landed)
|deploy1002
|<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ scap prep [VERSION]
</syntaxhighlight>
|<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ scap prep 1.34.0-wmf.0
</syntaxhighlight>
|-
|P-6
|'''Apply security patches'''
|deploy1002
| colspan="2" |<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ scap apply-patches --train [VERSION]
</syntaxhighlight>

* See https://phabricator.wikimedia.org/T276237 for information about currently deploy security patches.
* If a patch fails to apply, investigate whether it's due to a conflict (<code>git status</code>) or the patch having been merged since the new branch cut (search <code>git log</code> for the commit, etc.). If it turns out to be the latter, remove the patch file from the <code>/srv/patches/[VERSION]</code> directory.
*If you need extra help, contact Security Team ([[foundationsite:role/staff-contractors/|Wikimedia Foundation]], [[Wikimedia Security Team|MediaWiki]], [https://office.wikimedia.org/wiki/Contact_list#Security Office Wiki]), currently {{ircnick|bawolff|Brian}} and {{ircnick|Reedy|Sam}} in IRC.
|-
|P-7
|'''Create and auto-merge/deploy the testwikis patch'''


🐌 Note: this step takes about 40 minutes.
|deploy1002
| colspan="2" |<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ ~/release/bin/deploy-promote testwikis [VERSION]
Promote testwikis from [PREVIOUS-VERSION] to [VERSION] [y/N]
Now wait for jenkins to merge the patch, then press enter to continue with git pull && scap sync-wikiversions
</syntaxhighlight>
|-
|P-8
|'''Verify version change on [[testwiki:Special:Version|testwiki]]'''
|[[testwiki:Special:Version|testwiki]]
| colspan="2" |Verify version change on [[testwiki:Special:Version|testwiki]] (Installed software, Product: MediaWiki, Version: [VERSION]) and l10n cache ([[testwiki:Special:Version|Special:Version]] should not look like [https://test.wikipedia.org/wiki/Special:Version?uselang=qqx Special:Version?uselang=qqx]).<br>This is done automatically by the deploy script, but is worth verifying manually.
|-
|P-9
|'''Decide what old stuff to prune'''
|deploy1002
| colspan="2" |<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ find . -mindepth 2 -maxdepth 2 -type f -path './php-*/README.md' -ctime +7 -exec dirname {} \;
</syntaxhighlight>
|-
|P-10
|'''Clean up old stuff'''

🐌 Note: this step runs a scap sync of the directory, and can take 30 minutes.
|deploy1002
|<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ scap clean --delete [some old version from find -ctime +7 output above]
</syntaxhighlight>
|<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ scap clean --delete 1.34.0-wmf.0
</syntaxhighlight>
|-
! colspan="5" |'''Wait for the deploy window'''
|}

;Full instructions
<div class="mw-collapsible mw-collapsed" style="margin:1em; border: 1px dashed grey; padding: 2em 1em;">
=====Setup=====

The script to cut a branch is run on your local machine (as of Jan 2020).

'''Local <code>.netrc</code> setup'''

Create a .netrc file in your home directory with the following content.

<syntaxhighlight lang="shell-session">
you@yourlaptop:~$ vim .netrc
machine gerrit.wikimedia.org login [USERNAME] password [PASSWORD]
</syntaxhighlight>

Username and password can obtained from Gerrit:

*In the new UI go to [[gerrit:settings/#HTTPCredentials|HTTP Credentials]], copy Username and click Generate new password to generate new password.
*In the old UI, go to [[gerrit:#/settings/http-password|HTTP Password]], copy Username and click Generate Password to generate new password.

{{note|type=error|Generated password in both cases is different from your Gerrit password.}}

Make sure .netrc file is only readable by you.

<syntaxhighlight lang="shell-session">
you@yourlaptop:~$ chmod go-rwx .netrc
</syntaxhighlight>

'''Clone or update <code>mediawiki/tools/release</code>.'''

<syntaxhighlight lang="shell-session">
USERNAME@yourlaptop:~$ git clone https://gerrit.wikimedia.org/r/mediawiki/tools/release
</syntaxhighlight>

To run branch.py you need to have the pygerrit2 library installed for Python3. In Debian 10 (buster), the python3-pygerrit2 package works.

=====Create the new branch in Gerrit=====

<syntaxhighlight lang="shell-session">
you@yourlaptop:~/release/make-release/ $ ./branch.py --core --core-bundle wmf_core --bundle wmf_branch --branchpoint HEAD --core-version [VERSION] [WMF BRANCH]
</syntaxhighlight>

<syntaxhighlight lang="shell-session">
you@yourlaptop:~/release/make-release/ $ ./branch.py --core --core-bundle wmf_core --bundle wmf_branch --branchpoint HEAD --core-version 1.34.0-wmf.0 wmf/1.34.0-wmf.0
</syntaxhighlight>

In {{irc|wikimedia-operations}}, drop a quick log note that you've kicked off the branch process so that others know it's underway, ''e.g.'':

<syntaxhighlight lang="irc">
!log 1.35.0-wmf.14 was branched at fb16374c5bdb9d14729f358fb81638fc91640b4f for T233862
</syntaxhighlight>

The script will create a release patch, [[gerrit:c/mediawiki/core/+/564687|like this one]], under your gerrit account. You must C+2 this, and wait for it to merge, to proceed.

=====tmux or screen =====

Now that the branch has been cut on your local machine, the remainder of the work will be done on the deployment host: '''deploy1002.eqiad.wmnet'''

Some scripts run for 10-60 minutes so consider using tmux or screen.

If you prefer tmux:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:~$ tmux new -s train
...
USERNAME@deploy1002:~$ exit
</syntaxhighlight>

If you need to leave in the middle you can do <code>ctrl-b d</code> to detach and <code>tmux a -t train</code> to attach.

If you prefer screen:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:~$ screen -D -RR train
...
USERNAME@deploy1002:~$ exit
</syntaxhighlight>

If you need to leave in the middle you can do <code>ctrl-a d</code> to detach and <code>screen -r train</code> to attach.

In either the tmux or the screen session, you'll want to start an ssh-agent and load your local key there:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:~$ eval $(ssh-agent)
USERNAME@deploy1002:~$ ssh-add .ssh/id_ed25519
</syntaxhighlight>

=====Clone new branch=====
This command will create a new <code>/srv/mediawiki-staging/php-[VERSION]</code> directory:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ scap prep [VERSION]
</syntaxhighlight>

Example:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ scap prep 1.34.0-wmf.0
</syntaxhighlight>

This should only take a couple of minutes.

=====Apply security patches=====

*Patches should be named sequentially in the order that they will cleanly apply (e.g. <code>01-T[NUMBER].patch</code>, <code>02-T[NUMBER].patch</code>)
*Check and apply each patch in both <code>/srv/patches/[VERSION]/core</code> and <code>/srv/patches/[VERSION]/extensions/[NAME]</code> to the new core checkout and extensions, respectively.

Check existing patches:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:~$ tree /srv/patches/[VERSION]
/srv/patches/[VERSION]
├── core
│   ├── 01-T[NUMBER].patch
│   └── 02-T[NUMBER].patch
└── extensions
    └── [EXTENSION]
        ├── 01-T[NUMBER].patch
        └── 02-T[NUMBER].patch
</syntaxhighlight>

======Core======

*You can check a core patch to see if it will apply cleanly with

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/php-[VERSION]$ git apply --check --3way /srv/patches/[VERSION]/core/[NUMBER]-T[NUMBER].patch
</syntaxhighlight>

*If the patch checks out, apply and commit it with

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/php-[VERSION]$ git am --3way /srv/patches/[VERSION]/core/[NUMBER]-T[NUMBER].patch
</syntaxhighlight>

======Extension======

*For an extension:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/php-[VERSION]/extensions/[EXTENSION]$ git apply --check --3way /srv/patches/[VERSION]/extensions/[EXTENSION]/[NUMBER]-T[NUMBER].patch

USERNAME@deploy1002:/srv/mediawiki-staging/php-[VERSION]/extensions/[EXTENSION]$ git am --3way /srv/patches/[VERSION]/extensions/[EXTENSION]/[NUMBER]-T[NUMBER].patch
</syntaxhighlight>

*If the patch fails to apply, investigate whether it's due to a conflict (<code>git status</code>) or the patch having been merged since the new branch cut (search <code>git log</code> for the commit, etc.). If it turns out to be the latter, remove the patch file from the <code>/srv/patches/[VERSION]</code> directory.
*If you need extra help, contact Security Team ([[foundationsite:role/staff-contractors/|Wikimedia Foundation]], [[mw:Wikimedia_Security_Team|MediaWiki]], [https://office.wikimedia.org/wiki/Contact_list#Security Office Wiki]), currently {{ircnick|bawolff|Brian}} and {{ircnick|Reedy|Sam}} in IRC.

=====Create patches to update wikiversions.json=====

Create group0 to [VERSION] patch:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ scap update-wikiversions group0 [VERSION]
USERNAME@deploy1002:/srv/mediawiki-staging/$ git add wikiversions.json
USERNAME@deploy1002:/srv/mediawiki-staging/$ git commit -m "Group0 to [VERSION]"
</syntaxhighlight>

Example:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ scap update-wikiversions group0 1.34.0-wmf.0
USERNAME@deploy1002:/srv/mediawiki-staging/$ git add wikiversions.json
USERNAME@deploy1002:/srv/mediawiki-staging/$ git commit -m "Group0 to 1.34.0-wmf.0"
</syntaxhighlight>

=====Send staged patches to Gerrit for review=====

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ git push origin HEAD:refs/for/master/[VERSION]
</syntaxhighlight>

Example:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ git push origin HEAD:refs/for/master/1.34.0-wmf.0
</syntaxhighlight>

=====Discard changes to working directory and index=====

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ git reset --hard origin/master
</syntaxhighlight>

=====Clean up old stuff=====

[[mw:MediaWiki 1.34/Roadmap]] is a good place to find when a branch was created.

List all branches:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ find . -maxdepth 1 -type d -name 'php-*' -print
</syntaxhighlight>

Find old branches, more than 7 days old:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ find . -mindepth 2 -maxdepth 2 -type f -path './php-*/README.md' -ctime +7 -exec dirname {} \;
</syntaxhighlight>

For all branches more than 7 days old, drop everything with:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ scap clean --delete [some old version from find -ctime +7 output above]
</syntaxhighlight>

Example:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ scap clean --delete 1.34.0-wmf.0
</syntaxhighlight>

Active branches are visible at [https://versions.toolforge.org/ Wikimedia MediaWiki versions] page.

'''Deleting a branch is a full sync of that directory, and can take 10-15 minutes each.'''

=====Sync to cluster and verify on testwiki =====

*Edit <code>/srv/mediawiki-staging/wikiversions.json</code> and set <code>testwiki</code> to <code>php-[VERSION]</code>
* Do not commit and push to Gerrit, only make this change locally on the deployment server

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ vim wikiversions.json
</syntaxhighlight>

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ git diff
...
-    "testwiki": "php-[VERSION-1]",
+    "testwiki": "php-[VERSION]",
...
</syntaxhighlight>

* Run [[scap]] to (re)build localization caches and sync changes across the cluster.
*🐌 Note: this step may take on the order of 70-80 minutes.
* 🐌 Note: If scap seems to hang during the scap-cdb-rebuild phase of this process, you may need to try [[phab:T223287|pressing enter to speed it up]].

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ scap sync "testwiki to php-[VERSION] and rebuild l10n cache"
</syntaxhighlight>

Example:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ scap sync "testwiki to php-1.34.0-wmf.0 and rebuild l10n cache"
</syntaxhighlight>

*Verify version change on [[testwiki:Special:Version|testwiki]] (Installed software, Product: MediaWiki, Version: [VERSION]) and l10n cache ([[testwiki:Special:Version|Special:Version]] should not look like [https://test.wikipedia.org/wiki/Special:Version?uselang=qqx Special:Version?uselang=qqx])

This can take well over an hour. Opening or reloading the version page on testwiki after the scap sync command can take a minute or two.

*Revert local changes

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ git checkout -- wikiversions.json
</syntaxhighlight>

=====Update deploy notes=====

There is a script in the  [[gerrit:mediawiki/tools/release|<code>mediawiki/tools/release</code>]] repo called <code>makedeploynotes.py</code>. It queries gerrit's gitiles to make release notes. Usage: <code>makedeploynotes.py <old-version> <new-version></code>

<pre>
$ python3 make-deploy-notes/makedeploynotes.py 1.35.0-wmf.24 1.35.0-wmf.25 | tee deploy-notes-1.35.0-wmf.25
</pre>

From there you can copy-and-paste to the Changelog page on mediawiki.org; e.g., <code><nowiki>https://www.mediawiki.org/wiki/MediaWiki_[VERSION]/Changelog</nowiki></code>. Example: [[mw:MediaWiki_1.35/wmf.24/Changelog|MediaWiki 1.35/wmf.24/Changelog]]

=====Wait for deploy window=====
All of the changes above can be done at any time prior to the actual deployment window.
</div>

====During the deploy window====

;Short-form instructions
{| class="wikitable"
! colspan="2" |Step
!host
!command
!example
|-
|0-0
|'''Create and auto-merge/deploy the group0 patch'''
|deploy1002
| colspan="2" |<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging/$ ~/release/bin/deploy-promote group0
Promote group0 from [PREVIOUS-VERSION] to [VERSION] [y/N]
Now wait for jenkins to merge the patch, then press enter to continue with git pull && scap sync-wikiversions
</syntaxhighlight>
|-
|0-1
|'''Verify production has indeed switched'''
|[[mw:Special:Version|MediaWiki.org]]
| colspan="2" |Verify that [[mw:Special:Version|mediawikiwiki]] has switched to the new version (Installed software, Product: MediaWiki, Version: VERSION)
|-
| 0-2
|'''Monitor production logs'''
|logstash ''etc.''
| colspan="2" |Monitor irc and [[logstash]] and/or [[Wikimedia binaries#logspam-watch|logspam-watch]] for problems, see [[#Places to Watch for Breakage]]
|-
|0-3
|'''Update roadmap page'''
|[[mw:MediaWiki 1.36/Roadmap]]
|Change the <code>Deployed to group</code> (if you're using VisualEditor) or the 3rd parameter of the <code>WMFReleaseTableRow</code> template (if you're using the wikitext editor) to <code>0</code> (deployed to group0)
|<syntaxhighlight lang="text">
{{WMFReleaseTableHead}}
{{WMFReleaseTableRow|12|2018-07-10|0}}
</syntaxhighlight>
|-
|0-4
|'''Kill ssh-agent'''
|deployment server
| colspan="2" |<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:~$ pgrep -u "$USER" -laf ssh-agent # list all of your ssh-agent processes
USERNAME@deploy1002:~$ pkill -u "$USER" -f ssh-agent   # kill all your ssh-agent processes
USERNAME@deploy1002:~$ pgrep -u "$USER" -laf ssh-agent # did they all die?</syntaxhighlight>
|}

;Full instructions
<div class="mw-collapsible mw-collapsed" style="margin:1em; border: 1px dashed grey; padding: 2em 1em;">
=====Switch group0 wikis to [VERSION] =====

*CR+2 <code>group0 to [VERSION]</code> patch in Gerrit that you submitted earlier
* Wait for Gerrit/Zuul/Jenkins to merge the patch(es)
*Pull patch(es) to deployment server

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ git fetch
</syntaxhighlight>

*Check diff to ensure it is what you expect (this should show a bunch of version changes in wikiversions.json for group0 wikis)

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ git diff HEAD..origin/master
</syntaxhighlight>

*Apply changes

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ git rebase origin/master
</syntaxhighlight>

*Sync the change across the cluster

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ scap sync-wikiversions "group0 to [VERSION]"
</syntaxhighlight>

Example:

<syntaxhighlight lang="shell-session">
USERNAME@deploy1002:/srv/mediawiki-staging$ scap sync-wikiversions "group0 to 1.34.0-wmf.0"
</syntaxhighlight>

*Verify that [[:mw:Special:Version|mediawikiwiki]] switched to the new version (Installed software, Product: MediaWiki, Version: VERSION)
*Monitor irc and [[logstash]] and/or [[Wikimedia_binaries#logspam-watch|logspam-watch]] for problems, see [[#Places to Watch for Breakage]]

=====Update roadmap=====

*Change the <code>Deployed to group</code> (if you're using VisualEditor) or the 3rd parameter of the <code>WMFReleaseTableRow</code> template (if you're using the wikitext editor) to <code>0</code> (deployed to group0) at [[mw:MediaWiki 1.35/Roadmap]].

For wikitext editor, change

<syntaxhighlight lang="text">
{{WMFReleaseTableHead}}
{{WMFReleaseTableRow|[VERSION]|[DATE]|}}
...
{{WMFReleaseTableFooter}}
</syntaxhighlight>

to

<syntaxhighlight lang="text">
{{WMFReleaseTableHead}}
{{WMFReleaseTableRow|[VERSION]|[DATE]|0}}
...
{{WMFReleaseTableFooter}}
</syntaxhighlight>

Example:

<syntaxhighlight lang="text">
{{WMFReleaseTableHead}}
{{WMFReleaseTableRow|12|2018-07-10|0}}
...
{{WMFReleaseTableFooter}}
</syntaxhighlight>

=====Terminate ssh-agents =====

Terminate the ssh-agent you started earlier so it doesn't linger on after you log out:

<syntaxhighlight lang="shell-session">
pgrep -u "$USER" -laf ssh-agent # list all of your ssh-agent processes
pkill -u "$USER" -f ssh-agent   # kill all your ssh-agent processes
pgrep -u "$USER" -laf ssh-agent # did they all die?
</syntaxhighlight>

Every other day of the train you need to start a new ssh-agent and kill it later.
</div>

===Wednesday: group0 to group1 deploy===

;Meta / coordination
Attend the Train Log Triage meeting with members of the Core Platform Team and others.

;Short-form instructions
{| class="wikitable"
! colspan="2" |Step
!host
!command
!example
|-
|1-0
|'''Create and auto-merge/deploy the group1 patch'''
|deploy1001
| colspan="2" |<syntaxhighlight lang="shell-session">
USERNAME@deploy1001:/srv/mediawiki-staging/$ ~/release/bin/deploy-promote
Promote group1 from [PREVIOUS-VERSION] to [VERSION] [y/N]
Now wait for jenkins to merge the patch, then press enter to continue with git pull && scap sync-wikiversions
</syntaxhighlight>
|-
| 1-1
|'''Verify production has indeed switched'''
|[[wikt:Special:Version|English Wiktionary]]
| colspan="2" |Verify that [[wikt:Special:Version|the English Wiktionary]] (and other group1 wikis) have switched to the new version (Installed software, Product: MediaWiki, Version: VERSION)
|-
| 1-2
|'''Monitor production logs'''
|logstash ''etc.''
| colspan="2" |Monitor irc and [[logstash]] and/or [[Wikimedia binaries#logspam-watch|logspam-watch]] for problems, see [[#Places to Watch for Breakage]]
|-
|1-3
|'''Update roadmap page'''
|[[mw:MediaWiki 1.36/Roadmap]]
|Change the <code>Deployed to group</code> (if you're using VisualEditor) or the 3rd parameter of the <code>WMFReleaseTableRow</code> template (if you're using the wikitext editor) to <code>1</code> (deployed to group1)
|<syntaxhighlight lang="text">
{{WMFReleaseTableHead}}
{{WMFReleaseTableRow|12|2018-07-10|1}}
...
{{WMFReleaseTableFooter}}
</syntaxhighlight>
|}

;Full instructions
<div class="mw-collapsible mw-collapsed" style="margin:1em; border: 1px dashed grey; padding: 2em 1em;">
=====Switch group1 wikis to [VERSION]=====

Use the <code>release/bin/deploy-promote</code> script to update <code>wikiversions.json</code>

<syntaxhighlight lang="shell-session">
USERNAME@deploy1001:~$ ./release/bin/deploy-promote
Promote group1 from [PREVIOUS-VERSION] to [VERSION] [y/N]
</syntaxhighlight>

The script automatically Code-Review +2 the patch in Gerrit. Once CI has merged the patch, hit enter at the 2nd prompt.

<syntaxhighlight lang="shell-session">
Now wait for jenkins to merge the patch, then press enter to continue with git pull && scap sync-wikiversions
</syntaxhighlight>

After the script run is complete, group1 wikis should be running [VERSION].

The above should take about five minutes, including the waiting time for Gerrit/CI.

=====Update roadmap=====

*Change the <code>Deployed to group</code> (if you're using VisualEditor) or the 3rd parameter of the <code>WMFReleaseTableRow</code> template (if you're using the wikitext editor) to <code>1</code> (deployed to group1) at [[mw:MediaWiki 1.35/Roadmap]].

For wikitext editor, change

<syntaxhighlight lang="text">
{{WMFReleaseTableRow|[VERSION]|[DATE]|0}}
</syntaxhighlight>

to

<syntaxhighlight lang="text">
{{WMFReleaseTableRow|[VERSION]|[DATE]|1}}
</syntaxhighlight>

Example:

<syntaxhighlight lang="text">
{{WMFReleaseTableRow|12|2018-07-10|1}}
</syntaxhighlight>
</div>

===Thursday: group{0,1} to all deploy===
;Short-form instructions
{| class="wikitable"
!
!Step
!host
!command
!example
|-
|2-0
|'''Create and auto-merge/deploy the group2 patch'''
|deploy1001
| colspan="2" |<syntaxhighlight lang="shell-session">
USERNAME@deploy1001:/srv/mediawiki-staging/$ ~/release/bin/deploy-promote all
Promote all from [PREVIOUS-VERSION] to [VERSION] [y/N]
Now wait for jenkins to merge the patch, then press enter to continue with git pull && scap sync-wikiversions
</syntaxhighlight>
|-
|2-1
|'''Verify production has indeed switched'''
|[[w:Special:Version|English Wikipedia]]
| colspan="2" |Verify that [[w:Special:Version|the English Wikipedia]] (and other group2 wikis) have switched to the new version (Installed software, Product: MediaWiki, Version: VERSION)
|-
| 2-2
|'''Monitor production logs'''
|logstash ''etc.''
| colspan="2" |Monitor irc and [[logstash]] and/or [[Wikimedia binaries#logspam-watch|logspam-watch]] for problems, see [[#Places to Watch for Breakage]]
|-
|2-3
|'''Update roadmap page'''
|[[mw:MediaWiki 1.36/Roadmap]]
|Change the <code>Deployed to group</code> (if you're using VisualEditor) or the 3rd parameter of the <code>WMFReleaseTableRow</code> template (if you're using the wikitext editor) to <code>2</code> (deployed to all)
|<syntaxhighlight lang="text">
{{WMFReleaseTableHead}}
{{WMFReleaseTableRow|12|2018-07-10|2}}
...
{{WMFReleaseTableFooter}}
</syntaxhighlight>
|}

;Full instructions
<div class="mw-collapsible mw-collapsed" style="margin:1em; border: 1px dashed grey; padding: 2em 1em;">

=====Switch all wikis to [VERSION]=====

Thursday deploy is very similar to the Wednesday deploy, the only difference in terms of procedure is the target group

Use the <code>release/bin/deploy-promote all</code> script to update <code>wikiversions.json</code>

<syntaxhighlight lang="shell-session">
USERNAME@deploy1001:~$ ./release/bin/deploy-promote all
Promote all from [PREVIOUS-VERSION] to [VERSION] [y/N]
</syntaxhighlight>

The script automatically Code-Review +2 the patch in Gerrit. Once CI has merged the patch, hit enter at the 2nd prompt.

<syntaxhighlight lang="shell-session">
Now wait for jenkins to merge the patch, then press enter to continue with git pull && scap sync-wikiversions
</syntaxhighlight>

After the script run is complete, '''all wikis''' should be running [VERSION].

=====Update roadmap=====

*Change the <code>Deployed to group</code> (if you're using VisualEditor) or the 3rd parameter of the <code>WMFReleaseTableRow</code> template (if you're using the wikitext editor) to <code>2</code> (deployed to all wikis) at [[mw:MediaWiki 1.35/Roadmap]].

For wikitext editor, change

<syntaxhighlight lang="text">
{{WMFReleaseTableRow|[VERSION]|[DATE]|1}}
</syntaxhighlight>

to

<syntaxhighlight lang="text">
{{WMFReleaseTableRow|[VERSION]|[DATE]|2}}
</syntaxhighlight>

Example:

<syntaxhighlight lang="text">
{{WMFReleaseTableRow|12|2018-07-10|2}}
</syntaxhighlight>
</div>

==Incident documentation==

*If there were problems during the train, follow instructions at [[Incident documentation]] on incident reports and post-mortem review.
*Use <code>Create report</code> form to create a new page, <code>train-[VERSION]</code>. Example: [[Incident documentation/20181212-Train-1.33.0-wmf.8]].
*For Timeline section, events from [https://sal.toolforge.org/production SAL] and Phabricator task are a good start.

== See also ==
*For information about the current status of the versions deployed to the various wikis, see https://versions.toolforge.org/

==Footnotes==
<references />

[[Category:How-To]]
[[Category:Deployment]]