Added the possibility for users to define a set of information fields
[sfa.git] / INSTALL.txt
index 0f2f0ba..d748883 100644 (file)
@@ -1,28 +1,37 @@
 This installation note assumes that you have installed and configured MyPLC in the usual manner, and you have set up your yum repo like for a MyPLC install.
+
+Once you have completed the server configuration, a brief introduction to the SFA user tools is here:
+    http://svn.planet-lab.org/wiki/SFAGuide
+
 -----
 1) Install the SFA packages:
 
 # yum install sfa-plc sfa-client
 
-Note that the above command installs both sfa server (sfa-plc) and sfa client packages along with necessary dependency packages. Depending on the requirements, you may choose 
-to install the appropriate one (server, client or both) for you. For e.g. to set up your own SFA server on top of your MyPLC, you need sfa-plc. On the other hand, if you plan to use an existing SFA server, you would typically need the sfa-client only.
+Note that the above command installs both sfa server (sfa-plc) and sfa client packages along with necessary dependency packages. Depending on the requirements, you may choose to install the appropriate one (server, client or both) for you. For e.g. to set up your own SFA server on top of your MyPLC, you need sfa-plc. On the other hand, if you plan to use an existing SFA server, you would typically need the sfa-client only.
 -------
-2) Note down the PLC_ROOT_USER and PLC_ROOT_PASSWORD of your MyPLC installation:
+2) Note down the PLC_ROOT_USER, PLC_ROOT_PASSWORD, PLC_DB_USER and PLC_DB_PASSWORD of your MyPLC installation:
 
 # plc-config-tty 
 Enter command (u for usual changes, w to save, ? for help) s PLC_ROOT_USER
 PLC_ROOT_USER = root@test.onelab.eu
 Enter command (u for usual changes, w to save, ? for help) s PLC_ROOT_PASSWORD
 PLC_ROOT_PASSWORD = test++
+Enter command (u for usual changes, w to save, ? for help) s PLC_DB_USER
+PLC_DB_USER = pgsqluser
+Enter command (u for usual changes, w to save, ? for help) s PLC_DB_PASSWORD
+PLC_DB_PASSWORD = 4a333aba-a322-41b1-9c05-90b4f34d1332
 
-These two configuration parameters are required for SFA server configuration
+These four configuration parameters are required for SFA server configuration
 -------
 3) Configure and start SFA servers: 
 
 (a) # sfa-config-tty
 
- set SFA_PLC_USER      to     PLC_ROOT_USER 
- set SFA_PLC_PASSWORD  to     PLC_ROOT_PASSWORD
+ set SFA_PLC_USER              to     PLC_ROOT_USER 
+ set SFA_PLC_PASSWORD          to     PLC_ROOT_PASSWORD
+ set SFA_PLC_DB_USER                   to     PLC_DB_USER
+ set SFA_PLC_DB_PASSWORD       to     PLC_DB_PASSWORD
 write and quit
 
 *NOTE* at this point you get a warning b/c the authorities hierarchy has not been created yet; ignore
@@ -34,7 +43,7 @@ Import: creating top level authorities
 Hierarchy: creating authority: plc
 plc : 
 Import: creating table for authority plc
-NOTICE:  table "geni$plc" does not exist, skipping
+NOTICE:  table "sfa$plc" does not exist, skipping
   inserting authority record for plc
 Import: adding plc to trusted list
 Import_Site: importing site plc.internet2
@@ -45,11 +54,13 @@ Hierarchy: creating authority: plc.pl
   inserting authority record for plc.pl
 Import: importing person plc.pl.root
 Import: creating table for authority plc.pl
-NOTICE:  table "geni$plc$pl" does not exist, skipping
+NOTICE:  table "sfa$plc$pl" does not exist, skipping
 
-(c) # service sfa start
+(c)  run sfa-config-tty again and select q to come out of the config command
+This will initialize /etc/sfa/authorities/server.key from /etc/sfa/authorities/plc/plc.pkey 
 
-This will start Registry, Slice Manager and Aggregate Manager. Your ps command output would like:
+(d) # service sfa start
+This will start Registry, Slice Manager and Aggregate Manager. Your ps command output would look like:
 
 # ps -ef | grep python
 root     24944     1  0 May11 ?        00:00:00 /usr/bin/python /usr/bin/sfa-server.py -r -d
@@ -59,16 +70,15 @@ root     24970     1  0 May11 ?        00:00:00 /usr/bin/python /usr/bin/sfa-ser
 4) Configure SFA client:
 
  (a) # mkdir ~/.sfi 
- (b)copy your private key to ~/.sfi/username.pkey Replace username with your actual account name 
+ (b)copy your private RSA key to ~/.sfi/username.pkey Replace username with your actual account name.  NOTE: DSA KEYS WILL NOT WORK
  (c) # cp  /etc/sfa/sfi_config ~/.sfi/
  (d) edit ~/.sfi/sfi_config. A sample configuration looks like:
 
-       export SFI_AUTH=plc.pl
-       export SFI_USER=plc.pl.root
-       export SFI_REGISTRY=http://vplc25.inria.fr:12345/
-       export SFI_SM=http://vplc25.inria.fr:12347/ 
+       SFI_AUTH='plc.pl'
+       SFI_USER='plc.pl.root'
+       SFI_REGISTRY='http://vplc25.inria.fr:12345/'
+       SFI_SM='http://vplc25.inria.fr:12347/' 
 
- (e) # source ~/.sfi/sfi_config 
 ------
 5) Testing:
 
@@ -107,7 +117,7 @@ At this stage you should be able to run sfi command. Some sample outputs are:
 
  (e) # sfi.py resources
 <?xml version="1.0" ?>
-<Rspec duration="3600" start_time="1246736949"><networks><NetSpec duration="3600" name="plc" start_time="1246736950"><nodes><NodeSpec cpu_min="" cpu_pct="" cpu_share="" disk_max="" duration="" init_params="" name="pif.inria.fr" start_time="" type=""><net_if><IfSpec addr="138.96.250.224" init_params="" ip_spoof="" max_kbyte="" max_rate="" min_rate="" name="True" type="ipv4"/></net_if></NodeSpec></nodes></NetSpec></networks></Rspec>
+<RSpec duration="3600" start_time="1246736949"><networks><NetSpec duration="3600" name="plc" start_time="1246736950"><nodes><NodeSpec cpu_min="" cpu_pct="" cpu_share="" disk_max="" duration="" init_params="" name="pif.inria.fr" start_time="" type=""><net_if><IfSpec addr="138.96.250.224" init_params="" ip_spoof="" max_kbyte="" max_rate="" min_rate="" name="True" type="ipv4"/></net_if></NodeSpec></nodes></NetSpec></networks></RSpec>
 ------
 
 6) Federation configuration: