Support-infrastructuur

Uit Limesco Wiki
Versie door SGielen (overleg | bijdragen) op 18 feb 2013 om 02:53 (Configuratie website)
Ga naar: navigatie, zoeken

Support@ is sinds het begin bemand geweest door Sjors, Gerdriaan en Mark, waarbij Sjors de meeste mails afhandelde. Omdat puur e-mail gebruiken tracken lastiger maakt, en er wel eens voor zorgde dat Sjors en Gerdriaan tegelijkertijd een antwoord stuurden, zijn we begin 2013 gaan kijken naar een ticketingsysteem. We hebben geëxperimenteerd met Request Tracker en hebben besloten dat we dat systeem als implementatie gaan gebruiken voor support-tickets.

We hadden verschillende eisen voor dit systeem:

  1. Het moet duidelijk zijn wie een ticket behandelt (eigenaar & claimfunctionaliteit)
  2. We moeten wel alle tickets in kunnen zien, ongeacht eigenaar
  3. Het systeem moet mailnotificaties sturen als er interessante dingen gebeuren
  4. Alle communicatie in een ticket moet in 1 overzicht zichtbaar zijn
  5. We willen extra properties kunnen zetten op een ticket, zodat een mail automatisch interessante informatie verzamelt (accountnaam, SIM-gegevens, eventuele SpeakUp-ticketnummers)
  6. Tickets moeten via een commandline-interface in te zien en te wijzigen zijn
  7. Voortgang van tickets moet snel zichtbaar zijn
  8. Er moet een systeem voor reminders zijn, bijv. "over 2 dagen nog eens kijken hoe het staat" of "moet maximaal over 3 dagen opgelost zijn"
  9. Dat systeem voor reminders moet ons ook kunnen e-mailen
  10. We moeten vanaf de commandline mensen e-mail kunnen sturen, zo dat replies automatisch in dezelfde ticket komen

Het bleek dat Request Tracker dit allemaal kon, of gemakkelijk aan te vullen was zodat het dit kon. Op deze pagina beschrijf ik hoe we de boel hebben geïmplementeerd, voor het geval we het nog eens moeten doen en in de hoop dat het nuttig is voor anderen.

Installatie

De Request Tracker-installatie draait op de Debian-machine api.limesco.nl. Installatie op Debian is zo simpel als apt-get install request-tracker4. Tijdens de installatie wordt gevraagd om de naam van de Request Tracker-instance. In ons geval is dat rt.limesco.nl:

$ host rt.limesco.nl
rt.limesco.nl mail is handled by 20 relay.transip.nl.
rt.limesco.nl mail is handled by 10 api.limesco.nl.

Request Tracker gaat uitgevoerd worden als de user www-data omdat er niets anders als de www-data-gebruiker uitgevoerd wordt. Zouden er al bestaande services gebruikmaken van die user, dan zouden we de voorkeur hebben een aparte gebruiker aan te maken voor RT. Op de vraag "Handle RT_SiteConfig.pm permissions?" antwoorden we nu dus ja. De databaseconfiguratie kan ook automatisch worden gedaan ("Yes") en voor het initial root password kiezen we een lang, onraadbaar wachtwoord. Zodra RT is geïnstalleerd maken we een setje accounts voor mensen; de root-account wordt dan alleen nog gebruikt voor geautomatiseerde scripts.

Configuratie website

Op api.limesco.nl gebruiken we nginx, een snelle lichte webserver met CGI-support. Om nginx en Request Tracker samen te laten werken is de package rt4-fcgi nodig. Die installeert een /etc/init.d/rt4-fcgi die Request Tracker via FastCGI bereikbaar maakt, en een /usr/share/doc/rt4-fcgi/examples/request-tracker4.conf die de interface naar Nginx maakt. Die interface gebruiken wij als opzetje voor de configuratie in nginx, die RT alleen bereikbaar maakt via SSL:

server {
	listen 443;
	server_name api.limesco.nl;

	root /var/www;
	index index.html index.htm;

	ssl on;
	ssl_certificate /etc/nginx/ssl/api.limesco.nl.bundle-primary-first.crt;
	ssl_certificate_key /etc/nginx/ssl/api.limesco.nl.key;

	ssl_session_timeout 5m;

	# request-tracker4 configuration for nginx
	# (belong to /etc/nginx/conf.d)
	location /rt {
		alias		/usr/share/request-tracker4/html;

		expires		epoch;
		include		/etc/nginx/fastcgi_params;
		fastcgi_param	SCRIPT_NAME		"/rt";
		fastcgi_pass	unix:/var/run/rt4-fcgi.sock;
	}

	# Bypass FastCGI for images
	location /rt/NoAuth/images {
		alias		/usr/share/request-tracker4/html/NoAuth/images/;
	}

	# Limit mail gateway access to localhost by default
	location /rt/REST/1.0/NoAuth {
		allow		127.0.0.1;
		deny		all;
	}
}

Om de FastCGI-daemon aan te zetten verander je enabled=0 in enabled=1 in /etc/default/rt4-fcgi. Dan resteert ons nog het opstarten van de FastCGI-daemon en het herstarten van Nginx:

$ sudo ln -s /etc/nginx/sites-available/rt.conf /etc/nginx/sites-enabled/
$ sudo /etc/init.d/rt4-fcgi start
$ sudo /etc/init.d/nginx restart

En https://api.limesco.nl/rt geeft netjes het loginscherm van Request Tracker weer.

Bestanden

/etc/init.d/rt

#!/bin/sh
### BEGIN INIT INFO
# Provides:          rt
# Required-Start:    $remote_fs $syslog
# Required-Stop:     $remote_fs $syslog
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# X-Start-Before:    nginx
# X-Stop-After:      nginx
# Short-Description: Start spawn-fcgi for serving RT through nginx.
# Description:       Start spawn-fcgi for serving RT through nginx.
### END INIT INFO
# Adapted from:
# http://rodenberg.blogspot.nl/2011/08/install-request-tracker-4-with-nginx.html
# Adapted by Sjors Gielen, Limesco, february 2013

. /lib/lsb/init-functions

RTPATH=/usr/share/request-tracker4
RTUSER=www-data

case $1 in
start)
	log_begin_msg "Starting RT: "
	spawn-fcgi -F 3 -u www-data -g www-data -a 127.0.0.1 -p 9000 \
		-- /usr/share/request-tracker4/libexec/rt-server.fcgi
	log_end_msg 0
	;;

stop)
	log_begin_msg "Stopping RT: "
	PIDS=`ps axww | awk '/[r]t-server.fcgi/ { print $1}'`
	if [ -n "$PIDS" ]; then
		kill $PIDS
	else
		echo RT not running
	fi
	log_end_msg 0
	;;

restart|force-reload)
	$0 stop
	$0 start
	;;

*)
	log_action_msg "Usage: /etc/init.d/rt {start|stop|restart|force-reload}"
	;;

esac