ops-install.in 13.4 KB
Newer Older
1 2 3 4
#!/usr/bin/perl -w

#
# EMULAB-COPYRIGHT
5
# Copyright (c) 2003, 2004 University of Utah and the Flux Group.
6 7 8 9 10 11 12 13 14 15
# All rights reserved.
#

#
# install-ops.sh - Script to do the initial install of an ops node
#
# The main things it does not do yet:
# * Figure out where to put directories such as /users /proj - they must
#   already exist
# * Fill out mailing list files - presumably, it's easier to just get the
16
#   User to edit them himself
17 18 19 20 21 22 23
#

#
# Configure variables
#
my $PREFIX = '@prefix@';

Robert Ricci's avatar
Robert Ricci committed
24
my @MAILING_LISTS = ("@TBOPSEMAIL@","@TBLOGSEMAIL@","@TBWWWEMAIL@",
25
    "@TBAPPROVALEMAIL@","@TBAUDITEMAIL@","@TBSTATEDEMAIL@",
Robert Ricci's avatar
Robert Ricci committed
26 27
    "@TBTESTSUITEEMAIL@");

28 29 30 31

my $OURDOMAIN = '@OURDOMAIN@';

my $USERNODE = '@USERNODE@';
Robert Ricci's avatar
Robert Ricci committed
32
my $FSNODE =   '@FSNODE@';
33 34
my $BOSSNODE = '@BOSSNODE@';

35 36
my $LOGFACIL = '@TBLOGFACIL@';

37
#
Robert Ricci's avatar
Robert Ricci committed
38
# Allow this to work if the library is left in the source directory
39
#
Robert Ricci's avatar
Robert Ricci committed
40 41 42 43
use lib '@srcdir@';
   
use English;
use libinstall;
44 45 46 47 48 49
use Getopt::Std;

#
# Handle command-line options
#
sub usage {
50
    print "Usage: ops-install [-b] [-p packagedir]\n";
51 52 53 54
    exit(1);
}

my $packagedir = "";
55
my $batchmode  = 0;
56
my %opts;
57 58 59 60 61
if (! getopts("p:b", \%opts)) {
    usage();
}
if (defined($opts{p})) {
    $packagedir = $opts{p};
62
}
63
if (defined($opts{b})) {
64 65
    $batchmode = 1;
}
66 67 68 69

if (@ARGV) {
    usage();
}
70

71 72 73 74 75 76 77 78
#
# Figure out which directory we live in, so that some stages can do thing
# relative to it.
#
my $OBJDIR = `/usr/bin/dirname $0`;
chomp $OBJDIR;
my $TOP_OBJDIR = "$OBJDIR/..";

79
#
Robert Ricci's avatar
Robert Ricci committed
80
# Some programs we use
81
#
Robert Ricci's avatar
Robert Ricci committed
82 83 84
my $CHGRP      = "/usr/bin/chgrp";
my $CHMOD      = "/bin/chmod";
my $PW         = "/usr/sbin/pw";
85
my $PATCH      = "/usr/bin/patch";
Robert Ricci's avatar
Robert Ricci committed
86
my $NEWALIASES = "/usr/bin/newaliases";
87 88
my $SH         = "/bin/sh";
my $PKG_INFO   = "/usr/sbin/pkg_info";
89
my $PKG_ADD    = "/usr/sbin/pkg_add";
90
my $PWD        = "/bin/pwd";
91
my $CP         = "/bin/cp";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
92
my $GMAKE      = "/usr/local/bin/gmake";
93
my $ENV        = "/usr/bin/env";
94 95

