Difference between revisions of "Deployment Platform/Gateway"

Latest revision as of 22:06, 20 August 2013

Background

This is one of the possible deployment scenarios for Deployment Platform. This page is intended to describe procedures for school servers that behave as gateways for school students.

Targeting environment

The standard targeting environment assumes:

Dedicated hardware for school server;
Client machines connected via Intranet to the server.

The final environment might be similar.

Server side

Run Sugar Network node

Attach 0.94:SugarNetwork Sweets Distribution repository and install the sugar-network package.

Before running installed server, populate the /etc/sugar-network/config configuration file with content similar to the following (to get the full list of configuration options, call the sugar-network-node config command):

[main]
# debug logging level; 0 means only warning and errors
debug = 3

# path to a directory to place log files
logdir = /var/log/sugar-network

# path to a directory to place pid files
rundir = /var/run/sugar-network

# if specified, use this directory for cached files; such files might take
# considerable number of bytes
cachedir = /var/cache/sugar-network

[node]
host = 0.0.0.0
port = 8000

# directories to place server data
data-root  = /var/lib/sugar-network/db
files-root = /var/lib/sugar-network/files
stats-root = /var/lib/sugar-network/stats

# switch off user credentials check; disabling this option will require
# OpenSSH-5.6 or later
trust-users = True

Make sure that all directories in the config file are created and the current user has write permissions there.

Run node server:

sugar-network-node start

Server will start serving Sugar Network API for clients from host:port specified in configuration file.

Synchronization with master node

Note that the newly installed Sugar Network node will be empty, its content should be fetched from the master node.

If school server has Internet connectivity, launch sugar-network-node and start online synchronization:

sugar-network-node online-sync

If only sneakernet is available:

sugar-network-node offline-sync PATH-TO-PLACE-SYNCHRONIZATION-FILES

The PATH-TO-PLACE-SYNCHRONIZATION-FILES path will contain files that should be uploaded to the master to download response. Postponed synchronization will happen by running the sugar-network-sync shell script (which will be created by offline-sync command in targeting path) in environment with Internet connectivity. Then, re-run offline-sync command specifying path with new file synchronization files.

Client side

Configuration

Clients should be pointed to the Sugar Network node launched on a school server. Populate the /etc/sweets.conf configuration file with the following options:

[client]
api-url = http://SCHOOL-SERVER-HOST-HERE:8000

Run Sugar Network clients

Follow the Try it install instructions to setup Sugar Network client.

While working, Sugar Network client logs can be found in the ~/.sugar/default/logs/sugar-network-client file. The logging verbosity level depends on the global Sugar setting.

Getting involved

Subscribe to the sugar-devel mailing list and email with the subject prefixed with [PLATFORM].
Ask your question on IRC channels, #sugar (not logged) or #sugar-newbies (logged).

@@ Line 1: / Line 1: @@
 == Background ==
-This is [[Deployment_Platform/Deployment|one of possible]] deployment scenarios of [[Deployment_Platform]]. This page is intended to describe procedures for school servers that behave as gateways for school students.
+This is [[Deployment_Platform/Deployment|one of the possible]] deployment scenarios for [[Deployment Platform]]. This page is intended to describe procedures for school servers that behave as gateways for school students.
-=== Targeting environment ===
+<big>'''Targeting environment'''</big>
-The standard targeting environment, final environment might be similar, assumes:
+The standard targeting environment assumes:
-* School server;
+* Dedicated hardware for school server;
 * Client machines connected via Intranet to the server.
+The final environment might be similar.
 == Server side ==
@@ Line 14: / Line 15: @@
 === Run Sugar Network node ===
