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

Debmonitor: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>Quiddity
m (sp)
imported>Muehlenhoff
(→‎Manually remove an image from DebMonitor: Remove direct hostname reference)
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
DebMonitor is a Debian package tracker website and tool developed at the Wikimedia Foundation and used to track installed and upgradable packages across the fleet.
[[File:Wikimedia + Debian.svg|thumb]]
DebMonitor is a Debian package tracker website and tool developed at the Wikimedia Foundation and used to track installed and upgradable packages across the fleet. It has multiple components.


There are 2 main components:
=== [http://debmonitor.wikimedia.org DebMonitor website] ===
The DebMonitor website is a Django-based application installed in an active/passive setup with <code>uwsgi</code> and <code>nginx</code> on two dedicated Ganeti VMs and deployed via [[Scap]]. The application has two different virtual hosts, one on port <code>80</code> for [[Varnish]] and one on port <code>443</code> for the DebMonitor client (see below). The data is stored on a MySQL database hosted by the <code>m2</code> cluster.


* the [http://debmonitor.wikimedia.org DebMonitor website]
There is a weekly crontab on each host to run a garbage collection script twice a week to remove orphan objects from the database (e.g. package versions not installed anymore in any host).
* the <code>debmonitor-client</code> Debian package to install on all the clients that should report their installed packages.
 
=== DebMonitor client ===
The <code>debmonitor-client</code> Debian package is installed on all the clients and reports the installed packages to the DebMonitor active server. It reports them in three different ways:
 
* A dpkg hook triggered on <code>Dpkg::Pre-Install-Pkgs</code> to report any change to packages. It doesn't block package actions on failure.
* An APT hook triggered on <code>APT::Update::Post-Invoke</code> to report any upgradable packages. It doesn't block <code>apt-get update</code> on failure.
* A daily crontab to report all installed and upgradable packages to reconcile the data in case any of the above failed.
 
The client authenticate with the DebMonitor server via mutual authentication using the Puppet certificate, and the server authorize the connecting host to modify only its own data.
 
=== Common commands ===
{{Note||content=Be sure to use '''debmonitor.discovery.wmnet''' as host.
Copy-Paste from your browser will lead to HTTP 403 "Client certificate validation failed".}}
==== Manually remove a host from DebMonitor ====
From one of the <code>cluster::management</code> hosts ({{CuminHosts}}) run the <code>sre.debmonitor.remove-hosts</code> cookbook. See also [[Spicerack/Cookbooks#Run_a_single_Cookbook]].
 
Alternatively it can be done manually running:<syntaxhighlight lang="bash">
sudo curl -X DELETE "https://debmonitor.discovery.wmnet/hosts/${HOST_FQDN}" --cert "/etc/debmonitor/ssl/debmonitor_$(hostname -f | tr '.' '_').pem" --key "/etc/debmonitor/ssl/debmonitor_$(hostname -f | tr '.' '_')-key.pem"
</syntaxhighlight>
 
==== Manually remove an image from DebMonitor ====
This will remove all tags of this image from DebMonitor.
 
From one of the <code>builder</code> hosts run:<syntaxhighlight lang="bash">
# IMAGE_NAME=docker-registry.wikimedia.org/foo-bar-image
sudo curl -X DELETE "https://debmonitor.discovery.wmnet/images/${IMAGE_NAME}" --cert "/etc/debmonitor/ssl/debmonitor__$(hostname -f | tr '.' '_').pem" --key "/etc/debmonitor/ssl/debmonitor__$(hostname -f | tr '.' '_')-key.pem"
</syntaxhighlight>


[[Category:Deployment]]
[[Category:Deployment]]
[[Category:SRE Infrastructure Foundations]]

Latest revision as of 10:38, 8 July 2022

Wikimedia + Debian.svg

DebMonitor is a Debian package tracker website and tool developed at the Wikimedia Foundation and used to track installed and upgradable packages across the fleet. It has multiple components.

DebMonitor website

The DebMonitor website is a Django-based application installed in an active/passive setup with uwsgi and nginx on two dedicated Ganeti VMs and deployed via Scap. The application has two different virtual hosts, one on port 80 for Varnish and one on port 443 for the DebMonitor client (see below). The data is stored on a MySQL database hosted by the m2 cluster.

There is a weekly crontab on each host to run a garbage collection script twice a week to remove orphan objects from the database (e.g. package versions not installed anymore in any host).

DebMonitor client

The debmonitor-client Debian package is installed on all the clients and reports the installed packages to the DebMonitor active server. It reports them in three different ways:

  • A dpkg hook triggered on Dpkg::Pre-Install-Pkgs to report any change to packages. It doesn't block package actions on failure.
  • An APT hook triggered on APT::Update::Post-Invoke to report any upgradable packages. It doesn't block apt-get update on failure.
  • A daily crontab to report all installed and upgradable packages to reconcile the data in case any of the above failed.

The client authenticate with the DebMonitor server via mutual authentication using the Puppet certificate, and the server authorize the connecting host to modify only its own data.

Common commands

Manually remove a host from DebMonitor

From one of the cluster::management hosts (cumin1001.eqiad.wmnet, cumin2002.codfw.wmnet) run the sre.debmonitor.remove-hosts cookbook. See also Spicerack/Cookbooks#Run_a_single_Cookbook.

Alternatively it can be done manually running:

sudo curl -X DELETE "https://debmonitor.discovery.wmnet/hosts/${HOST_FQDN}" --cert "/etc/debmonitor/ssl/debmonitor_$(hostname -f | tr '.' '_').pem" --key "/etc/debmonitor/ssl/debmonitor_$(hostname -f | tr '.' '_')-key.pem"

Manually remove an image from DebMonitor

This will remove all tags of this image from DebMonitor.

From one of the builder hosts run:

# IMAGE_NAME=docker-registry.wikimedia.org/foo-bar-image
sudo curl -X DELETE "https://debmonitor.discovery.wmnet/images/${IMAGE_NAME}" --cert "/etc/debmonitor/ssl/debmonitor__$(hostname -f | tr '.' '_').pem" --key "/etc/debmonitor/ssl/debmonitor__$(hostname -f | tr '.' '_')-key.pem"