Difference between revisions of "Features/Sugar Update Control ASLO"

From Sugar Labs
Jump to navigation Jump to search
m (remove template stuff)
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>{{GoogleTrans-en}}{{TOCright}}</noinclude>
+
<noinclude>{{GoogleTrans-en}}{{TOCright}}
 +
[[Category:Feature Accepted 0.86]]
 +
[[Category:FeatureLanded|Sugar Update Control ASLO]]</noinclude>
  
 
== Summary ==
 
== Summary ==
Modify the existing Sugar Update Control to pull from ASLO instead of the wiki.laptop.org
+
Modify the existing Sugar Update Control to pull from activities.sugarlabs.org
  
 
== Owner ==
 
== Owner ==
''This should link to your home wiki page so we know who you are''
 
 
* Name: [[User:dfarning| David Farning]]
 
* Name: [[User:dfarning| David Farning]]
 
''Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or technical issues need to be resolved''
 
 
* Email: <dfarning@sugarlabs.org>
 
* Email: <dfarning@sugarlabs.org>
  
 
== Current status ==
 
== Current status ==
 
* Targeted release: .86
 
* Targeted release: .86
* Last updated: 16 July 2009
+
* Last updated: 15 August 2009
* Percentage of completion: 50% All basic functionality is present.  Needs testing.
+
* Percentage of completion: 100%
  
 
== Source ==
 
== Source ==
 
+
http://git.sugarlabs.org/projects/update
http://git.sugarlabs.org/projects/sugar-update-control/repos/aslo-clone
 
  
 
== Detailed Description ==
 
== Detailed Description ==
  
Current, the Sugar Update Control pulls from wiki.laptop.org.  Server side, this results in unnecessary work for activities developers as they must update specific wiki pages when releasing new activities. The existing system is rather fragile as developers must store the update information by hand in machine-readable micro-format. FWIW, this system was pretty good until ASLO came along.   
+
Update enables users to update their installed activities from the Activities Library at activities.sugarlabs.org.  Activities.sugarlabs.org is based on the well-established addons.mozilla.org.   
  
Using ASLO the client can request information about updated by sending a url of the form
+
Using ASLO the client can request information about updates by sending a URL of the form,
  
http://activities.sugarlabs.org/services/update.php?id=org.laptop.WebActivity&appVersion=0.82
+
http://activities.sugarlabs.org/services/update-aslo.php?id=org.laptop.WebActivity&appVersion=0.82
  
ASLO responds by returning XML of the form
+
ASLO responds by returning an XML of the form,
  
 +
<pre>
 
  <?xml version="1.0" encoding="UTF-8"?>
 
  <?xml version="1.0" encoding="UTF-8"?>
 
  <RDF:RDF xmlns:RDF="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"><RDF:Description about="urn:mozilla:extension:org.laptop.WebActivity">
 
  <RDF:RDF xmlns:RDF="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"><RDF:Description about="urn:mozilla:extension:org.laptop.WebActivity">
Line 52: Line 51:
 
     </em:targetApplication>
 
     </em:targetApplication>
 
  </RDF:Description></RDF:RDF>
 
  </RDF:Description></RDF:RDF>
 
+
</pre>
 
 
  
 
== Benefit to Sugar ==
 
== Benefit to Sugar ==
  
This benefits Sugar by moving the entire activities infrastructure to aslo rather than being spread across a wiki and aslo.
+
1. This benefits Sugar by moving the entire activities infrastructure to activities.sugarlabs.org rather than being spread across a wiki and aslo.
  
It reduces activity developer work load.
+
2. It reduces activity developer work load by using the established activites.sugarlabs.org upload process to update activities.
  
It reduces and isolates infrastructure load between wiki, aslo, and download system.  ASLO is backed by memcache, so standard update pings are _very_ cheap.  ASLO can be configured to store and serve downloads from download-farm to ease scaling issues.
+
3. It reduces and isolates infrastructure load between wiki, activities.sl.o, and download system.   
 
+
a. ASLO provides all necessary update information in a single network transaction.
+
b. ASLO is backed by memcache, so standard update pings are very cheap.
Makes activities developers and infrastructure maintainers lives easier.
+
  c. ASLO can be configured to store and serve downloads from download-farm to ease scaling issues.
  
 
== Scope ==
 
== Scope ==
Technically the scope is pretty limited.  Most of the changes are inside sugar-update-control or are in ASLO.
+
Technically the scope is limited.  Most of the changes are inside the control panel extension or in ASLO.
  
 
There will not be external api changes.
 
There will not be external api changes.
  
Depends on the bitfrost python modulesUntil a decision is made concerning where to include those modules in Sugar, actinfo.py, actutils.py and urlrange.py are shipped with sugar-update-control.
+
Over the last several months, ASLO has been improving and proving it's reliabilityMany activities are being served via ASLO as their information is marked deprecated on wiki.laptop.org. Shifting update to point to ASLO will require clear communication to end users and developers.
 +
 
 +