-[[Sweets_Distribution#Add_repository|Attach]] ''Factory'' [[Sweets Distribution]] repository and install {{Code|sugar-network}} package.
+[[Sweets_Distribution#Add_repository|Attach]] 0.94:SugarNetwork [[Sweets Distribution]] repository and install the {{Code|sugar-network}} package.
-Before running server, populate the {{Code|/etc/sugar-network/config}} configuration file with content similar to following (to get full list of configuration options, call the {{Code|sugar-network-node config}} command):
+Before running installed server, populate the {{Code|/etc/sugar-network/config}} configuration file with content similar to the following (to get the full list of configuration options, call the {{Code|sugar-network-node config}} command):
   [main]
+ # debug logging level; 0 means only warning and errors
+ debug = 3
   # path to a directory to place log files
   logdir = /var/log/sugar-network
@@ Line 33: / Line 37: @@
   port = 8000
-  # path to a directory to place server data
+  # directories to place server data
-  data-root = /var/lib/sugar-network
+  data-root  = /var/lib/sugar-network/db
+ files-root = /var/lib/sugar-network/files
+ stats-root = /var/lib/sugar-network/stats
   # switch off user credentials check; disabling this option will require
@@ Line 40: / Line 46: @@
   trust-users = True
-Make sure that all directories in config file are created and current user have write permissions there.
+Make sure that all directories in the config file are created and the current user has write permissions there.
 Run node server:
@@ Line 50: / Line 56: @@
 === Synchronization with master node ===
-Note that newly installed Sugar Network node will be empty, its content should be fetched from the master node.
+Note that the newly installed Sugar Network node will be empty, its content should be fetched from the master node.
 If school server has Internet connectivity, launch {{Code|sugar-network-node}} and start online synchronization:
@@ Line 60: / Line 66: @@
   sugar-network-node offline-sync ''PATH-TO-PLACE-SYNCHRONIZATION-FILES''
-Last command path will contain files that should be uploaded to the master to download response. Postponed synchronization will happen by running {{Code|sugar-network-sync}} shell script (which will be created by {{Code|offline-sync}} command in targeting path) in environment with Internet connectivity. Then, re-run {{Code|offline-sync}} command specifying path with new file synchronization files.
+The {{Code|PATH-TO-PLACE-SYNCHRONIZATION-FILES}} path will contain files that should be uploaded to the master to download response. Postponed synchronization will happen by running the {{Code|sugar-network-sync}} shell script (which will be created by {{Code|offline-sync}} command in targeting path) in environment with Internet connectivity. Then, re-run {{Code|offline-sync}} command specifying path with new file synchronization files.
 == Client side ==
-=== Configuration ===
+<big>'''Configuration'''</big>
-Clients should be pointed to the Sugar Network node launched on a school server. Populate {{Code|/etc/sweets.conf}} configuration file with the following options:
+Clients should be pointed to the Sugar Network node launched on a school server. Populate the {{Code|/etc/sweets.conf}} configuration file with the following options:
   [client]
   api-url = http://''SCHOOL-SERVER-HOST-HERE'':8000
-=== Run Sugar Network clients ===
+<big>'''Run Sugar Network clients'''</big>
-Right now, the easiest way to get working Sugar Network clients is using Sugar Shell with embedded Sugar Network support.
-On XO laptops, use [[Deployment_Platform/XO_reference_distribution#Try_reference_implementation|one of reference images]] or final deployment ones like from [http://pe.sugarlabs.org/go/Proyecto_Piloto_Hexoquinasa Hexoquinasa] project.
+Follow the [[Sugar_Network#On_desktop|Try it]] install instructions to setup Sugar Network client.
-On regular desktops:
+While working, Sugar Network client logs can be found in the {{Code|~/.sugar/default/logs/sugar-network-client}} file. The logging verbosity level depends on the [[BugSquad/Get_Logs#Enabling_Sugar_debug_logging|global Sugar setting]].
-* [[Sweets_Distribution#Add_repository|Attach]] ''Factory'' [[Sweets Distribution]] repository;
+== Getting involved ==
-* [[Sweets_Distribution#Installation|Install]] {{Code|sweets-desktop}} package;
-* [[Sweets_Distribution#Usage|Run]] newly installed Sugar Shell;
-* By default, Sugar Shell looks the same as in pristine Glucose. To start using Sugar Network related improvements in the Shell UI, go to the Sweets Distribution component in the Control Panel, enable the integration checkbox, and restart Sugar. After restarting, [[Platform_Team/Sugar_Network/Web_UI|Web UI]] client will be available from the Activities tray and the F8 shortcut key. [[Sugar_Network/Contributor_Hub|Contributor Hub]] client can be launched from F8 as regular Sugar Network application.
-Sugar Network client logs can be found {{Code|~/.sugar/default/logs/sugar-network-client}} file. Logging verbosity level depends on [[BugSquad/Get_Logs#Enabling_Sugar_debug_logging|global Sugar setting]].
+{{:Deployment_Platform/Feedback}}