#
Robert Ricci's avatar
Robert Ricci committed
96
# Some files we edit/create
97
#
Robert Ricci's avatar
Robert Ricci committed
98
my $RCCONF          = "/etc/rc.conf";
Robert Ricci's avatar
Robert Ricci committed
99 100
my $RCLOCAL         = "/etc/rc.local";
my $RCCAPTURE       = "$PREFIX/etc/rc.capture";
Robert Ricci's avatar
Robert Ricci committed
101 102 103 104 105 106 107
my $LOCAL_HOSTNAMES = "/etc/mail/local-host-names";
my $ALIASES_FILE    = "/etc/mail/aliases";
my $EXPORTS_FILE    = "/etc/exports";
my $EXPORTS_HEAD    = "$EXPORTS_FILE.head";
my $SYSLOG_CONF     = "/etc/syslog.conf";
my $NEWSYSLOG_CONF  = "/etc/newsyslog.conf";
my $SUDOERS         = "/usr/local/etc/sudoers";
108
my $SSHD_CONFIG     = "/etc/ssh/sshd_config";
109
my $CRONTAB         = "/etc/crontab";
110 111

#
Robert Ricci's avatar
Robert Ricci committed
112
# Some directories we care about
113
#
Robert Ricci's avatar
Robert Ricci committed
114 115
my $LIST_DIR   = "/etc/mail/lists";
my $TIPLOG_DIR = "/var/log/tiplogs";
116
my $PORTSDIR   = "/usr/ports/misc";
117
my $SRCDIR     = '@srcdir@';
118
my $TOP_SRCDIR = "@top_srcdir@";
119
my $RCDIR      = "/usr/local/etc/rc.d";
120 121

#
Robert Ricci's avatar
Robert Ricci committed
122
# And some lists that we use
123
#
124 125
my @LOCAL_HOSTS        = ($OURDOMAIN,$BOSSNODE,$USERNODE,$FSNODE);
my @LOGFILES           = ("/var/log/logins","/var/log/tiplogs/capture.log",
Robert Ricci's avatar
Robert Ricci committed
126
    "/var/log/mountd.log");
127 128
my @LOCAL_MAILING_LISTS = grep(/$OURDOMAIN$/,@MAILING_LISTS);
my @MAILING_LIST_NAMES  = map { /^([\w-]+)\@/ } @LOCAL_MAILING_LISTS;
Robert Ricci's avatar
Robert Ricci committed
129 130 131

my @TESTBED_DIRS       = ([$PREFIX, "0775"], ["/users", "0755"],
    ["/proj", "0755"], ["/groups", "0755"], ["/share", "0775"]);
132

133 134 135 136 137
#
# A few files we have to deal with
#
my $ELVIND_CONF     = "/usr/local/etc/elvind.conf";
my $OPS_ELVIND_CONF = "$TOP_OBJDIR/event/etc/elvind-ops.conf";
138
my $M2CRYPTO_PATCH  = "$TOP_SRCDIR/patches/m2crypto.patch";
139

140 141 142 143 144 145
#
# The meta-port (name and version) that drags in all the dependancies for
# an ops node
#
my $OPS_PORT = "emulab-ops-1.4";

146
#
Robert Ricci's avatar
Robert Ricci committed
147
# Make sure they know what they're getting into...
148
#
149 150 151 152 153 154 155 156
if (! $batchmode) {
    print STDERR
	"WARNING: This script is ONLY intended to be run on a machine\n";
    print STDERR
	"that is being set up as a dedicated ops node. Continue? [y/N] ";
    my $response = <>;
    die "Installation aborted!\n" unless ($response =~ /^y/i);
}
157
exit(0);
158

Robert Ricci's avatar
Robert Ricci committed
159 160
if ($UID != 0) {
    die "This script must be run as root.\n";
161 162 163
}

#
Robert Ricci's avatar
Robert Ricci committed
164
# The phases are fairly self-explanatory
165 166
#

Robert Ricci's avatar
Robert Ricci committed
167 168 169
Phase "groups", "Creating admin group", sub {
    if (getgrnam("tbadmin")) {
	PhaseSkip("tbadmin group already exists");
170
    }
Robert Ricci's avatar
Robert Ricci committed
171 172 173 174
    ExecQuietFatal("$PW groupadd tbadmin -g 101");
};

