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

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