source: trunk/server/doc/install-howto.sh @ 2554

Last change on this file since 2554 was 2485, checked in by btidor, 11 years ago
Make our documentation less offensive
File size: 21.0 KB
Line 
1# This document is a how-to for installing a Fedora scripts.mit.edu server.
2# It is semi-vaguely in the form of a shell script, but is not really
3# runnable as it stands.
4
5# Notation
6# [PRODUCTION] Production server that will be put into the pool
7# [WIZARD]     Semi-production server that will only have
8#              daemon.scripts-security-upd bits, among other
9#              restricted permissions
10# [TESTSERVER] Completely untrusted server
11
12# 'branch' is the current svn branch you are on.  You want to
13# use trunk if your just installing a new server, and branches/fcXX-dev
14# if your preparing a server on a new Fedora release.
15branch="trunk"
16
17# 'server' is the public hostname of your server, for SCP'ing files
18# to and from.
19server=YOUR-SERVER-NAME-HERE
20
21# ----------------------------->8--------------------------------------
22#                       FIRST TIME INSTRUCTIONS
23#
24# [PRODUCTION] If this is the first time you've installed this hostname,
25# you will need to update a bunch of files to add support for it. These
26# include:
27#   o Adding all aliases to /etc/httpd/conf.d/scripts-vhost-names.conf
28#     (usually this is hostname, hostname.mit.edu, h-n, h-n.mit.edu,
29#     scriptsN, scriptsN.mit.edu, and the IP address.)
30#   o Adding routing rules for the static IP in
31#     /etc/sysconfig/network-scripts/route-eth1
32#   o Adding the IP address to the hosts file (same hosts as for
33#     scripts-vhost-names)
34#   o Update SSH config at
35#       - server/fedora/config/etc/ssh/shosts.equiv
36#       - server/fedora/config/etc/ssh/ssh_known_hosts
37#       - server/fedora/config/etc/ssh/sshd_config : DenyUsers
38#     (the last part is critical to ensure that rooting one server
39#     doesn't give you root to all the other servers)
40#   o Put the hostname information in LDAP so SVN and Git work
41#   o Set up Nagios monitoring on sipb-noc for the host
42#   o Set up the host as in the pool on r-b/r-b /etc/heartbeat/ldirectord.cf
43#   o Update locker/etc/known_hosts
44#   o Update website files:
45#       /mit/scripts/web_scripts/home/server.css.cgi
46#       /mit/scripts/web_scripts/heartbeat/heartbeat.php
47#
48# You will also need to prepare the keytabs for credit-card.  In particular,
49# use ktutil to combine the host/scripts.mit.edu and
50# host/scripts-vhosts.mit.edu keys with host/this-server.mit.edu in
51# the keytab.  Do not use 'k5srvutil change' on the combined keytab
52# or you'll break the other servers. (real servers only).  Be
53# careful about writing out the keytab: if you write it to an
54# existing file the keys will just get appended.  The correct
55# credential list should look like:
56#   ktutil:  l
57#   slot KVNO Principal
58#   ---- ---- ---------------------------------------------------------------------
59#      1    5 host/old-faithful.mit.edu@ATHENA.MIT.EDU
60#      2    3 host/scripts-vhosts.mit.edu@ATHENA.MIT.EDU
61#      3    2 host/scripts.mit.edu@ATHENA.MIT.EDU
62#      4    8 host/scripts-test.mit.edu@ATHENA.MIT.EDU
63#
64# The LDAP keytab should be by itself, so be sure to delete it and
65# put it in its own file.
66
67# ----------------------------->8--------------------------------------
68#                      INFINITE INSTALLATION
69
70# Start with a Scripts kickstarted install of Fedora (install-fedora)
71
72# IMPORTANT: If you are installing a server without the benefit of
73# Kickstart (for example, you are installing on XVM, it is VITALLY
74# IMPORTANT that you go through the kickstart and apply all of the
75# necessary changes--for example, disabling selinux or enabling
76# network.)
77#   XXX We should make Kickstart work for test servers too
78
79# Make sure selinux is disabled
80    selinuxenabled || echo "selinux not enabled"
81
82# Take updates, reboot if there's a kernel update.
83    yum update -y
84
85# Get rid of network manager (XXX figure out to make kickstarter do
86# this for us)
87    yum remove NetworkManager
88
89# Make sure sendmail isn't installed, replace it with postfix
90    yum shell -y <<EOF
91remove sendmail
92install postfix
93run
94exit
95EOF
96
97# Check out the scripts /etc configuration
98    cd /root
99    \cp -a etc /
100    chmod 0440 /etc/sudoers
101    grub2-mkconfig -o /boot/grub2/grub.cfg
102
103# [TEST] You'll need to fix some config now.  See bottom of document.
104
105# Stop /etc/resolv.conf from getting repeatedly overwritten by
106# purging DNS servers from ifcfg-eth0 and ifcfg-eth1
107    vim /etc/sysconfig/network-scripts/ifcfg-eth0
108    vim /etc/sysconfig/network-scripts/ifcfg-eth1
109
110# Make sure network is working.  Kickstart should have
111# configured eth0 and eth1 correctly; use service network restart
112# to add the new routes from etc in route-eth1.
113    systemctl restart network.service
114    # Check everything worked:
115    route
116    ifconfig
117    cat /etc/hosts
118    cat /etc/sysconfig/network-scripts/route-eth1
119
120# This is the point at which you should start updating scriptsified
121# packages for a new Fedora release.  Consult 'upgrade-tips' for more
122# information.
123    yum install -y scripts-base
124    # Some of these packages are naughty and clobber some of our files
125    cd /etc
126    svn revert resolv.conf hosts sysconfig/openafs nsswitch.conf
127    # Troubleshooting: if accountadm, tokensys and nscd fail to install
128    # you probably forgot to turn off selinux
129
130# Replace rsyslog with syslog-ng by doing:
131    yum shell -y <<EOF
132remove rsyslog
133install syslog-ng
134run
135exit
136EOF
137    systemctl enable syslog-ng.service
138    systemctl start syslog-ng.service
139
140# Install the full list of RPMs that users expect to be on the
141# scripts.mit.edu servers.
142rpm -qa --queryformat "%{Name}.%{Arch}\n" | sort > packages.txt
143# arrange for packages.txt to be passed to the server, then run:
144    cd /tmp
145    yumdownloader --disablerepo=scripts ghc-cgi ghc-cgi-devel
146    yum localinstall ghc-cgi*.x86_64.rpm
147    yum install -y $(cat packages.txt)
148# The reason this works is that ghc-cgi is marked as installonlypkgs
149# in yum.conf, telling yum to install them side-by-side rather than
150# updating them. If it doesn't work, use --skip-broken on the yum
151# command line.
152
153# Check which packages are installed on your new server that are not
154# in the snapshot, and remove ones that aren't needed for some reason
155# on the new machine.  Otherwise, aside from bloat, you may end up
156# with undesirable things for security, like sendmail.
157    rpm -qa --queryformat "%{Name}.%{Arch}\n" | grep -v kernel | sort > newpackages.txt
158    diff -u packages.txt newpackages.txt | grep -v kernel | less
159    # here's a cute script that removes all extra packages
160    yum erase -y $(grep -Fxvf packages.txt newpackages.txt)
161    # 20101208 - Mysteriously we manage to get these extra packages
162    # from kickstart: mcelog mobile-broadband-provider-info
163    # ModemManager PackageKit
164
165# ----------------------------->8--------------------------------------
166#                      SPHEROID SHENANIGANS
167
168# Install the Python eggs and Ruby gems and PEAR/PECL doohickeys that are on
169# the other scripts.mit.edu servers and do not have RPMs.
170# The general mode of operation will be to run the "list" command
171# on both servers, see what the differences are, check if those diffs
172# are packaged up as rpms, and install them (rpm if possible, native otherwise)
173
174# Note: Since ultimately we'd like to move away from using per-language
175# package manager and all of these be RPMs, it is of questionable
176# importance how much /good/ automation for these is necessary.
177
178# Warning: For a new release, we're supposed to check if Fedora has
179# packaged up the RPM.  Unfortunately we don't really have good incants
180# for this.
181
182# Warning: If you're installing a new server mid-lifecycle (or even if
183# this is the start of a cycle, but you've been staggering the
184# installation of servers), upstream may have moved on.  Because we
185# don't normally upgrade spheroid projects, that means executing these
186# instructions directly means that you will have mismatched versions
187# (the new servers will have newer versions.)  Please follow the
188# UPGRADE commentary attached to each of these.
189
190# Warning: The package lists that are generated are inconsistent on
191# the question of whether or not they contain all packages (locally
192# installed as well as distro packaged), or if they just contain locally
193# installed packages.  Check this carefully; many of the install incants
194# filter out already installed packages.
195
196# PERL CPAN
197# ---------
198
199# Install the full list of perl modules that users expect to be on the
200# scripts.mit.edu servers.
201    cd /root
202    export PERL_MM_USE_DEFAULT=1
203    cpan # this is interactive, enter the next two lines
204        o conf prerequisites_policy follow
205        o conf commit
206# on a reference server
207perldoc -u perllocal | grep head2 | cut -f 3 -d '<' | cut -f 1 -d '|' | sort -u | perl -ne 'chomp; print "notest install $_\n" if system("rpm -q --whatprovides \"perl($_)\" >/dev/null 2>/dev/null")' > perl-packages.txt
208# arrange for perl-packages.txt to be transferred to server
209    # Package list only contains new packages
210    cat perl-packages.txt | perl -MCPAN -e shell
211# These are in /usr/local
212
213# UPGRADE: Installing old versions of CPAN modules requires you to
214# specify the full path of a module, e.g.
215# M/MS/MSCHWERN/Test-Simple-0.62.tar.gz.  It is not currently clear how
216# to get this information programatically.  Furthermore, we have a lot
217# of CPAN managed modules.  Since CPAN is the only thing
218# placed in /usr/local at this point, it may be easier to simple tar and
219# cp the Perl modules from one server to another, to keep them
220# consistent.  But doing this is fiddly XXX
221
222# PYTHON EGGS
223# -----------
224
225# - Look at /usr/lib/python2.7/site-packages and
226#           /usr/lib64/python2.7/site-packages for Python eggs and modules.
227#   There will be a lot of gunk that was installed from packages;
228#   easy-install.pth in /usr/lib/ will tell you what was easy_installed.
229#   First use 'yum search' to see if the relevant package is now available
230#   as an RPM, and install that if it is.  If not, then use easy_install.
231#   Pass -Z to easy_install to install them unzipped, as some zipped eggs
232#   want to be able to write to ~/.python-eggs.  (Also makes sourcediving
233#   easier.)
234# 'easy_install AuthKit jsonlib2 pygit'
235cat /usr/lib/python2.7/site-packages/easy-install.pth | grep "^./" | cut -c3- | cut -f1 -d- > egg.txt
236    # Package list only contains new packages
237    cat egg.txt | xargs easy_install -Z
238# These are in /usr
239
240# UPGRADE: Use 'easy_install -n' to see what new versions are installed, and if there
241# are updates validate them and upgrade them on the old servers.  Since
242# we have a really small package list (around 4) checking these manually
243# should be fine.  Note that dry run is slightly buggy and may fail
244# midway processing files on account of a missing build directory.
245
246# RUBY GEMS
247# ---------
248
249# - Look at `gem list` for Ruby gems.
250#   Again, use 'yum search' and prefer RPMs, but failing that, 'gem install'.
251#       ezyang: rspec-rails depends on rspec, and will override the Yum
252#       package, so... don't use that RPM yet
253# XXX This doesn't do the right thing for old version gems
254gem list --no-version > gem.txt
255    # Package list contains distro gems too
256    gem install $(gem list --no-version | grep -Fxvf - gem.txt)
257    # Also, we need to install the old rails version
258    gem install -v=2.3.14 rails
259# These are in /usr
260
261# UPGRADE:  You can either upgrade out-of-date gems, or leave them at
262# the old version.  We recommend the latter (see below for the
263# rationale), but note that the install script described here doesn't
264# pin against version, so you'll need to supply the -v parameters
265# manually (the gems we install manually don't move too quickly, so this
266# is fairly tractable if you check 'gem outdated'.)
267#
268# If you want to upgrade, do NOT use wildcard 'gem update'; use 'gem
269# outdated' to find out all gems that are out of date, and verify this
270# against our locally installed gems (there will be a lot of out of date
271# gems, but this is simply because Fedora packaging lags behind the
272# canonical versions (this is a good thing).  Manually upgrade just
273# those gems.  Note that this doesn't save you from having to install
274# old gems on the servers that are being installed out-of-cycle,
275# because Ruby supports pinning against old versions, and if those gems
276# then mysteriously disappear, things will be sad (note that this isn't
277# a *huge* problem, because usually when you pin gems it's in
278# conjunction with rvm, so they have their local copy of the gem.)
279
280# PHP PEAR
281# --------
282
283# - Look at `pear list` for Pear fruits (or whatever they're called).
284#   Yet again, 'yum search' for RPMs before resorting to 'pear install'.  Note
285#   that for things in the beta repo, you'll need 'pear install package-beta'.
286#   (you might get complaints about the php_scripts module; ignore them)
287pear list | tail -n +4 | cut -f 1 -d " " > pear.txt
288    # Package list contains distro packages
289    pear config-set preferred_state beta
290    pear channel-update pear.php.net
291    pear install $(pear list | tail -n +4 | cut -f 1 -d " " | grep -Fxvf - pear.txt)
292# These are in /usr
293
294# PHP PECL
295# --------
296
297# - Look at `pecl list` for PECL things.  'yum search', and if you must,
298#   'pecl install' needed items. If it doesn't work, try 'pear install
299#   pecl/foo' or 'pecl install foo-beta' or those two combined.
300pecl list | tail -n +4 | cut -f 1 -d " " > pecl.txt
301    # Package list contains distro packages
302    pecl install --nodeps $(pecl list | tail -n +4 | cut -f 1 -d " " | grep -Fxvf - pecl.txt)
303# These are in /usr
304
305# ----------------------------->8--------------------------------------
306#                       INFINITE CONFIGURATION
307
308# [PROD] Create fedora-ds user (needed for credit-card)
309# [TEST] too if you want to run a local dirsrv instance
310useradd -r -d /var/lib/dirsrv fedora-ds
311
312# Run credit-card to clone in credentials and make things runabble
313# NOTE: You may be tempted to run credit-card earlier in the install
314# process in order, for example, to be able to SSH in to the servers
315# with Kerberos.  However, it is better to install the credentials
316# *after* we have run a boatload untrusted code as part of the
317# spheroids objects process.  So don't move this step earlier!
318python host.py push $server
319
320# This is superseded by credit-card, which works for [PRODUCTION] and
321# [WIZARD].  We don't have an easy way of running credit-card for XVM...
322#b
323#
324#   # All types of servers will have an /etc/daemon.keytab file, however,
325#   # different types of server will have different credentials in this
326#   # keytab.
327#   #   [PRODUCTION] daemon.scripts
328#   #   [WIZARD]     daemon.scripts-security-upd
329#   #   [TESTSERVER] daemon.scripts-test
330
331# Test that zephyr is working
332    systemctl enable zhm.service
333    systemctl start zhm.service
334    echo 'Test!' | zwrite -d -c scripts -i test
335
336# Check out the scripts /usr/vice/etc configuration
337    cd /root/vice
338    \cp -a etc /usr/vice
339# [TESTSERVER] If you're installing a test server, this needs to be
340# much smaller; the max filesize on XVM is 10GB.  Pick something like
341# 500000. Also, some of the AFS parameters are kind of silly (and if
342# you're low on disk space, will actually exhaust our inodes).  Edit
343# these parameters in /etc/sysconfig/openafs (I just chopped a zero
344# off of all of our parameters)
345    echo "/afs:/usr/vice/cache:500000" > /usr/vice/etc/cacheinfo
346    vim /etc/sysconfig/openafs
347
348# [PRODUCTION] Set up replication (see ./install-ldap).
349# You'll need the LDAP keytab for this server: be sure to chown it
350# fedora-ds after you create the fedora-ds user
351    ls -l /etc/dirsrv/keytab
352    cat install-ldap
353
354# Enable lots of services (currently in /etc checkout)
355    systemctl enable openafs-client.service
356    systemctl enable dirsrv.target
357    systemctl enable nslcd.service
358    systemctl enable nscd.service
359    systemctl enable postfix.service
360    systemctl enable nrpe.service # chkconfig'd
361    systemctl enable httpd.service # not for [WIZARD]
362
363    systemctl start openafs-client.service
364    systemctl start dirsrv.target
365    systemctl start nslcd.service
366    systemctl start nscd.service
367    systemctl start postfix.service
368    systemctl start nrpe.service
369    systemctl start httpd.service # not for [WIZARD]
370
371# Note about OpenAFS: Check that fs sysname is correct.  You should see,
372# among others, 'amd64_fedoraX_scripts' (vary X) and 'scripts'. If it's
373# not, you probably did a distro upgrade and should update
374# tokensys (server/common/oursrc/tokensys/scripts-afsagent-startup.in)
375    fs sysname
376
377# Postfix doesn't actually deliver mail; fix this
378    cd /etc/postfix
379    postmap virtual
380
381# Munin might not be monitoring packages that were installed after it
382    munin-node-configure --suggest --shell | sh
383
384# Run fmtutil-sys --all, which does something that makes TeX work.
385# (Note: this errors on XeTeX which is ok.)
386    fmtutil-sys --all
387
388# Check for unwanted setuid/setgid binaries
389    find / -xdev -not -perm -o=x -prune -o -type f -perm /ug=s -print | grep -Fxvf /etc/scripts/allowed-setugid.list
390    find / -xdev -not -perm -o=x -prune -o -type f -print0 | xargs -0r /usr/sbin/getcap | cut -d' ' -f1 | grep -Fxvf /etc/scripts/allowed-filecaps.list
391    # You can prune the first set of binaries using 'chmod u-s' and 'chmod g-s'
392    # and remove capabilities using 'setcap -r'
393
394# XXX check for selinux gunk
395
396# Fix etc by making sure none of our config files got overwritten
397    cd /etc
398    svn status -q
399    # Some usual candidates for clobbering include nsswitch.conf,
400    # resolv.conf and sysconfig/openafs
401    # [WIZARD/TEST] Remember that changes you made should not get
402    # reverted!
403
404# Reboot the machine to restore a consistent state, in case you
405# changed anything. (Note: Starting kdump fails (this is ok))
406
407# ------------------------------->8-------------------------------
408#                ADDENDA AND MISCELLANEOUS THINGS
409
410# [OPTIONAL] Your machine's hostname is baked in at install time;
411# in the rare case you need to change it: it appears to be in:
412#   o /etc/sysconfig/network
413#   o your lvm thingies; probably don't need to edit
414
415# [TESTSERVER] Enable password log in
416        vim /etc/ssh/sshd_config
417        service sshd reload
418        vim /etc/pam.d/sshd
419# Replace the first auth block with:
420#           # If they're not root, but their user exists (success),
421#           auth    [success=ignore ignore=ignore default=1]        pam_succeed_if.so uid > 0
422#           # print the "You don't have tickets" error:
423#           auth    [success=die ignore=reset default=die]  pam_echo.so file=/etc/issue.net.no_tkt
424#           # If !(they are root),
425#           auth    [success=1 ignore=ignore default=ignore]        pam_succeed_if.so uid eq 0
426#           # print the "your account doesn't exist" error:
427#           auth    [success=die ignore=reset default=die]  pam_echo.so file=/etc/issue.net.no_user
428
429
430# [WIZARD/TESTSERVER] If you are setting up a non-production server,
431# there are some services that it won't provide, and you will need to
432# make it talk to a real server instead.  In particular:
433#   - We don't serve the web, so don't bind scripts.mit.edu
434#   - We don't serve LDAP, so use another server
435# XXX: Someone should write sed scripts to do this
436# This involves editing the following files:
437        svn rm /etc/sysconfig/network-scripts/ifcfg-lo:{0,1,2,3}
438        svn rm /etc/sysconfig/network-scripts/route-eth1 # [TESTSERVER] only
439#   o /etc/nslcd.conf
440#       replace: uri ldapi://%2fvar%2frun%2fdirsrv%2fslapd-scripts.socket/
441#       with: uri ldap://scripts.mit.edu/
442#           (what happened to nss-ldapd?)
443#   o /etc/openldap/ldap.conf
444#       add: URI ldap://scripts.mit.edu/
445#            BASE dc=scripts,dc=mit,dc=edu
446#   o /etc/httpd/conf.d/vhost_ldap.conf
447#       replace: VhostLDAPUrl "ldap://127.0.0.1/ou=VirtualHosts,dc=scripts,dc=mit,dc=edu"
448#       with: VhostLDAPUrl "ldap://scripts.mit.edu/ou=VirtualHosts,dc=scripts,dc=mit,dc=edu"
449#   o /etc/postfix/virtual-alias-{domains,maps}-ldap.cf
450#       replace: server_host ldapi://%2fvar%2frun%2fdirsrv%2fslapd-scripts.socket/
451#       with: server_host = ldap://scripts.mit.edu
452# to use scripts.mit.edu instead of localhost.
453
454# [WIZARD/TESTSERVER] If you are setting up a non-production server,
455# afsagent's cronjob will attempt to be renewing with the wrong
456# credentials (daemon.scripts). Change this:
457    vim /home/afsagent/renew # replace all mentions of daemon.scripts.mit.edu
458
459# [TESTSERVER]
460#   - You need a self-signed SSL cert or Apache will refuse to start
461#     or do SSL.  Generate with: (XXX recommended CN?)
462    openssl req -new -x509 -keyout /etc/pki/tls/private/scripts.key -out /etc/pki/tls/certs/scripts-cert.pem -nodes
463    ln -s /etc/pki/tls/private/scripts.key /etc/pki/tls/private/scripts-1024.key
464#     Also make the various public keys match up
465    openssl rsa -in /etc/pki/tls/private/scripts.key -pubout > /etc/pki/tls/certs/star.scripts.pem
466    openssl rsa -in /etc/pki/tls/private/scripts.key -pubout > /etc/pki/tls/certs/scripts.pem
467    openssl rsa -in /etc/pki/tls/private/scripts.key -pubout > /etc/pki/tls/certs/scripts-cert.pem
468#     Nuke the CSRs since they will all mismatch
469#     XXX alternate strategy replace all the pem's as above
470    cd /etc/httpd/vhosts.d
471    svn rm *.conf
472
473# [TESTSERVER]
474#   Remove vhosts.d which we don't have rights for XXX
475
476# [TESTSERVER] More stuff for test servers
477#   - Make (/etc/aliases) root mail go to /dev/null, so we don't spam people
478#   - Edit /etc/httpd/conf.d/scripts-vhost-names.conf to have scripts-fX-test.xvm.mit.edu
479#     be an accepted vhost name
480#   - Look at the old test server and see what config changes are floating around
Note: See TracBrowser for help on using the repository browser.