Phase "dirs", "Setting directory permissions", sub {
Robert Ricci's avatar
Robert Ricci committed
175 176
    foreach my $dirref (@TESTBED_DIRS) {
	my ($dir, $newmode) = @$dirref;
Robert Ricci's avatar
Robert Ricci committed
177 178 179 180
	Phase $dir, $dir, sub {
	    if (!-d $dir) {
		PhaseFail("Directory $dir does not exist");
	    }
Robert Ricci's avatar
Robert Ricci committed
181 182 183 184
	    # Use the real path, to avoid symlink problems
	    my $realdir = `realpath $dir`;
	    chomp $realdir;
	    my ($mode,$group) = (stat($realdir))[2,5];
Robert Ricci's avatar
Robert Ricci committed
185 186
	    # Fix up the mode (strip file type)
	    $mode = $mode & 0777;
Robert Ricci's avatar
Robert Ricci committed
187
	    if ($mode == eval $newmode && $group eq getgrnam("tbadmin")) {
Robert Ricci's avatar
Robert Ricci committed
188 189
		PhaseSkip("Already done");
	    }
Robert Ricci's avatar
Robert Ricci committed
190 191
	    ExecQuietFatal("$CHGRP tbadmin $realdir");
	    ExecQuietFatal("$CHMOD $newmode $realdir");
Robert Ricci's avatar
Robert Ricci committed
192
	};
193
    }
Robert Ricci's avatar
Robert Ricci committed
194
};
195

196
Phase "ports", "Installing ports", sub {
197 198 199 200 201 202 203 204 205
    Phase "packages", "Installing packages", sub {
	if (!ExecQuiet("$PKG_INFO -e $OPS_PORT")) {
	    PhaseSkip("Ports already installed");
	}
	if (!$packagedir) {
	    PhaseSkip("No package directory provided");
	}
	ExecQuietFatal("$ENV PKG_PATH=$packagedir $PKG_ADD $OPS_PORT");
    };
206
    Phase "pcopy", "Copying ports into place", sub {
207 208 209
	if ($packagedir) {
	    PhaseSkip("Package directory provided");
	}
210 211 212 213
	DoneIfExists("$PORTSDIR/emulab-ops");
	ExecQuietFatal("$SH $SRCDIR/ports/ports-install");
    };
    Phase "pinstall", "Installing ports (may take a while)", sub {
214
	if (!ExecQuiet("$PKG_INFO -e $OPS_PORT")) {
215 216
	    PhaseSkip("Ports already installed");
	}
217 218 219
	if ($packagedir) {
	    PhaseSkip("Package directory provided");
	}
220 221 222 223 224 225 226 227

	#
	# This port is dead-simple, so it's safe to do it from this script
	#
	my $pwd = `$PWD`;
	chomp $pwd;
	chdir "$PORTSDIR/emulab-ops" or
		PhaseFail "Unable to change to $PORTSDIR/emulab-ops: $!";
228
	ExecQuietFatal("make -DBATCH install");
229 230 231 232
	chdir $pwd;
    };
};

233 234
Phase "patches", "Applying patches", sub {
    Phase "m2cryptopatch", "Patching m2crypto", sub {
235
        if (!ExecQuiet("$PATCH -C -f -l -R -p0 -i $M2CRYPTO_PATCH")) {
236 237
            PhaseSkip("$M2CRYPTO_PATCH already applied");
        }
238
        ExecQuietFatal("$PATCH -f -p0 -l -i $M2CRYPTO_PATCH");
239 240 241
    };
}; 

Robert Ricci's avatar
Robert Ricci committed
242 243 244
Phase "rc.conf", "Adding testbed content to rc.conf", sub {
    DoneIfEdited($RCCONF);
    AppendToFileFatal($RCCONF,
Robert Ricci's avatar
Robert Ricci committed
245 246 247 248
		      qq|sendmail_enable="YES"|,
		      qq|nfs_server_enable="YES"|,
		      qq|nfs_server_flags="-u -t -n 16"|,
		      qq|syslogd_flags=""|);
Robert Ricci's avatar
Robert Ricci committed
249
};
250

