Deploying the MS

You can run the MS in one of two ways: as a Google AppEngine Python app, or as an AppScale Python app. You can also run it locally (i.e. in a test environment) with the Google AppEngine SDK.

Before you set up your MS, you will need to set up an administrator account, and choose an OpenID server to authenticate users (right now, the MS is hardwired to use the VICCI OpenID server, but this will be fixed soon. -jude).

Then, you can build and set up the MS with the following command. It will compile the MS and install the admin account information.

$ scons MS user_id=YOUR.ADMIN.EMAIL@EXAMPLE.COM \
           syndicate_name=YOUR-SYNDICATE-NAME \
           register_password=YOUR-ACTIVATION-PASSWORD

Required Arguments

• user_id must be an email address, and will be the name of the admin account.
• syndicate_name is the application name that goes into the app.yaml file.
• registration_password is a one-time-use password you'll use to activate your admin account.

Optional Arguments

• openid_url refers to your public OpenID identity page.
• pubkey refers to your admin account public key. It must be a 4096-bit PEM-encoded RSA public key.
• syndicate_private_key refers to the Syndicate private key. It must be a 4096-bit PEM-encoded RSA private key.

Now you can deploy the MS. For example, to deploy to Google AppEngine, you simply use Google's appcfg.py script to upload the MS you just built to the AppEngine PaaS:

$ appcfg.py update build/out/ms

Once the MS is up and running, you need to set up the Syndicate management tool syntool.py, so you can go on to create users, Volumes, and Gateways. You'll need to give it your administrator's email address and public key, as well as the URL to the MS's API (usually, this is the MS's hostname, followed by /api). To do so, simply run:

$ syntool.py --user_id YOUR.EMAIL@EXAMPLE.COM \
             --url https://YOUR.RUNNING.MS/api \
             setup

• user_id is the same email address you provided to the MS admin account.
• url is the URL to the MS

You will be prompted for your admin activation password and your OpenID password.

From start to finish, here's a simple recipe that builds, sets up, and deploys the MS on Google AppEngine.

$ # Build and deploy the MS
$ scons MS user_id=YOUR.ADMIN.EMAIL@EXAMPLE.COM \
           register_password=YOUR-ADMIN-ACTIVATION-PASSWORD \
           syndicate_name=YOUR-SYNDICATE-NAME
$ appcfg.py update build/out/ms
$ syntool.py --user_id admin@syndicatedrive.com \
             --url https://syndicate-drive-ms.appspot.com/api \ 
             setup