Changeset 2b35261 for fedkit/active_config.pl

Timestamp:

Feb 1, 2010 10:43:24 AM (15 years ago)

Author:

Ted Faber <faber@…>

Branches:

axis_example, compt_changes, info-ops, master, version-3.01, version-3.02

Children:

b73cc45

Parents:

2edec46

Message:

Initial docs

File:

• fedkit/active_config.pl (modified) (1 diff)

fedkit/active_config.pl

@@ -55 +55 @@
 $f->close();
 exit(0);
+
+=pod
+
+=head1 NAME
+
+B<active_config.pl> - Configure an active connectivity gateway under the DETER Federation Architecture
+
+=head1 OPTIONS
+
+=over 8
+
+=item B<fedkit=>I<install_dir>
+
+Directory in which this software is installed.  Generally not needed.
+
+=item B<interfaces=>I<interface table>
+
+A list of interfaces to forward data on of the form:
+
+=begin text
+
+iface ip_addr
+
+=end text
+
+The interface is the operating system name of the interface and the IP address
+is given in standard dotted decimal notation.  Other characters on a line are
+ignored.
+
+=item B<peer=>I<hostname>
+
+The other gateway providing forwarding.
+
+=item B<perl=>I<perl_binary>
+ 
+Location of the perl binary.  Usually unneeded.
+
+=item B<ssh=>I<ssh_binary>
+
+The pathname of the ssh binary.  Unusally unnecessary.
+
+=item B<ssh_pubkey=>I<keyfile>
+
+A public to install as authorized.
+
+=item B<ssh_privkey=>I<identity_file>
+
+The identity to use for remote access
+
+=item B<tunnelip>
+
+True if the testbed uses the DETER tunnelip extension to provide external
+connectivity information
+
+=back
+
+=head1 SYNOPSIS
+
+B<active_config.pl> initiates the active side of the connectivity connection,
+which is to say that it:
+
+=over 4
+
+=item *
+
+Installs local keys and reconfigures that local ssh system to do link layer
+tunneling.
+
+=item *
+
+Starts a tunnel for each interface in the given interface table, both locally
+and remotely.
+
+=back
+
+=head1 AUTHORS
+
+Ted Faber <faber@isi.edu>
+
+=cut