=== Implementation ===
  
Socially, this is  _huge_ change. Over the last several months, ASLO has been improving and proving it's reliability.  Many activities are being served via ASLO as their information is marked deprecated on wiki.laptop.org.  Shifting update to point to also will require clear communication to end users and developers.
+
* [http://git.sugarlabs.org/projects/sugar/repos/mainline/trees/master/extensions/cpsection/updater Updater component for control panel]
  
 
== How To Test ==
 
== How To Test ==
 
+
{{:{{PAGENAME}}/Testing}}
Click on M Settings -> Software update.
 
 
 
Visually verify the "From Version XXX to XXX" is correct for your system.
 
 
 
NOTE: the updater currently reports information on all activities, not just the ones with valid updates.  This is for debug purposes.
 
 
 
 
== User Experience ==
 
== User Experience ==
Nothing should change from user point of view.
+
The user will be able to check if there are any activity updates that can be fetched and installed.
  
 
== Dependencies ==
 
== Dependencies ==
Line 100: Line 94:
 
== Release Notes ==
 
== Release Notes ==
  
None yet
+
As of Sugar 0.86, the only backend is activities.sugarlabs.org. Specifying other servers and update formats are out of scope of this specific feature.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
 
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
 
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
 
 
[[Category:Feature Page Incomplete]]
 
[[Category:Feature]]
 
----
 
''You can add categories to tie features back to real deployments/schools requesting them, for example <nowiki>[[</nowiki>Category:Features requested by School Xyz]]''
 

Latest revision as of 14:38, 5 November 2013

Summary

Modify the existing Sugar Update Control to pull from activities.sugarlabs.org

Owner

Current status

  • Targeted release: .86
  • Last updated: 15 August 2009
  • Percentage of completion: 100%

Source

http://git.sugarlabs.org/projects/update

Detailed Description

Update enables users to update their installed activities from the Activities Library at activities.sugarlabs.org. Activities.sugarlabs.org is based on the well-established addons.mozilla.org.

Using ASLO the client can request information about updates by sending a URL of the form,

http://activities.sugarlabs.org/services/update-aslo.php?id=org.laptop.WebActivity&appVersion=0.82

ASLO responds by returning an XML of the form,

 <?xml version="1.0" encoding="UTF-8"?>
 <RDF:RDF xmlns:RDF="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"><RDF:Description about="urn:mozilla:extension:org.laptop.WebActivity">
    <em:updates>
        <RDF:Seq>
            <RDF:li resource="urn:mozilla:extension:org.laptop.WebActivity:102"/>
        </RDF:Seq>
    </em:updates>
 </RDF:Description>

 <RDF:Description about="urn:mozilla:extension:org.laptop.WebActivity:102">
    <em:version>102</em:version>
    <em:targetApplication>
        <RDF:Description>
            <em:id>{3ca105e0-2280-4897-99a0-c277d1b733d2}</em:id>
            <em:minVersion>0.82</em:minVersion>
            <em:maxVersion>0.82</em:maxVersion>
            <em:updateLink>http://activities.sugarlabs.org/downloads/file/26063/browse-102.xo</em:updateLink>
            <em:updateInfoURL>http://activities.sugarlabs.org/versions/updateInfo/29040/%APP_LOCALE%/</em:updateInfoURL>
            <em:updateHash>sha256:d06c16a1c106dbd1a706f322d75a143d0b4e32815c22f3d95589de83e5480365</em:updateHash>
        </RDF:Description>
    </em:targetApplication>
 </RDF:Description></RDF:RDF>

Benefit to Sugar

1. This benefits Sugar by moving the entire activities infrastructure to activities.sugarlabs.org rather than being spread across a wiki and aslo.

2. It reduces activity developer work load by using the established activites.sugarlabs.org upload process to update activities.

3. It reduces and isolates infrastructure load between wiki, activities.sl.o, and download system.

a. ASLO provides all necessary update information in a single network transaction.
b. ASLO is backed by memcache, so standard update pings are very cheap.
c. ASLO can be configured to store and serve downloads from download-farm to ease scaling issues.

Scope

Technically the scope is limited. Most of the changes are inside the control panel extension or in ASLO.

There will not be external api changes.

Over the last several months, ASLO has been improving and proving it's reliability. Many activities are being served via ASLO as their information is marked deprecated on wiki.laptop.org. Shifting update to point to ASLO will require clear communication to end users and developers.

Implementation

How To Test

Features/Sugar Update Control ASLO/Testing

Click on My Settings -> Software update.

Visually verify the "From Version XXX to XXX" is correct for your system by checking what is available on ASLO.

User Experience

The user will be able to check if there are any activity updates that can be fetched and installed.

Dependencies

None

Contingency Plan

None necessary, revert to previous release behaviour.

Documentation

None

Release Notes

As of Sugar 0.86, the only backend is activities.sugarlabs.org. Specifying other servers and update formats are out of scope of this specific feature.

Comments and Discussion