Robert Ricci's avatar
Robert Ricci committed
251 252 253 254 255 256 257 258 259 260
Phase "sendmail","Configuring sendmail", sub {
    Phase "localhosts", "Setting up $LOCAL_HOSTNAMES", sub {
	DoneIfExists($LOCAL_HOSTNAMES);
	CreateFileFatal($LOCAL_HOSTNAMES,@LOCAL_HOSTS);
    };
    Phase "maillists", "Setting up mailing lists", sub {
	Phase "listdir", "Creating $LIST_DIR", sub { 
	    DoneIfExists($LIST_DIR);
	    mkdir($LIST_DIR,0755) or
		PhaseFail("Unable to create $LIST_DIR: $!");
261 262
	    ExecQuietFatal("$CHGRP mailnull $LIST_DIR");
	    ExecQuietFatal("$CHMOD 750 $LIST_DIR");
Robert Ricci's avatar
Robert Ricci committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
	};
	Phase "listfiles", "Creating mailing list files", sub {
	    foreach my $list (@MAILING_LIST_NAMES) {
		Phase $list, $list, sub {
		    DoneIfExists("$LIST_DIR/$list");
		    CreateFileFatal("$LIST_DIR/$list");
		};
	    }
	};
	Phase "aliases", "Adding lists to $ALIASES_FILE", sub {
	    DoneIfEdited($ALIASES_FILE);
	    AppendToFileFatal($ALIASES_FILE,
		map("$_:\t:include:$LIST_DIR/$_",@MAILING_LIST_NAMES));
	};
	Phase "newaliases", "Running newaliases", sub {
278
	    PhaseSkip("No new aliases") unless @MAILING_LIST_NAMES;
Robert Ricci's avatar
Robert Ricci committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
	    PhaseSkip("No new aliases") if PhaseWasSkipped("aliases");
	    ExecQuietFatal($NEWALIASES);
	};
    };
};


Phase "exports", "Setting up exports", sub {
    Phase "ex.head", "Creating $EXPORTS_HEAD", sub {
	DoneIfExists($EXPORTS_HEAD);

	#
	# Figure out which of these directories are on the same
	# filesystems
	#
294
	my @dirs = ('/users','/groups','/proj','/share','/var','/usr/testbed');
Robert Ricci's avatar
Robert Ricci committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308
	@dirs = map {`realpath $_`} @dirs;
	chomp @dirs;
	my %filesystems;
	foreach my $dir (@dirs) {
	    my ($dev,@junk) = stat $dir;
	    push @{$filesystems{$dev}}, $dir;
	}

	#
	# Use that knowledge to create lines for /etc/exports.head
	#
	my @exports_lines;
	foreach my $key (keys %filesystems) {
	    push @exports_lines,
Robert Ricci's avatar
Robert Ricci committed
309
		join(" ",@{$filesystems{$key}}) . "\t$BOSSNODE -maproot=root";
Robert Ricci's avatar
Robert Ricci committed
310 311 312 313 314 315 316 317 318
	}

	#
	# Put them in exports.head, and copy that to /etc/exports
	#
	CreateFileFatal($EXPORTS_HEAD, @exports_lines);
	ExecQuietFatal("cp $EXPORTS_HEAD $EXPORTS_FILE");
    };

319
    # XXX Newhup
Robert Ricci's avatar
Robert Ricci committed
320 321 322 323 324 325
    Phase "mountd", "HUPing mountd", sub {
	PhaseSkip("No new exports file") if PhaseWasSkipped("ex.head");
	PhaseSkip("mountd not running") unless `ps -auxw | grep mountd | grep -v grep`;
	ExecQuietFatal("killall -HUP mountd");
    };
};
326 327 328 329

