sas2_help.txt

Scripts and JARs from sas2 project
----------------------------------

$Id: sas2_help.txt,v 1.6 2001/10/19 11:44:12 nik Exp $

sas2.jar
--------

Usage:   java -jar sas2.jar <dir> <app_desc_in> <boot_desc_out>

Creates descriptor to start a SAS service.

Arguments:

    <dir>
        Base directory in which it will run, containing all the relevant
        Jtrix JARs.
    <app_desc_in>
        Required application descriptor of the SAS.
    <boot_desc_out>
        Generated netlet descriptor of SAS, to be used on booting
        a hosting service to give it a SAS. The script sas2_init creates
        this as <name>-boot.xml. See the example there for more details.


sas2_init
---------

Usage: sas2_init <name>

Creates descriptor to start a SAS service, using sas2.jar. Expects
a public/private key pair in <name>.pub and <name>.prv, but will generate
them if not found.

The resulting netlet descriptor, <name>-boot.xml, expects parameters
as in the following example (see below for argument details):

    jtrixd <node_id> <usual_hospitality_parameters> \
        <name>-boot.xml hosting-in=<h_warr> [hosting-out=<h_out>] \
            [sas-out=<s_warr>] [sas-desc=<s_desc>]

Therefore, here is an example of how to start a new node in an
existing hosting service so that it starts with SAS:

    hospitality_init fred
    sas2_init jim
    jtrixd 100 fred-boot.xml hosting-out=fred-admin.xml \
        jim-boot.xml hosting-in=fred-boot-admin.xml \
            hosting-out=fred-real-admin.xml sas-out=sas-warrant.xml

Arguments:

    <name>
        String name of the SAS service. Should not contain spaces.
        Should not be the same as the hosting service name.
    <h_warr>
        Required hosting controller (admin) warrant.
    <h_out>
        Generated hosting admin warrant, for a hosting service which
        uses this SAS.
    <s_warr>
        Generated SAS admin warrant.
    <s_desc>
        Generated SAS netlet descriptor, which uses itself as a SAS.

Files:

    <name>.prv
        Expected/generated private key for the SAS.
    <name>.pub
        Expected/generated public key for the SAS.
    <name>.xml
        Generated launch descriptor to launch SAS via the launcher
        console.
    <name>-boot.xml
        Generated netlet descriptor to start SAS when a node starts.

(ends)