Difference between revisions of "Deployment Platform/Sneakernet"

Latest revision as of 01:21, 4 June 2013

Background

This is one of possible deployment scenarios of Deployment_Platform. This page is intended to describe procedures for school servers and end users in Internet-less environment. Using predefined recipes, it should be possible to fully support such deployments.

Targeting environment

The standard targeting environment, final environment might be similar, assumes:

Particular deployment, e.g., a school, without Internet access.
Lack of technical personal when in most cases only not IT skilled teachers have access to school servers.
Lack of dedicated hardware for school servers, server side software will be launched on teacher's XO laptop (XO-1.5 is preferred).
School server's client connected to school server XO using Ad-hoc wireless connection.
The only way to synchronize school servers with each other and with the master one, is a sneakernet.

The scenario assumes keeping Sugar Network node server launched on teacher's XO which provides Sugar Network access to students around. Teacher's and students' XO should be flashed with special Sugar with Sugar Network integration. It might be one of reference images or final deployment ones like Hexoquinasa.

Teacher's XO

Sugar Network volume

To make process of choosing server XO more flexible, entire Sugar Network node data should be stored on separate removable device, SD card of USB stick. Any XO can be turned into Sugar Network node by plugging such volume.

To make removable media capable to store Sugar Network data:

Create sugar-network directory in the root.

In order to make XO server capable:

Enable server mode checkbox in Sweets Distribution section in Sugar Control Panel, or, if this sections is disabled, populate /etc/sweets.conf configuration file (it might be done on XO image creation stage):

[client]
server-mode = True

Initiate Ad-Hoc wireless session from the Neighborhood View in the Sugar Shell to let students connect to Sugar Network server;

Plug prepared Sugar Network volume.

Synchronization

Note that newly prepared Sugar Network volume will be empty, initial content should be fetched from the master node. Due to offline nature of this scenario, synchronization will happen via sneakernet, i.e., using synchronization files placed to regular removable volumes, e.g., USB sticks.

To make removable volume capable to handle synchronization files:

Create sugar-network-sync directory in the root.

The synchronization workflow looks like:

Plug prepared synchronization volume to server XO;
Wait for Sugar alert which says that synchronization is complete;
Unplug synchronization volume from server XO;
Plug synchronization volume to a machine which is connected to the Internet;
Run sugar-network-sync shell script from synchronization volume (it will be created while synchronizing on server XO);
Wait until finishing script work, it will upload server XO files and download master server response;
Bring synchronization volume back to server XO and start from the 1st step.

Students' XO

In order to point students' XO to the teacher's Sugar Network node, enable auto server discovering radio-box in the Sweets Distribution section in Sugar Control Panel, or, if this sections is disabled, populate /etc/sweets.conf configuration file (it might be done on XO image creation stage):

[client]
discover-server = True

Then, connect to wireless Ad-Hoc, and, in some time, F8 view will expose teacher's Sugar Network content.

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: @@
-== Summary ==
-This is [[Harmonic_Distribution/Deployment|one of possible]] deployment scenarios of [[Harmonic Distribution]].
 == Background ==
