Difference between revisions of "School Network/Open Build Service"

Latest revision as of 07:19, 23 March 2015

Summary

This patched Sugar Labs instance of the Open Build Service (OBS) has the following intentions:

Unattended building of software hosted on Sugar Network for all supported platforms.

Be a convenient instrument to create 3rd party repositories with native packages for all supported GNU/Linux distributions.

Sites

obs.sugarlabs.org
This is an API site, all OBS clients use it to get access to OBS. There is no need to work with the site directly, although that is possible.

packages.sugarlabs.org
This is an original OBS Web client. It is intended to be used only by people who need to create native packages, i.e., it is not needed for most Sugar developers assuming that Sugar Network will process building procedures in unattended mode.

download.sugarlabs.org
After building, binary packages will be acceptable from the Sugar Labs download site.

Usage

See original manuals and materials to learn more about what functionality OBS provides.

On top of original OBS behavior, the Sugar Labs instance brings the following new features and common practices.

Special projects

There is a special project, named base; it contains all GNU/Linux distributions that are supported on OBS. All other projects, that are intended for building packages, need to inherit repositories from this project.

GNU/Linux distribution agnostic packages

Instead of using spec files of packages to be built against for every GNU/Linux distribution, it is possible to use a special spec file that will be used as-is in all platforms that Sugar Labs OBS supports.

To create such distro-agnostic packages,

upload a sweets.recipe file in special notation to OBS package;
upload .tar.gz sources with filename composed using sweets.recipe fields:

<context>-<version>.tar.gz

After that, OBS will start building submitted package on all attached OBS repositories.

Resolve packages

There is new API command that might be used to resolve package names and package dependencies on a particular OBS platform.

GET /resolve?project=PROJECT&repository=REPOSITORY&arch=ARCH&package=PACKAGE[&withdeps][&exclude=PACKAGE]

Where:

PROJECT, REPOSITORY, ARCH and PACKAGE
identification of particular OBS package;
withdeps
include dependencies graph of the PACKAGE;
exclude
restrict dependency graph from bottom side.

For example,

https://obs.sugarlabs.org/resolve?project=OLPC&repository=11.3.1&arch=i586&package=pygame&withdeps&exclude=sugar

Will output:

<resolve>
  <binary name="pygame" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/pygame-1.9.1-3.fc14.i686.rpm" />
  <binary name="SDL" url="http://mock.laptop.org/cgit/koji.dist-f14-i686-updates-11.3.1/plain/RPMS/SDL-1.2.14-11.fc14.i686.rpm" />
  <binary name="SDL_mixer" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/SDL_mixer-1.2.11-4.fc14.i686.rpm" />
  <binary name="SDL_image" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/SDL_image-1.2.10-1.fc13.i686.rpm" />
  <binary name="numpy" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/numpy-1.4.1-6.fc14.i686.rpm" />
  <binary name="SDL_ttf" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/SDL_ttf-2.0.10-1.fc14.i686.rpm" />
  <binary name="portmidi" url="http://mock.laptop.org/cgit/koji.dist-f14-i686-updates-11.3.1/plain/RPMS/portmidi-200-5.fc14.i686.rpm" />
  <binary name="libmikmod" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/libmikmod-3.2.0-11.beta2.fc14.i686.rpm" />
  <binary name="libgfortran" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/libgfortran-4.5.1-4.fc14.i686.rpm" />
  <binary name="python-nose" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/python-nose-0.11.3-5.fc14.noarch.rpm" />
  <binary name="python-setuptools" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/python-setuptools-0.6.14-3.fc14.noarch.rpm" />
  <binary name="atlas" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/atlas-3.8.3-18.fc14.i686.rpm" />
</resolve>

Policy

The Open Build Service works underneath the Sugar Network, processing software content uploaded to Sugar Network, thus, the Sugar Network Policy is inherited.

Resources

Open Build Service home page.
Open Build Service API specification.
Downstream patch sources.

@@ Line 1: / Line 1: @@
 == Summary ==