#
# Set up syslog
#
Robert Ricci's avatar
Robert Ricci committed
330 331 332 333 334 335 336 337 338 339 340
Phase "syslog", "Setting up syslog", sub {
    Phase "sysconf", "Editing $SYSLOG_CONF", sub {
	DoneIfEdited($SYSLOG_CONF);
	
	#
	# Can't just append to this file, unfortunately. Have to put some of
	# the lines in the middle of the file
	#
	open(SC,"+<$SYSLOG_CONF") or
	    PhaseFail("Unable to open $SYSLOG_CONF : $!");
	my @sc = <SC>;
341 342 343
	if (scalar(grep(/$LOGFACIL/, @sc)) != 0) {
	    PhaseFail("Testbed chosen facility $LOGFACIL already in use in /etc/syslog.conf!");
	}
Robert Ricci's avatar
Robert Ricci committed
344 345
	if (scalar(grep(/^cron/, @sc)) != 1) {
	    PhaseFail("Unable to find marker in /etc/syslog.conf!");
346 347
	}

Robert Ricci's avatar
Robert Ricci committed
348 349 350 351 352
	#
	# Clobber and re-write
	#
	seek(SC,0,0);
	truncate(SC,0);
353

Robert Ricci's avatar
Robert Ricci committed
354
	foreach my $line (@sc) {
355 356 357 358 359 360 361
	    #
	    # Modify the /var/log/messages line to exclude testbed stuff
	    #
	    my $pat = q(\s+/var/log/messages);
	    if ($line =~ /^[^#].*$pat/) {
		$line =~ s/($pat)/\;$LOGFACIL.none$1/;
	    }
Robert Ricci's avatar
Robert Ricci committed
362
	    print SC $line;
363 364 365 366

	    #
	    # Find the cron line, after which we place our auth.info line
	    #
Robert Ricci's avatar
Robert Ricci committed
367 368 369 370 371 372
	    if ($line =~ /^cron/) {
		print SC "# " . MAGIC_TESTBED_START . "\n";
		print SC "auth.info\t\t\t\t\t/var/log/logins\n";
		print SC "# " . MAGIC_TESTBED_END . "\n";
	    }
	}
373

Robert Ricci's avatar
Robert Ricci committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
	#
	# Put a few more lines at the end
	#
	print SC "# " . MAGIC_TESTBED_START . "\n";
	print SC "!capture\n";
	print SC "*.*\t\t\t\t\t\t/var/log/tiplogs/capture.log\n";
	print SC "!mountd\n";
	print SC "*.*\t\t\t\t\t\t/var/log/mountd.log\n";
	print SC "# " . MAGIC_TESTBED_END . "\n";
	close SC;
    };

    Phase "tiplog", "Creating $TIPLOG_DIR", sub {
	DoneIfExists($TIPLOG_DIR);
	mkdir($TIPLOG_DIR,0755) or PhaseFail("Unable to make $TIPLOG_DIR : $!");
    };
    
    Phase "logfiles", "Creating log files", sub {
	foreach my $logfile (@LOGFILES) {
	    Phase $logfile, $logfile, sub {
		DoneIfExists($logfile);
		CreateFileFatal($logfile);
396
		ExecQuietFatal("$CHGRP tbadmin $logfile");
Robert Ricci's avatar
Robert Ricci committed
397 398 399 400 401 402 403 404 405 406 407 408 409 410
		ExecQuietFatal("$CHMOD 640 $logfile");
	    };
	}
    };

    Phase "newsyslog", "Setting up $NEWSYSLOG_CONF", sub {
	DoneIfEdited($NEWSYSLOG_CONF);
	AppendToFileFatal($NEWSYSLOG_CONF,
	    "/var/log/logins\t\t\t\t640  7     200 *      Z",
	    "/var/log/mountd.log\t\t\t640  5     200 *      Z",
	    "/var/log/tiplogs/capture.log\t\t644  7     *    168   Z");
    };
};

411 412 413 414
Phase "cron", "Adding cron jobs", sub {
    Phase "crontab", "Editing $CRONTAB", sub {
	DoneIfEdited($CRONTAB);
	AppendToFileFatal($CRONTAB,
415
	    "0 \t6\t*\t*\t*\troot\t$PREFIX/sbin/quotamail");
416 417 418 419 420 421 422
    };
    Phase "cronhup", "HUPing cron", sub {
	if (PhaseWasSkipped("crontab")) { PhaseSkip("No new crontab"); }
	HUPDaemon("cron");
    };
};

Robert Ricci's avatar
Robert Ricci committed
423 424 425 426
Phase "sudoers", "Editing $SUDOERS", sub {
    DoneIfEdited($SUDOERS);
    AppendToFileFatal($SUDOERS,"%wheel    ALL=(ALL) NOPASSWD: ALL");
};
427

Robert Ricci's avatar
Robert Ricci committed
428
Phase "ssh", "Allowing root ssh", sub {
Robert Ricci's avatar
Robert Ricci committed
429 430 431 432 433 434 435 436 437 438
    Phase "sshdconfig", "Permitting root login through ssh", sub {
	DoneIfEdited($SSHD_CONFIG);
	AppendToFileFatal($SSHD_CONFIG,"PermitRootLogin yes");
    };
    Phase "dotssh", "Making root's .ssh directory", sub {
	DoneIfExists("/root/.ssh");
	mkdir("/root/.ssh",0700) or
	    PhaseFail("Unable to create /root/.ssh: $!");
    };

Robert Ricci's avatar
Robert Ricci committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
};

Phase "capture", "Setting up capture", sub {
    Phase "rc.local", "Creating $RCLOCAL", sub {
	DoneIfExists($RCLOCAL);
	CreateFileFatal($RCLOCAL,
	    "if [ -f /etc/defaults/rc.conf ]; then",
	    "\t. /etc/defaults/rc.conf",
	    "fi",
	    "",
	    "if [ -x $RCCAPTURE ]; then",
	    "\techo -n \" capture\"",
	    "\t$RCCAPTURE",
	    "fi");
    };
    Phase "etc", "Creating $PREFIX/etc", sub {
	DoneIfExists("$PREFIX/etc");
	mkdir("$PREFIX/etc",0755) or
	    PhaseFail("Unable to create $PREFIX/etc: $!");
    };
    Phase "rc.capture", "Creating empty $RCCAPTURE", sub {
	DoneIfExists($RCCAPTURE);
	CreateFileFatal($RCCAPTURE,"#!/bin/sh");
	ExecQuietFatal("$CHMOD a+rx $RCCAPTURE");
    };
464 465
};

466 467
Phase "event", "Setting up event system", sub {
    Phase "elvinconf", "Installing elvind config file", sub {
468
	DoneIfIdentical($ELVIND_CONF,$OPS_ELVIND_CONF);
469 470 471 472
	ExecQuietFatal("$CP $OPS_ELVIND_CONF $ELVIND_CONF");
    };
};

473
Phase "rc.d", "Setting up rc.d scripts", sub {
474 475 476 477 478 479
    Phase "rsyncd", "Removing rsyncd startup script",  sub {
	DoneIfDoesntExist("$RCDIR/rsyncd.sh");
	if (!unlink "$RCDIR/rsyncd.sh") {
	    PhaseFail("Unable to remove $RCDIR/rsyncd.sh: $!");
	}
    };
480
    Phase "rc.testbed", "Installing testbed RC scripts", sub {
481 482 483 484
        Phase "elvind.sh", "Removing port version of elvind.sh", sub {
	    DoneIfDoesntExist("$RCDIR/elvind.sh");
            ExecQuietFatal("/bin/rm -f $RCDIR/elvind.sh");
        };
485 486 487 488 489
	DoneIfExists("$RCDIR/2.elvind.sh");
	ExecQuietFatal("$GMAKE -C $TOP_OBJDIR/rc.d control-install");
    };
};

490 491 492
print "----------------------------------------------------------------------\n";
print "Installation completed succesfully!\n";
print "Please reboot this machine before proceeding with boss setup\n";
Robert Ricci's avatar
Robert Ricci committed
493
if (!PhaseWasSkipped("maillists")) {
494
    print "Local mailing lists have been created, with no members, in\n";
Robert Ricci's avatar
Robert Ricci committed
495
    print "$LIST_DIR . Please add members to the following lists:\n";
496
    print map "$_\n", @LOCAL_MAILING_LISTS;
497
}