IntegratingWithUbuntuOne

Differences between revisions 1 and 8 (spanning 7 versions)
Revision 1 as of 2009-06-17 14:48:19
Size: 2678
Editor: yttrium
Comment:
Revision 8 as of 2009-06-18 11:47:30
Size: 8240
Editor: yttrium
Comment:
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
 * '''Created''':
 * '''Contributors''':
 * '''Packages affected''':
 * '''Created''': 2009-06-17
 * '''Contributors''': [[https://edge.launchpad.net/~joshuahoover|Joshua Hoover]], [[https://edge.launchpad.net/~stevea|Steve Alexander]], [[https://edge.launchpad.net/~statik|Elliot Murphy]], [[https://edge.launchpad.net/~lucio.torre|Lucio Torre]]
 * '''Packages affected''': python-contacts-api, dbus-contacts-api, gtk-contacts-picker, erlang, couchdb, couchdb-bin, ubuntu-couchdb, couchdb-oauth, couchdb-history, ubutuone-sync-ui, evolution-couchdb, akonadi-couchdb, tomboy-couchdb, firefox-bookmarks-couchdb, python-couchdb, couchdb-glib, dbus-couchdb, python-couchdb-records-api, dbus-couchdb-records-api, icontool, ubuntuone-client, ubuntuone-storage-protocol, python-oauth, ubuntuone-screensharing, ejabberd, configglue, gwibber-couchdb
Line 10: Line 10:
This should provide an overview of the issue/functionality/change proposed here. Focus here on what will actually be DONE, summarising that so that other people don't have to read the whole spec. See also CategorySpec for examples. Ubuntu One provides capabilities for the Ubuntu desktop as well as extended capabilities via optional online services. Integrating Ubuntu One capabilities with the Ubuntu desktop will provide storage sharing & synchronization (across a LAN and (optionally) the Ubuntu One cloud), screen sharing, and data (contacts, notes, Firefox bookmarks) sharing & synchronization via CouchDB.
Line 14: Line 14:
This section should include a paragraph describing the end-user impact of this change. It is meant to be included in the release notes of the first release in which it is implemented. (Not all of these will actually be included in the release notes, at the release manager's discretion; but writing them is a useful exercise.) TBD...
Line 16: Line 16:
It is mandatory.

== Rationale ==

This should cover the _why_: why is this change being proposed, what justifies it, where we see this justified.
Line 24: Line 19:
== Assumptions == TBD...
Line 28: Line 23:
You can have subsections that better describe specific parts of the issue. === File Sharing & Synchronization ===
File sharing and syncronization allows users to share and synchronize files across their local network. An optional capability will allow users to easily share and synchronize files across the Internet using the Ubuntu One online service.

The Ubuntu One client will no longer use a client applet (as is the case with the current beta). Instead, the client will use downloads, FUSA, and standard Ubuntu messaging indicators.

'''Packages:'''
 * icontool
 * ubuntuone-client
 * ubuntuone-storage-protocol

=== Screen Sharing ===
Provides screen sharing between two desktops using Empathy, Telepathy. The "Share My Desktop" dialog will be unaffected. An optional Ubuntu One service will provide a proxy (utilizing ejabberd on the server) to allow users to more easily share their screens across the Internet.

'''Packages:'''
 * ubuntuone-screensharing
 * ejabberd

=== Data Sharing & Synchronization ===

==== CouchDB ====
'''Overview''': [[http://couchdb.apache.org/|Apache CouchDB]] is a distributed, fault-tolerant and schema-free document-oriented database accessible via a RESTful HTTP/JSON API. CouchDB is the database for Ubuntu One data sharing and synchronization capabilities.

Erlang is the language and runtime environment for CouchDB. Work will be done to trim the Erlang package so that it is as small as possible to run CouchDB and other applications dependent on the Erlang runtime.

Each user will run their own instance of CouchDB, which is different than the standard install of the current CouchDB package. There is also a need to setup various CouchDB configuration files, design docs, and triggers. Additional capabilities will be added to CouchDB, including [[http://oauth.net/|OAuth]] support and document history.

In order for developers to more easily use CouchDB in their applications, we will provide libraries for a variety of languages and environments, including Python, DBUS, and GTK (GLib).

A new desktop application will be developed to allow users to easily share and synchronize their data (contacts, notes, bookmarks, etc.) stored in CouchDB between Ubuntu computers on their local network.

'''Packages:'''
 * erlang
 * couchdb
 * couchdb-bin
 * ubuntu-couchdb
 * couchdb-oauth
 * couchdb-history
 * python-couchdb
 * couchdb-glib
 * dbus-couchdb
 * python-couchdb-records-api
 * dbus-couchdb-records-api
 * ubuntuone-sync-ui

==== Contacts ====
Providing a CouchDB contacts database that all Ubuntu applications can use is one of the key applications of the Ubuntu One data sharing and synchronization capability. Integration with Evolution, Akonadi, and Gwibber will store contacts in CouchDB. Developers of GTK applications will have a GTK widget which can provide their applications with a way to easily lookup/select contacts from the contacts CouchDB database. There will also be a contacts API for Python and DBUS, which will allow developers to use the CouchDB contacts database without worrying about the underlying details of CouchDB and the contacts schema.

'''Packages:'''
 * evolution-couchdb
 * akonadi-couchdb
 * gwibber-couchdb
 * python-contacts-api
 * dbus-contacts-api
 * gtk-contacts-picker

==== Bookmarks (Firefox) ====
A Firefox bookmarks synchronization and sharing extension will store Firefox bookmarks in CouchDB, which will provide sharing and synchronization capabilities.

'''Packages:'''
 * firefox-bookmarks-couchdb

==== Notes (Tomboy) ====
Tomboy will use CouchDB for storing its data which will provide sharing and synchronization capabilities.

'''Packages:'''
 * tomboy-couchdb

=== Misc ===
The packages below include the Python OAuth library and a tool for managing Ubuntu One configurations.

'''Packages:'''
 * python-oauth
 * configglue
Line 32: Line 100:
This section should describe a plan of action (the "how") to implement the changes discussed. Could include subsections like:

=== UI Changes ===

Should cover changes required to the UI, or specific UI that is required to implement this
Line 39: Line 101:

Code changes should include an overview of what needs to change, and in some cases even the specific details.
Specific code changes will be captured here. The summary given above in the design view highlights the major changes overall. As key code changes in the packages listed above are identified, they will be listed in this section.
Line 44: Line 105:
Include:
 * data migration, if any
 * redirects from old URLs to new ones, if any
 * how users will be pointed to the new way of doing things, if necessary.
TBD
Line 51: Line 109:
It's important that we are able to test new features, and demonstrate them to users. Use this section to describe a short plan that anybody can follow that demonstrates the feature is working. This can then be used during testing, and to show off after release. Please add an entry to http://testcases.qa.ubuntu.com/Coverage/NewFeatures for tracking test coverage.

This need not be added or completed until the specification is nearing beta.
TBD
Line 61: Line 117:
Use this section to take notes during the BoF; if you keep it in the approved spec, use it for summarising what was discussed and note any options that were rejected.  * ubuntu-one uses the couchDB database

 * couchDB supports replication, it's very simple, open and uses structured data

 * ubuntuone provides an API to couchDB

 * couchDB has good upstream support, and we need to get it into main for karmic

 * the service in front of couch supports http, which simplifies access for the API

 * lazr.restful, a python api originally developed for launchpad

 * couchDB needs erlang
  * erlang is about 45M installed size
  * maybe we can strip down erlang to make it fit more easily fit the single live CD

 * the application only needs to know how to handle the structured data with couchDB, not worry about things like sync, replication, etc

 * one use case, having a syncronized addressbook
  * evolution-data-server directly queries ubuntuone (locally)
  * the contact database from ubuntuone does sync locally, so e-d-s doesn't directly query the server just the local sync of the service

 * for the contact storage, what is the upgrade path?

 * start time is something to consider, the syncdaemon runs continuously, but it is in the background
  * perhaps defer the rescan to speed up login time

 * working with the design team to work out the details of what to do with the applet
  * it might go away when idle

 * other uses:
  * screen sharing
   * for now sticking with current technology, vino and vnc
  * bookmark syncing
   * trademark issues with customizing firefox
   * perhaps weave integration
   * modifications would be made in ubufox
  * tomboy sync
   * sync notes to u1 instead of snowy
   * should we consider gnotes?
  * backing up a usb drive when plugged in

 * What KDE apps should integration with u1?
  * system wide storage called akonadi using mysql

 * ultimately all configuration should be done in the applications, but we might use a common u1 control panel to configure various aspects of u1 until we get that level of integration

 * we need to work on the MIR for the u1 client and deps (including erlang) for karmic

 * before doing the MIR we should figure out how we can split erlang into smaller chunks for CD size constraints. See:
  * https://launchpad.net/bugs/385104 (done)
  * https://launchpad.net/bugs/385120
  * https://launchpad.net/bugs/385095
  * https://launchpad.net/bugs/385093
  • Launchpad Entry: Integrating with Ubuntu One

  • Created: 2009-06-17

  • Contributors: Joshua Hoover, Steve Alexander, Elliot Murphy, Lucio Torre

  • Packages affected: python-contacts-api, dbus-contacts-api, gtk-contacts-picker, erlang, couchdb, couchdb-bin, ubuntu-couchdb, couchdb-oauth, couchdb-history, ubutuone-sync-ui, evolution-couchdb, akonadi-couchdb, tomboy-couchdb, firefox-bookmarks-couchdb, python-couchdb, couchdb-glib, dbus-couchdb, python-couchdb-records-api, dbus-couchdb-records-api, icontool, ubuntuone-client, ubuntuone-storage-protocol, python-oauth, ubuntuone-screensharing, ejabberd, configglue, gwibber-couchdb

Summary

Ubuntu One provides capabilities for the Ubuntu desktop as well as extended capabilities via optional online services. Integrating Ubuntu One capabilities with the Ubuntu desktop will provide storage sharing & synchronization (across a LAN and (optionally) the Ubuntu One cloud), screen sharing, and data (contacts, notes, Firefox bookmarks) sharing & synchronization via CouchDB.

Release Note

TBD...

User stories

TBD...

Design

File Sharing & Synchronization

File sharing and syncronization allows users to share and synchronize files across their local network. An optional capability will allow users to easily share and synchronize files across the Internet using the Ubuntu One online service.

The Ubuntu One client will no longer use a client applet (as is the case with the current beta). Instead, the client will use downloads, FUSA, and standard Ubuntu messaging indicators.

Packages:

  • icontool
  • ubuntuone-client
  • ubuntuone-storage-protocol

Screen Sharing

Provides screen sharing between two desktops using Empathy, Telepathy. The "Share My Desktop" dialog will be unaffected. An optional Ubuntu One service will provide a proxy (utilizing ejabberd on the server) to allow users to more easily share their screens across the Internet.

Packages:

  • ubuntuone-screensharing
  • ejabberd

Data Sharing & Synchronization

CouchDB

Overview: Apache CouchDB is a distributed, fault-tolerant and schema-free document-oriented database accessible via a RESTful HTTP/JSON API. CouchDB is the database for Ubuntu One data sharing and synchronization capabilities.

Erlang is the language and runtime environment for CouchDB. Work will be done to trim the Erlang package so that it is as small as possible to run CouchDB and other applications dependent on the Erlang runtime.

Each user will run their own instance of CouchDB, which is different than the standard install of the current CouchDB package. There is also a need to setup various CouchDB configuration files, design docs, and triggers. Additional capabilities will be added to CouchDB, including OAuth support and document history.

In order for developers to more easily use CouchDB in their applications, we will provide libraries for a variety of languages and environments, including Python, DBUS, and GTK (GLib).

A new desktop application will be developed to allow users to easily share and synchronize their data (contacts, notes, bookmarks, etc.) stored in CouchDB between Ubuntu computers on their local network.

Packages:

  • erlang
  • couchdb
  • couchdb-bin
  • ubuntu-couchdb
  • couchdb-oauth
  • couchdb-history
  • python-couchdb
  • couchdb-glib
  • dbus-couchdb
  • python-couchdb-records-api
  • dbus-couchdb-records-api
  • ubuntuone-sync-ui

Contacts

Providing a CouchDB contacts database that all Ubuntu applications can use is one of the key applications of the Ubuntu One data sharing and synchronization capability. Integration with Evolution, Akonadi, and Gwibber will store contacts in CouchDB. Developers of GTK applications will have a GTK widget which can provide their applications with a way to easily lookup/select contacts from the contacts CouchDB database. There will also be a contacts API for Python and DBUS, which will allow developers to use the CouchDB contacts database without worrying about the underlying details of CouchDB and the contacts schema.

Packages:

  • evolution-couchdb
  • akonadi-couchdb
  • gwibber-couchdb
  • python-contacts-api
  • dbus-contacts-api
  • gtk-contacts-picker

Bookmarks (Firefox)

A Firefox bookmarks synchronization and sharing extension will store Firefox bookmarks in CouchDB, which will provide sharing and synchronization capabilities.

Packages:

  • firefox-bookmarks-couchdb

Notes (Tomboy)

Tomboy will use CouchDB for storing its data which will provide sharing and synchronization capabilities.

Packages:

  • tomboy-couchdb

Misc

The packages below include the Python OAuth library and a tool for managing Ubuntu One configurations.

Packages:

  • python-oauth
  • configglue

Implementation

Code Changes

Specific code changes will be captured here. The summary given above in the design view highlights the major changes overall. As key code changes in the packages listed above are identified, they will be listed in this section.

Migration

TBD

Test/Demo Plan

TBD

Unresolved issues

This should highlight any issues that should be addressed in further specifications, and not problems with the specification itself; since any specification with problems cannot be approved.

BoF agenda and discussion

  • ubuntu-one uses the couchDB database
  • couchDB supports replication, it's very simple, open and uses structured data
  • ubuntuone provides an API to couchDB
  • couchDB has good upstream support, and we need to get it into main for karmic
  • the service in front of couch supports http, which simplifies access for the API
  • lazr.restful, a python api originally developed for launchpad
  • couchDB needs erlang
    • erlang is about 45M installed size
    • maybe we can strip down erlang to make it fit more easily fit the single live CD
  • the application only needs to know how to handle the structured data with couchDB, not worry about things like sync, replication, etc
  • one use case, having a syncronized addressbook
    • evolution-data-server directly queries ubuntuone (locally)
    • the contact database from ubuntuone does sync locally, so e-d-s doesn't directly query the server just the local sync of the service
  • for the contact storage, what is the upgrade path?
  • start time is something to consider, the syncdaemon runs continuously, but it is in the background
    • perhaps defer the rescan to speed up login time
  • working with the design team to work out the details of what to do with the applet
    • it might go away when idle
  • other uses:
    • screen sharing
      • for now sticking with current technology, vino and vnc
    • bookmark syncing
      • trademark issues with customizing firefox
      • perhaps weave integration
      • modifications would be made in ubufox
    • tomboy sync
      • sync notes to u1 instead of snowy
      • should we consider gnotes?
    • backing up a usb drive when plugged in
  • What KDE apps should integration with u1?
    • system wide storage called akonadi using mysql
  • ultimately all configuration should be done in the applications, but we might use a common u1 control panel to configure various aspects of u1 until we get that level of integration
  • we need to work on the MIR for the u1 client and deps (including erlang) for karmic
  • before doing the MIR we should figure out how we can split erlang into smaller chunks for CD size constraints. See:


CategorySpec

DesktopTeam/Specs/Karmic/IntegratingWithUbuntuOne (last edited 2009-07-15 13:54:04 by cpe-75-187-149-245)