You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Application servers: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>Dzahn
imported>Krinkle
No edit summary
 
(10 intermediate revisions by 8 users not shown)
Line 1: Line 1:
The '''Application servers''' (or '''app servers''') are the several hundred Apache servers that run the [[MediaWiki]] backend software (written in PHP).
{{Navigation Wikimedia infrastructure|expand=mw}}
{{See|See also '''[[Application servers/Runbook]]''' for how to perform common tasks, or diagnose issues.}}


The Apache configurations are maintained in the Puppet repository, at [https://github.com/wikimedia/operations-puppet/tree/production/modules/mediawiki/files/apache/sites operations/puppet.git:/modules/mediawiki/files/apache/sites/]. Prior to 2012, these were in Subversion.
The '''Application servers''' (or '''app servers''') are the several hundred Apache servers that run [[MediaWiki]] (PHP application).


:''See also '''[[Application servers/Runbook]]''' which covers php-fpm, opcache and more.'' (TODO: Should these pages be merged?)
==Service==
{{TOC|align=right}}
Puppet roles:
==Testing config==
* <code>mediawiki::appserver</code>, <code>mediawiki::canary_appserver</code>
* Submit change to [[Gerrit]] in the <code>modules/mediawiki/files/apache/sites</code> directory (project: operations/puppet)
* <code>mediawiki::appserver::api</code>, <code>mediawiki::appserver::canary_api</code>
*Choose [[X-Wikimedia-Debug#Available_backends|one of the mediawiki debug servers]]. Then, on that server:
* <code>mediawiki::maintenance</code>
**Disable puppet: <code>sudo puppet agent --disable 'insert reason'</code>
* <code>mediawiki::jobrunner</code>
** Apply change locally under <code>/etc/apache2/sites-enabled/</code>
**<code>sudo apache2ctl restart</code>
* Test your change by making relevant HTTP request. See [[Debugging in production#Debugging a web request|Debugging in production]] for how.
* When you're done, <code>mwdebug####$ sudo puppet agent --enable</code>


==Deploying config==
Relevant puppet classes:
It is suggested that you may wish to place any configuration updates on the [[Deployments]] page. A bad configuration going live can easily result in a site outage.
* <code>[https://gerrit.wikimedia.org/g/operations/puppet/+/HEAD/modules/profile/manifests/mediawiki/webserver.pp profile::mediawiki::webserver]</code>, this provisions Apache, and any other packages or resources needed by MediaWiki on app servers.
* Test your change in deployment-prep and make sure that it works as expected.
** <code>[https://gerrit.wikimedia.org/g/operations/puppet/+/HEAD/modules/profile/manifests/mediawiki/httpd.pp profile::mediawiki::httpd]</code>, the Apache service.
** <code>[https://gerrit.wikimedia.org/r/plugins/gitiles/operations/puppet/+/HEAD/modules/mediawiki/manifests/web/prod_sites.pp mediawiki::web::prod_sites]</code>, the Apache configuration for all production websites (including wikipedia.org).
** Additional Apache configurations are at [https://github.com/wikimedia/operations-puppet/tree/production/modules/mediawiki/files/apache/sites modules/mediawiki/files/apache/sites/]. Prior to 2012, Apache configuration were in a Subversion repository.


* Submit change to [[gerrit]] in the <code>modules/mediawiki/files/apache/sites</code> directory (project: operations/puppet)
==Architecture==
* Disable puppet across the affected mediawiki application servers.
{{See also|MediaWiki at WMF|HTTP timeouts#App servers}}
** Cumin can in finding the precise set of hosts. For example, this is a recent query: <syntaxhighlight lang="bash">
cumin 'R:File = "/etc/apache2/sites-available/04-remnant.conf"' 'disable-puppet "elukey - precaution for https://gerrit.wikimedia.org/r/#/c/380774/"' -b 10
</syntaxhighlight> In this case the change was related to a RewriteRule change in '''04-remnant.conf''', but of course it must be changed every time with the file(s) modified by the Gerrit change.
* Merge via gerrit and run on puppetmaster1001 the usual <code>puppet-merge</code>


* Create a plain text file with some significant URLs that should be modified by the Gerrit change. Some examples of files with testing URLs, are deployed in <code>/usr/local/share/apache-tests/</code> on the deployment hosts. This text file will be used on deploy1001 with '''apache-fast-test''' later on to verify that  the change works as expected.
The application servers are load-balanced via [[LVS]]. Connections between our CDN (HTTP cache proxies) and app servers are encrypted with TLS, which is terminated locally on the app server using [[Envoy]]. Envoy then hands the request off to the local Apache.
** For example, if you are adding or modifying a new RewriteRule, please add to your text file some URLs that are expected to change.
* Go to one of the '''mwdebug''' servers and enable/run puppet. Apache will reload its configuration automatically, please check that no error messages are emitted. Running '''apachectl -t''' after running puppet surely helps verifying that the new configuration is syntactically correct (it doesn't absolutely imply that it will work as intended of course).
** Some Apache directive changes need a full restart to get applied, not a simple reload. These changes are very rare and they are clearly indicated in Apache's documentation, so please verify it beforehand. Simple RewriteRule changes require only an Apache reload. 
* On deploy1001 run '''apache-fast-test''' against the selected '''mwdebug''' host using <code>/usr/local/share/apache-tests/baseurls</code> '''and your new test file'''. '''Both of them need to return a positive confirmation that everything looks good.'''
** Example of usage related to the previously mentioned change (https://gerrit.wikimedia.org/r/#/c/380774):
<syntaxhighlight lang="bash">
elukey@deploy1001:~$ apache-fast-test /usr/local/share/apache-tests/baseurls mwdebug1001.eqiad.wmnet
testing 19 urls on 1 servers, totalling 19 requests
spawning threads..


http://elefante-a-pallini.ro.sa/
'''Apache''' is in charge of handling redirects, rewrite rules, and determining the [[MediaWiki at WMF#Document root|document root]]. It then uses <code>php-fpm</code> to invoke the MediaWiki software.
* 200 OK 929
http://wikimedia.org/research
* 301 Moved Permanently https://wikimedia.qualtrics.com/SE/?SID=SV_6R04ammTX8uoJFP
http://www.wikipedia.org/wiki/it:Francesco_Totti
* 302 Found http://it.wikipedia.org/wiki/Francesco_Totti
http://zero.wikipedia.org/
* 302 Found http://en.zero.wikipedia.org/wiki/Special:ZeroRatedMobileAccess
[.. cut ..]
* 301 Moved Permanently https://meta.wikimedia.org/wiki/Special:UrlShortener


 
The Apache [https://httpd.apache.org/docs/2.4/mpm.html MPM] we use is [https://httpd.apache.org/docs/2.4/mod/worker.html mod_worker]</code>, which decides how <code>php-fpm</code> processes are spawned.
elukey@deploy1001:~$ apache-fast-test wikidata_redirect mwdebug1001.eqiad.wmnet
testing 1 urls on 1 servers, totalling 1 requests
spawning threads..
 
https://commons.wikimedia.org/data/main/Data:Bundestagswahl2017/wahlkreis46.map
* 301 Moved Permanently https://commons.wikimedia.org/wiki/Special:PageData/main/Data:Bundestagswahl2017/wahlkreis46.map
</syntaxhighlight>
* Enable/Run puppet on another mediawiki application server that is taking traffic, de-pooling it beforehand via confctl. Verify again from deploy1001 that everything is working as expected, running apache-fast-test.
* Repool the host mentioned above and verify on Apache access logs that everything looks fine. If you want to be extra paranoid, you can check the host level metrics via https://grafana.wikimedia.org/d/000000327/apache-hhvm?orgId=1 and make sure that nothing is out of the ordinary.
* Re-enable puppet across the appservers previously disabled via cumin.
* Keep an eye on the operations channel and make sure that puppet runs fine on these hosts.


==Logging==
==Logging==


Apache errors are logged to /srv/mw-log/apache2.log on mwlog1001.
Apache errors are logged to <code>/srv/mw-log/apache2.log</code> on <code>mwlog1001</code>.


Apache access logs are mostly disabled. Statistics are drawn from [[Varnish]] front ends instead.
Apache access logs are mostly disabled. Statistics are drawn from [[Varnish]] front ends instead.


==Apache setup checklist==
== Hardware repair ==
 
{{Outdated-inline|year=2015}}
* Follow the [[Automated installation]] instructions for the base install
* Run the following on the server:
:* <tt>apt-get update && apt-get dist-upgrade -y && apt-get install wikimedia-task-appserver && reboot && exit </tt>
* Wait for the server to come back online, ensure it starts apache correctly
** <tt>echo 'GET /' | nc localhost 80</tt> or any of the number of tests listed below
* If the server is part of the memcached group, follow instructions on [[Memcached]]
* If the server is new, you will need to do the following:
:* Login to the LVS server for apaches (lvs3 as of 2009-02-13) and add the new servers to /etc/pybal/apaches
* If the server is not new do the following:
:* Ensure the server is now enabled in pybal on the LVS server in the file /etc/pybal/apaches
* You will need to add the server to [[DSH]] groups if new, or check if they are commented, if the server is not new:
:* Add/Uncomment the host to /usr/local/dsh/node_groups/apaches and mediawiki-installation, as well as any other groups needed
:* Reload nagios to accept the changes to the node groups:
::* <tt>cd /home/wikipedia/conf/nagios && ./sync </tt>
* Verify that the server is tacking traffic and doing work
:* <tt>ipvsadm -L | grep SERVERNAME </tt>
:* traffic logs?
 
==Test cases==
 
Here are some test cases you can use to test the apache configuration after changing something.
 
<pre>
GET /wiki/Foo HTTP/1.1
Host: en.wikipedia.org
User-agent: testthing
 
GET /wiki/Foo HTTP/1.1
Host: www.wikipedia.org
User-agent: testthing
 
GET /wiki/Main_Page HTTP/1.1
Host: www.wikipedia.com
User-agent: testthing
 
GET / HTTP/1.1
Host: wikipedia.com
User-agent: testthing
 
GET / HTTP/1.1
Host: wikibooks.org
User-agent: testthing
 
GET / HTTP/1.1
Host: wikiquote.org
User-agent: testthing
 
GET / HTTP/1.1
Host: dk.wikipedia.org
User-agent: testthing
 
GET / HTTP/1.1
Host: foo.wikipedia.org
User-agent: testthing
 
GET /wiki/Main_Page HTTP/1.1
Host: test.wikipedia.org
User-agent: testthing
 
GET /wiki/Foo HTTP/1.1
Host: en.wikipedia.org
User-Agent: Exalead


GET /wiki/Foo HTTP/1.1
Host: meta.wikimedia.org
User-agent: testthing
GET / HTTP/1.1
Host: en.wiktionary.org
User-agent: testthing
</pre>
== Hardware Repair ==
==== Application Servers ====
When taking down application servers (running mediawiki) for things like disk replacement or other hardware repair, _do not forget to_:
When taking down application servers (running mediawiki) for things like disk replacement or other hardware repair, _do not forget to_:
* before: remove from dsh group
* before: remove from dsh group
Line 152: Line 42:
See [[pybal]]. You can just grep for the server name and set 'enabled': False and save.
See [[pybal]]. You can just grep for the server name and set 'enabled': False and save.
* before: check nobody is scapping right now (best: announce with a !log line in IRC)
* before: check nobody is scapping right now (best: announce with a !log line in IRC)
This is an IRC thing on freenode in #wikimedia-dev/-tech/-operations
This is an IRC thing on libera.chat in {{irc|wikimedia-dev}}/{{irc|wikimedia-tech}}/{{irc|wikimedia-operations}}
* during: acknowledge Icinga monitoring checks (best: with related ticket number as comment)
* during: acknowledge Icinga monitoring checks (best: with related ticket number as comment)
Do this by logging in via browser on icinga.wikimedia.org. search for the hostname, check all services and use the "acknowledge" option. You'll see the IRC bots outputting this as well and they will stop repeating things over and over in the channels.
Do this by logging in via browser on icinga.wikimedia.org. search for the hostname, check all services and use the "acknowledge" option. You'll see the IRC bots outputting this as well and they will stop repeating things over and over in the channels.
Line 159: Line 49:
* after: re-pool in pybal
* after: re-pool in pybal
Revert the above.
Revert the above.
== Adding a new server into production ==
* Create DNS patch to assign IP addresses to them. This is usually done by dcops nowadays but they might want your review for it. ([https://gerrit.wikimedia.org/r/c/operations/dns/+/571785 example change])
* Create a puppet patch that adds the servers with the right regexes in site.pp. Apply the spare::system puppet role. ([https://gerrit.wikimedia.org/r/c/operations/puppet/+/572975 example change])
* [[Mcrouter#Generate_certs_for_a_new_host|Create mcrouter certs]], merge them in the private puppet repo on the puppetmaster (as of today [[Puppetmaster1001]]).
* Create a patch to add fake certs in the '''labs/private''' repo. Merge it. In the labs/private repo you have to also add the V+2 yourself, no jenkins. ([https://gerrit.wikimedia.org/r/c/labs/private/+/573002 example change])
* Decide which role this server should have (appserver, API appserver, jobrunner,..). Use [https://netbox.wikimedia.org/ Netbox] to search for the host and see which rack it is in. Try to balance servers (and roles) across racks.
* Create a puppet patch that adds the proper role to servers and adds them in conftool-data in the right section. Don't merge it yet. ([https://gerrit.wikimedia.org/r/c/operations/puppet/+/573019 example change])
* Start with the first 2 steps to [[Icinga#Avoid_Icinga_spam_on_new_server_installs|avoid Icinga alert spam]]. Then merge the patch to add puppet roles to the new servers.
* Run puppet on the new hosts. Some errors are normal in the first puppet run.
* Run puppet on the new hosts a second time. It should complete successfully.
* Watch all (new) [https://icinga.wikimedia.org/icinga/ Icinga] alerts on the hosts turn green, make sure Apache does not have to be restarted. You can "reschedule next service check" in the Icinga web UI to speed things up. It is expected that the "not in dsh group" alert stays CRIT until the server is pooled below. Once all alerts besides that one are green (not PENDING and not CRIT) it is ok to go ahead.
* Check for ongoing deployments. Wait if that is the case. You can use "jouncebot: now" on IRC and/or the [https://wikitech.wikimedia.org/wiki/Deployments Deployment page] on Wikitech wiki.
* Run "scap pull" on new servers to ensure latest MediaWiki version deployed is present.
* Give the server a weight with confctl: ex: '''[cumin1001:~] $ sudo -i confctl select name=mw1355.eqiad.wmnet set/weight=10'''
* Pool the server with confctl: ex: '''[cumin1001:~] $ sudo -i confctl select name=mw1353.eqiad.wmnet set/pooled=yes'''
* Watch [https://grafana.wikimedia.org/d/000000377/host-overview?orgId=1&refresh=5m Grafana Host Overview], select server and see it is getting traffic.


== See also ==
== See also ==
Line 183: Line 55:


[[Category:Servers by usage| Apache]]
[[Category:Servers by usage| Apache]]
[[Category:MediaWiki production| ]]
[[Category:SRE Service Operations]]

Latest revision as of 02:30, 1 May 2022

The Application servers (or app servers) are the several hundred Apache servers that run MediaWiki (PHP application).

Service

Puppet roles:

  • mediawiki::appserver, mediawiki::canary_appserver
  • mediawiki::appserver::api, mediawiki::appserver::canary_api
  • mediawiki::maintenance
  • mediawiki::jobrunner

Relevant puppet classes:

Architecture

The application servers are load-balanced via LVS. Connections between our CDN (HTTP cache proxies) and app servers are encrypted with TLS, which is terminated locally on the app server using Envoy. Envoy then hands the request off to the local Apache.

Apache is in charge of handling redirects, rewrite rules, and determining the document root. It then uses php-fpm to invoke the MediaWiki software.

The Apache MPM we use is mod_worker, which decides how php-fpm processes are spawned.

Logging

Apache errors are logged to /srv/mw-log/apache2.log on mwlog1001.

Apache access logs are mostly disabled. Statistics are drawn from Varnish front ends instead.

Hardware repair

When taking down application servers (running mediawiki) for things like disk replacement or other hardware repair, _do not forget to_:

  • before: remove from dsh group

These are in puppet, operations/puppet repo, in modules/dsh/files/group. The important one for Mediawiki sync is "mediawiki-installation".

  • before: de-pool in pybal
  • TODO: Document what to do if it's a scap proxy (see hieradata/common/dsh/config.yaml)

See pybal. You can just grep for the server name and set 'enabled': False and save.

  • before: check nobody is scapping right now (best: announce with a !log line in IRC)

This is an IRC thing on libera.chat in #wikimedia-dev connect/#wikimedia-tech connect/#wikimedia-operations connect

  • during: acknowledge Icinga monitoring checks (best: with related ticket number as comment)

Do this by logging in via browser on icinga.wikimedia.org. search for the hostname, check all services and use the "acknowledge" option. You'll see the IRC bots outputting this as well and they will stop repeating things over and over in the channels.

  • after: re-add to dsh groups

Revert the above.

  • after: re-pool in pybal

Revert the above.

See also