-This page is intended to describe the process of offline synchronization between school servers in [[#Targeting_environment|targeting]], or, similar environments. Using [[#Recipes|predefined recipes]], it should be possible to synchronize the complete set of [[#Synchronization_content|content]] to let school servers, and clients they serve, behave in regular mode.
+This is [[Deployment_Platform/Deployment|one of possible]] deployment scenarios of [[Deployment_Platform]]. This page is intended to describe procedures for school servers and end users in [[#Targeting_environment|Internet-less]] environment. Using [[#Recipes|predefined recipes]], it should be possible to fully support such deployments.
-=== Targeting environment ===
+<big>'''Targeting environment'''</big>
 The standard targeting environment, final environment might be similar, assumes:
@@ Line 17: / Line 13: @@
 * The only way to synchronize school servers with each other and with the master one, is a [[wikipedia:Sneakernet|sneakernet]].
-=== Synchronization content ===
+The scenario assumes keeping Sugar Network node server launched on teacher's XO which provides Sugar Network access to students around. Teacher's and students' XO should be flashed with special Sugar with Sugar Network integration. It might be [[Deployment_Platform/XO_reference_distribution#Try_reference_implementation|one of reference images]] or final deployment ones like [http://pe.sugarlabs.org/go/Proyecto_Piloto_Hexoquinasa Hexoquinasa].
-The synchronization content includes all data that needs to be accessible from a school server to support complete life cycle of served clients. These are:
-* Base software updates to proceed unattended upgrade on server and client sides.
-* Unattended configuration for school server and clients.
-* Optional upload to master server of [[Platform_Team/Usage_Statistics|usage statistics]].
-* [[Sugar Network]] content, intended to cover all other needs.
-=== Objects ===
-What kind of objects involved to the process:
-* '''Master server'''<br>Main Sugar Network server accessible via the Internet. Each Master server has public API url. This tutorial is using http://api-testing.network.sugarlabs.org to refer to testing Sugar Network Master launched on Sugar Labs server.
-* '''Node servers'''<br>Local Sugar Network servers that are intended to be distributed versions of the Master. This tutorial assumes that Nodes don't have direct connection to the Master, and the only one way to synchronize data is the [[wikipedia:Sneakernet|Sneakernet]].
-* '''Database media'''<br>Node servers might store database on removable devices (makes sense if Nodes are XO laptops), in that case, such devices should have a magic file, named {{Code|.sugar-network}}, in the root directory on removable device. Having this magic file will let Node's software auto detect recently plugged removable device as a Database media to start behaving correspondingly.
-* '''Synchronization media'''<br>Removable media device, e.g., USB stick or SD card that will be used to transfer Packets between servers. Synchronization media should have a magic file, named {{Code|.sugar-network-sync}}, in the root directory. Having this file will let Node's software start synchronization process automatically after plugging media.
-* '''Synchronization packets'''<br>Regular files that contain synchronization data placed to Synchronization media. Packet files are [[wikipedia:Tar_(file_format)|tarballs]] with {{Code|.packet}} file name suffix.
-== Recipes ==
-A list of scenarios to follow in the field.
-=== Clone Master ===
-On a box with Internet available, plug Synchronization media. Its mount point will be referred as {{Code|MOUNTPOINT}} in text below.
-If {{Code|sugar-network}} package is installed, run the following command:
- sugar-network-sync MOUNTPOINT http://api-testing.network.sugarlabs.org/
+== Teacher's XO ==
-Otherwise,
+=== Sugar Network volume ===
-* using any regular Web downloader, e.g., {{Code|wget}} or {{Code|curl}}, fetch clone data using http://api-testing.network.sugarlabs.org/?cmd=pull url (the first try might return empty file, in that case, retry in a minute);
+To make process of choosing server XO more flexible, entire Sugar Network node data should be stored on separate removable device, SD card of USB stick. Any XO can be turned into Sugar Network node by plugging such volume.
-* place fetched data to {{Code|MOUNTPOINT}} with to a file with {{Code|.packet}} suffix;
+To make removable media capable to store Sugar Network data:
-* create empty file in {{Code|MOUNTPOINT}} named as {{Code|.sugar-network-sync}}.
+* Create {{Code|sugar-network}} directory in the root.
-=== Run Node server on Sugar box ===
+In order to make XO server capable:
-This mode is useful when there is no dedicated hardware for school server. In that case, particular XO laptop might be a Node server, e.g., one that teacher has.
+* Enable server mode checkbox in ''Sweets Distribution'' section in Sugar Control Panel, or, if this sections is disabled, populate {{Code|/etc/sweets.conf}} configuration file (it might be done on XO image creation stage):
-* Prepare Database media. Place the following files to the root of removable device that is intended to be a Database media:
+ [client]
-** {{Code|.sugar-network}} file;
+ server-mode = True
-** {{Code|master}} file with {{Code|api-testing.network.sugarlabs.org}} content, will be Master's GUID;
-** {{Code|node}} file with arbitrary string content, will be Node's GUID.
-* On a box that is intended to be a Node server; in ''Sweets Distribution'' Control Panel section, enable ''Behave as a Sugar Network server..'' checkbox (will require restarting Sugar Shell).
+* Initiate Ad-Hoc wireless session from the Neighborhood View in the Sugar Shell to let students connect to Sugar Network server;
-* Plug prepared Database media.
+* Plug prepared Sugar Network volume.
-* Plug Synchronization media with [[#Clone Master|initial data]].
+=== Synchronization ===
-In current implementation, the initial process on Node side will take some time (30min on XO-1.5 laptop) to merge synchronization data.
+Note that newly prepared Sugar Network volume will be empty, initial content should be fetched from the master node. Due to offline nature of this scenario, synchronization will happen via [[wikipedia:Sneakernet|sneakernet]], i.e., using synchronization files placed to regular removable volumes, e.g., USB sticks.
-=== Run clients ===
+To make removable volume capable to handle synchronization files:
-* Make sure that Node server and all clients are in the same local network, e.g., wireless Ad-hoc.
+* Create {{Code|sugar-network-sync}} directory in the root.
-* Client Sugar boxes should enable ''Auto discover server in local network'' radio-box in ''Sweets Distribution'' Control Panel section.
+The synchronization workflow looks like:
-* Client should see Node content as a ''Network'' content.
+# Plug prepared synchronization volume to server XO;
+# Wait for Sugar alert which says that synchronization is complete;
+# Unplug synchronization volume from server XO;
+# Plug synchronization volume to a machine which is connected to the Internet;
+# Run {{Code|sugar-network-sync}} shell script from synchronization volume (it will be created while synchronizing on server XO);
+# Wait until finishing script work, it will upload server XO files and download master server response;
+# Bring synchronization volume back to server XO and start from the 1st step.
-Current implementation is fragile in case of detecting local Node server, if Node content is not available on client side, try to restart Sugar.
+== Students' XO ==
-=== Synchronize Node on Sugar box ===
+In order to point students' XO to the teacher's Sugar Network node, enable auto server discovering radio-box in the ''Sweets Distribution'' section in Sugar Control Panel, or, if this sections is disabled, populate {{Code|/etc/sweets.conf}} configuration file (it might be done on XO image creation stage):
-On a Node box,
+ [client]
+ discover-server = True
-* plug Synchronization media to let Node read input and write output Synchronization packets;
+Then, connect to wireless Ad-Hoc, and, in some time, F8 view will expose teacher's Sugar Network content.
-* wait until Sugar Shell will alert with ''Synchronization complete..'' message;
-* unplug Synchronization media.
-On a box that has Internet available,
+== Getting involved ==
-* plug Synchronization media;
+{{:Deployment_Platform/Feedback}}
-* run {{Code|sugar-network-sync}} script (placed by Node while synchronizing) from its root and wait until it will finish uploading and downloading Synchronization packet files;
-* then, repeat Node box steps.