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

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