-This is a [http://git.sugarlabs.org/0sugar/build-service patched] Sugar Labs instance of the [http://openbuildservice.org/ Open Build System] (OBS), which is intended to be a:
+This [http://git.sugarlabs.org/0sugar/build-service patched] Sugar Labs instance of the [http://openbuildservice.org/ Open Build Service] (OBS) has the following intentions:
-* Place to host sources and to make binaries, if there is a need, for [[Platform_Team/Sweets|Sweets]] projects.
+* Unattended building of software hosted on [[Sugar Network]] for all [[Sweets_Distribution/Supported_platforms|supported]] platforms.
-* Convenient instrument to create 3rd party repositories with native packages for all [[#Supported_platforms|supported]] GNU/Linux distributions.
-For detailed information, read the original Open Build System [http://openbuildservice.org/documentation.html documentation].
+* Be a convenient instrument to create 3rd party repositories with native packages for all [[Sweets_Distribution/Supported_platforms|supported]] GNU/Linux distributions.
 == Sites ==
-=== obs.sugarlabs.org ===
+* [https://obs.sugarlabs.org obs.sugarlabs.org]<br>This is an [https://obs.sugarlabs.org/apidocs/ API] site, all OBS clients use it to get access to OBS. There is no need to work with the site directly, although that is [http://en.opensuse.org//openSUSE:Build_Service_Curl possible].
-This is an [https://obs.sugarlabs.org/apidocs/ API] site, all OBS clients use it to get access to OBS. There is no need to work with the site directly, but that is [http://en.opensuse.org//openSUSE:Build_Service_Curl possible].
+* [https://packages.sugarlabs.org packages.sugarlabs.org]<br>This is an original OBS Web client. It is intended to be used only by people who need to create native packages, i.e., it is not needed for most Sugar developers assuming that [[Sugar Network]] will process building procedures in unattended mode.
-The site uses HTTP Basic authentication. To get access, [[Service/Account#Sugar_Labs_Central_Login|create]] a Sugar Labs Central Login account.
+* [http://download.sugarlabs.org/packages/ download.sugarlabs.org]<br>After building, binary packages will be acceptable from the Sugar Labs download site.
-=== packages.sugarlabs.org ===
+== Usage ==
-This is an original OBS Web client. It is intended to be used only by people who need to create native packages, i.e., it is not needed for most Sugar developers. But, until a more appropriate tool is created for Sugar needs, it is the only Web client available to manage already released software (those released by being processed by the [[Platform_Team/Guide/Sweets_Packaging#Releasing|sweets command]]).
-== Content ==
-The content on OBS might be of several kinds:
-=== Projects ===
-Projects are directories of Packages and might be of two types:
-* top level, regular projects, like {{Code|base}} or {{Code|sdk}};
+See original [http://openbuildservice.org/help/manuals/ manuals] and [http://openbuildservice.org/help/materials/ materials] to learn more about what functionality OBS provides.
-* user's home projects, like {{Code|home:''<user>''}}.
-=== Packages ===
+On top of original OBS behavior, the Sugar Labs instance brings the following new features and common practices.
-Packages represent particular software projects and contain all files associated with these projects, e.g., tarballs with sources.
+=== Special projects ===
-There are several types of packages supported on OBS:
+There is a special project, named [https://packages.sugarlabs.org/project/repositories?project=base base]; it contains all GNU/Linux distributions that are supported on OBS. All other projects, that are intended for building packages, need to inherit repositories from this project.
-* packages that represent sweets,
+=== GNU/Linux distribution agnostic packages ===
-* native packages based on sweets,
-* native packages using sweet recipes as spec files,
-* aliases,
-* regular OBS packages.
-See [[#Usage|Usage]] section for more details.
+Instead of using spec files of packages to be built against for every GNU/Linux distribution, it is possible to use a special spec file that will be used as-is in all platforms that Sugar Labs OBS supports.
-=== Repositories ===
+To create such distro-agnostic packages,
-Every project has repositories to build its packages against. Repositories might be of two types:
+* upload a {{Code|sweets.recipe}} file in [[Sweets_Distribution/Recipe_Specification|special notation]] to OBS package;
-* inherited from another project;
-* initial repositories, aka, downloaded-on-demand, that are associated with a particular GNU/Linux distribution release;
-Note: The {{Code|sweets.sugarlabs.org}} repository should be present if Packages need to be distributed via Zero Install.
-Every repository has supported architectures, e.g., {{Code|i586}} or {{Code|x86_64}}. There is also the special architecture, {{Code|0install}}, only for {{Code|sweets.sugarlabs.org}}.
-== Supported platforms ==
-There is a special project, named [https://packages.sugarlabs.org/project/repositories?project=base base]; it contains all GNU/Linux distributions that are supported on OBS. All other projects need to inherit repositories from this project.
-== Usage ==
-On top of original OBS behavior, Sugar Labs patch brings the following new features.
-=== Distribution agnostic packages ===
-Instead of using spec files for every distribution packages should be built against, it is possible to use special spec file that will be used as-is an all platforms Sugar Labs OBS supports.
-To create such distro-agnostic packages:
-* upload {{Code|sweets.recipe}} file in [[Platform_Team/Recipe_Specification|special notation]] to OBS package;
 * upload {{Code|.tar.gz}} sources with filename composed using {{Code|sweets.recipe}} fields:
-  <implement>-<version>.tar.gz
+  <context>-<version>.tar.gz
-After that, OBS will star building submitted package on all attached OBS repositories.
+After that, OBS will start building submitted package on all attached OBS repositories.
-=== Resolve packages and dependencies ===
+=== Resolve packages ===
-There is new API command that might be used to resolve package names and package dependencies on particular OBS platform.
+There is new API command that might be used to resolve package names and package dependencies on a particular OBS platform.
   GET '''/resolve'''?project=PROJECT&repository=REPOSITORY&arch=ARCH&package=PACKAGE[&withdeps][&exclude=PACKAGE]
@@ Line 91: / Line 52: @@
 For example,
-  https://obs.sugarlabs.org/resolve?project=OLPC:11.3.1&repository=Fedora-14&arch=i586&package=pygame&withdeps&exclude=sugar
+  https://obs.sugarlabs.org/resolve?project=OLPC&repository=11.3.1&arch=i586&package=pygame&withdeps&exclude=sugar
 Will output:
@@ Line 109: / Line 70: @@
     <binary name="atlas" url="http://mock.laptop.org/cgit/koji.dist-f14-i686/plain/RPMS/atlas-3.8.3-18.fc14.i686.rpm" />
   </resolve>
-Note that {{Code|url}} attributes might be invalid if corresponding packages were used for building on OBS. So, keep special OBS projects, only for resolving purpose, like {{OBS/project|OLPC:11.3.1|OLPC:11.3.1}}.
 == Policy ==
-{{:Platform_Team/Open_Build_System/Policy}}
+{{:School_Network/Open_Build_Service/Policy}}
 == Resources ==
-* Open Build System [http://openbuildservice.org/ home page].
+* Open Build Service [http://openbuildservice.org/ home page].
-* Open Build System API [https://obs.sugarlabs.org/apidocs/ specification].
+* Open Build Service API [https://obs.sugarlabs.org/apidocs/ specification].
-* Downstream patch [http://git.sugarlabs.org/0sugar/build-service sources].
+* Downstream patch [https://git.sugarlabs.org/sl-tweaks/obs sources].