Difference between revisions of "Deployment Platform/1.1/Notes"

From Sugar Labs
Jump to navigation Jump to search
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Summary ==
 
== Summary ==
  
This is the first Sugar Server Kit release that is being positioned as ready for using in the field, thanks to the [[Sugar_Server_Kit/Solutions/Paraguay_Educa_Server|Paraguayan pilot program]]. This release should fulfill needs similar to that were faced in Paraguay. The next step will be proving this system in restricted environments within the [[Sugar_Server_Kit/Solutions/Server_on_an_XO|Server on an XO]] project for SSK-1.2.
+
This is the first Sugar Server Kit release that is being positioned as ready for use in the field, thanks to the [[Sugar_Server_Kit/Solutions/Paraguay_Educa_Server|Paraguayan pilot program]]. This release should fulfill needs similar to those faced in Paraguay. The next step will be proving this system for restricted environments within the [[Sugar_Server_Kit/Solutions/Server_on_an_XO|Server on an XO]] project for SSK-1.2.
  
This is also the first release that is following the [[Sugar_Server_Kit/Release_plan|Sugar Server Kit releasing plan]].
+
This is also the first release that is following the [[Sugar_Server_Kit/Release_plan|Sugar Server Kit release plan]].
  
 
== Design changes ==
 
== Design changes ==
  
Changes made from initial, 1.0, Sugar Server Kit implementation.
+
Changes made from the initial, [[Sugar_Server_Kit/1.0/Notes#Components|1.0]], Sugar Server Kit implementation.
  
 
'''Unified API for sugar-server'''
 
'''Unified API for sugar-server'''
  
:: The major way to interact with sugar-server for now, is a [[Sugar_Server_Kit/sugar-server#Services|RESTfull API]]. The API inherited from the OLPC XS is preserved when it is possible, e.g., except Journal backups that were implemented differently from the begining.
+
:: The major way to interact with sugar-server for now, is a [[Sugar_Server_Kit/sugar-server#Services|RESTfull API]]. The API inherited from the OLPC XS is preserved when it is possible, e.g., except Journal backups that were implemented differently from the beginning.
  
 
'''sugar-client'''
 
'''sugar-client'''
  
:: [[Sugar_Server_Kit/sugar-client|sugar-client]] project is intended to be the only one on a client side to cover all possible interactions with a school server.
+
:: The [[Sugar_Server_Kit/sugar-client|sugar-client]] project is intended to be the only one on the client side to cover all possible interactions with a school server.
  
 
'''Clients are identified by profile UIDs on a server'''
 
'''Clients are identified by profile UIDs on a server'''
  
:: In comparing with 1.0 implementation, and OLPC XS as well, sugar-server-1.1 [[Sugar_Server_Kit/sugar-server#User_identity_models|identifies]] clients by UID that is unique for particular user's profile, i.e., not by XO's UUIDs. That was done to cover usecases when the same hardware is being used for several users.
+
:: In comparison with the 1.0 implementation, and the OLPC XS, as well, sugar-server-1.1 [[Sugar_Server_Kit/sugar-server#User_identity_models|identifies]] clients by a UID that is unique for the particular user's profile, i.e., not by the XO's UUIDs. This was done to cover use cases where the same hardware is being used for several learners.
  
See [[Sugar_Server_Kit/Architecture|design overview]] for more details.
+
See the [[Sugar_Server_Kit/Architecture|design overview]] for more details.
  
 
== Final solution ==
 
== Final solution ==
  
This release is entirely based on experience gotten during the work on Paraguayan pilot program, i.e., the functionality of Sugar Server Kit was improved and proven by using it in a school. As a result, the [[Sugar_Server_Kit/Solutions/Paraguay_Educa_Server|paraguayeduca-server]], the final Sugar Server Kit based solution, was created.
+
This release is entirely based on experience gathered during the work on the Paraguayan pilot program, i.e., the functionality of Sugar Server Kit was improved and proven by using it in a school. As a result, the [[Sugar_Server_Kit/Solutions/Paraguay_Educa_Server|paraguayeduca-server]], the final Sugar Server Kit based solution, was created.
  
 
It covers the full life cycle of using school servers in environments similar to Paraguay, i.e.:
 
It covers the full life cycle of using school servers in environments similar to Paraguay, i.e.:
Line 39: Line 39:
 
== Supported platforms ==
 
== Supported platforms ==
  
* Current LTS version of Ubuntu/Trisquel GNU/Linux distributions.
+
* LTS versions of Trisquel-4.1 (Ubuntu-10.04) GNU/Linux distributions.
  
 
Fedora-14 will be added to supported platforms in [[Sugar_Server_Kit/1.2/Todo|1.2]] to provide [[Sugar_Server_Kit/Solutions/Server_on_an_XO|Server on an XO]] solution.
 
Fedora-14 will be added to supported platforms in [[Sugar_Server_Kit/1.2/Todo|1.2]] to provide [[Sugar_Server_Kit/Solutions/Server_on_an_XO|Server on an XO]] solution.
Line 45: Line 45:
 
== Components ==
 
== Components ==
  
In comparing with [[Sugar_Server_Kit/1.0/Notes#Components|1.0]] release, there are the following changes:
+
In comparison with the [[Sugar_Server_Kit/1.0/Notes#Components|1.0]] release, there are the following changes:
  
* [[Sugar_Server_Kit/sugar-client|sugar-client]]<br>new component to interact with a school server on a client side;
+
* [[Sugar_Server_Kit/sugar-client|sugar-client]]<br>a new component to interact with a school server on a client side;
* ''sugaroid''<br>was renamed to [[Sugar_Server_Kit/sugar-unit|sugar-unit]] to expose more general purpose of this project;
+
* ''sugaroid''<br>was renamed to [[Sugar_Server_Kit/sugar-unit|sugar-unit]] to expose the more general purpose of this project;
* ''sugar-server-demoxo''<br>was removed as an Sugar Server Kit component and will be back as a supported [[Sugar_Server_Kit/Solutions/Server_on_an_XO|final solution]] in [[Sugar_Server_Kit/1.2/Todo|1.2]].
+
* ''sugar-server-demoxo''<br>was removed as an Sugar Server Kit component and will return as a supported [[Sugar_Server_Kit/Solutions/Server_on_an_XO|final solution]] in [[Sugar_Server_Kit/1.2/Todo|1.2]].
  
 
See also the [[Sugar_Server_Kit#Components|full list]] of Sugar Server Kit components.
 
See also the [[Sugar_Server_Kit#Components|full list]] of Sugar Server Kit components.
Line 61: Line 61:
 
== Looking forward ==
 
== Looking forward ==
  
The next minor, [[Sugar_Server_Kit/1.2|1.2]], release should contain the following major features:
+
The next, [[Sugar_Server_Kit/1.2|1.2]], release should contain the following major features:
  
* collecting [[Sugar_Server_Kit/Usage_Statistics|usage statistics]],
+
* collecting [[Platform_Team/Usage_Statistics|usage statistics]],
* return sugar-server-demoxo as a full featured Sugar Server Kit [[Sugar_Server_Kit/Solutions/Server_on_an_XO|solution]].
+
* return sugar-server-demoxo as a full featured Sugar Server Kit [[Sugar_Server_Kit/Solutions/Server_on_an_XO|based solution]].
  
 
See the [[Sugar_Server_Kit/1.2/Todo|1.2 TODO list]] for more details.
 
See the [[Sugar_Server_Kit/1.2/Todo|1.2 TODO list]] for more details.
Line 70: Line 70:
 
== Credits ==
 
== Credits ==
  
* [http://activitycentral.com/ Activity Central] for supporting during the work on 1.1 release.
+
* [http://activitycentral.com/ Activity Central] for support during the work on the 1.1 release.
* [http://www.paraguayeduca.org/ Paraguay Educa] for supporting during the work on 1.1 release, sharing deployment experience and needs, making it possible to have a pilot program in one of Caacupe schools.
+
* [http://www.paraguayeduca.org/ Paraguay Educa] for support during the work on the 1.1 release, sharing deployment experience and needs, making it possible to have a pilot program in one of the Caacupe schools.
* The [[Wiki Team]] for continuous polishing [[Sugar Server Kit]] wiki pages.
+
* The [[Wiki Team]] for continuous polishing of [[Sugar Server Kit]] wiki pages.
* The [[Infrastructure Team]] to support servers and services that are being used within the [[Sugar Server Kit]] project.
+
* The [[Infrastructure Team]] for support servers and services that are being used within the [[Sugar Server Kit]] project.

Latest revision as of 15:28, 8 October 2012

Summary

This is the first Sugar Server Kit release that is being positioned as ready for use in the field, thanks to the Paraguayan pilot program. This release should fulfill needs similar to those faced in Paraguay. The next step will be proving this system for restricted environments within the Server on an XO project for SSK-1.2.

This is also the first release that is following the Sugar Server Kit release plan.

Design changes

Changes made from the initial, 1.0, Sugar Server Kit implementation.

Unified API for sugar-server

The major way to interact with sugar-server for now, is a RESTfull API. The API inherited from the OLPC XS is preserved when it is possible, e.g., except Journal backups that were implemented differently from the beginning.

sugar-client

The sugar-client project is intended to be the only one on the client side to cover all possible interactions with a school server.

Clients are identified by profile UIDs on a server

In comparison with the 1.0 implementation, and the OLPC XS, as well, sugar-server-1.1 identifies clients by a UID that is unique for the particular user's profile, i.e., not by the XO's UUIDs. This was done to cover use cases where the same hardware is being used for several learners.

See the design overview for more details.

Final solution

This release is entirely based on experience gathered during the work on the Paraguayan pilot program, i.e., the functionality of Sugar Server Kit was improved and proven by using it in a school. As a result, the paraguayeduca-server, the final Sugar Server Kit based solution, was created.

It covers the full life cycle of using school servers in environments similar to Paraguay, i.e.:

  • Install Kit on USB stick to:
    • install new server,
    • migrate from existing installation,
    • migrate from existing OLPC XS installation;
  • Post-install school server automated tests;
  • Initial setup for the Mothership to support new school servers;
  • New client side behaviour based on sugar-client.

Supported platforms

  • LTS versions of Trisquel-4.1 (Ubuntu-10.04) GNU/Linux distributions.

Fedora-14 will be added to supported platforms in 1.2 to provide Server on an XO solution.

Components

In comparison with the 1.0 release, there are the following changes:

  • sugar-client
    a new component to interact with a school server on a client side;
  • sugaroid
    was renamed to sugar-unit to expose the more general purpose of this project;
  • sugar-server-demoxo
    was removed as an Sugar Server Kit component and will return as a supported final solution in 1.2.

See also the full list of Sugar Server Kit components.

Getting the release

Sources in tarballs can be found on package.sugarlabs.org and in master-1.1 branches in repositories on git.sugarlabs.org.

Binaries for supported distributions can be found on download.sugarlabs.org.

Looking forward

The next, 1.2, release should contain the following major features:

See the 1.2 TODO list for more details.

Credits