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

Revision as of 20:35, 18 October 2011

Summary

This is a patched Sugar Labs instance of Open Build System (OBS) that is intended to be a:

Place to host sources and to make binaries, if there is need, for Sweets.
Convenient instrument to create 3rd party repositories with native packages for all supported GNU/Linux distributions.

For detailed information, read the original Open Build System documentation.

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, but that is possible.

The site uses HTTP Basic authentication. To get access, create a Sugar Labs Central Login account.

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. 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 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 base or sdk;
user's home projects, like home:<user>.

Packages

Packages represent particular software projects and contain all files associated with these projects, e.g., tarballs with sources.

There are several types of packages supported on OBS:

packages that represent sweets,
native packages based on sweets,
native packages using sweet recipes as spec files,
aliases,
regular OBS packages.

See Usage section for more details.

Repositories

Every project has repositories to build its packages against. Repositories might be of two types:

inherited from another project;
initial repositories, aka, downloaded-on-demand, that are associated with a particular GNU/Linux distribution release;
sweets.sugarlabs.org repository should be present if Packages need to be distributed via Zero Install.

Every repository has supported architectures, e.g., i586 or x86_64. There is also the special architecture, 0install, only for sweets.sugarlabs.org.

Supported platforms

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

Usage

There are several OBS usage workflows.

Sweets

Sweets is using OBS as a place to host sources and, if there is a need, to build binaries. There are two ways to interact with OBS:

Console based client, sweets, for uploading new releases;
An application to manage already released versions. It is possible to use packages.sugarlabs.org for that, but it is too overfeatured and needs to be replaced by a more appropriate alternative.

The result will be reused via Zero Install.

Sweet packages

After being released, sweets might be formed into native package repositories. For that use case:

Create a new project;
Add packages that need to be built for, they should be directly or indirectly inherited from the base project;
Go to the OBS package that represents a sweet you need to build native packages for, e.g., sugar;
Click the Link sweet package link to add it to your project.

The result will be regular OBS repositories with native packages. The only difference is that after installation on target systems, the content of these packages will be placed in the /opt directory instead of the regular /usr. The reason is that sweets are not intended to be placed directly in the /usr directory as there might be file name collisions with existing files.

Recipe based packages

These are regular OBS packages except that instead of regular spec files, e.g., RPM .spec, they might be built based on sweets.recipe files. It is a kind of meta packaging, but restricted by design. In comparison with sweet packages, these packages will be placed in the /usr directory.

Regular packages

It is exactly how OBS is originally designed to work.

Policy

REDIRECT School Network/Open Build Service/Policy

Resources

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

@@ Line 57: / Line 57: @@
 == Supported platforms ==
-There is 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.
+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 ==
@@ Line 65: / Line 65: @@
 === Sweets ===
-[[Platform_Team/Sweets|Sweets]] is using OBS as a place to host sources and, if there is need, build binaries. There are two ways to interact with OBS:
+[[Platform_Team/Sweets|Sweets]] is using OBS as a place to host sources and, if there is a need, to build binaries. There are two ways to interact with OBS:
 * Console based client, {{Code|sweets}}, for uploading new releases;
-* Application to manage already released versions, it is possible to use packages.sugarlabs.org for that but it is too overfeatured and need to be replaced by more appropriate option.
+* An application to manage already released versions. It is possible to use packages.sugarlabs.org for that, but it is too overfeatured and needs to be replaced by a more appropriate alternative.
 The result will be reused via Zero Install.
@@ Line 74: / Line 74: @@
 === Sweet packages ===
-After beeing released, sweets might be formed to native packages repositories. For that case:
+After being released, sweets might be formed into native package repositories. For that use case:
-* Create new project;
+* Create a new project;
-* Add new repositories packages need to be build for, they should be directly or indirectly inherited from the {{Code|base}} project;
+* Add packages that need to be built for, they should be directly or indirectly inherited from the {{Code|base}} project;
-* Go to OBS package that represent a sweet you need to build native packages for, e.g., [https://packages.sugarlabs.org/package/show?package=sugar&project=sdk sugar];
+* Go to the OBS package that represents a sweet you need to build native packages for, e.g., [https://packages.sugarlabs.org/package/show?package=sugar&project=sdk sugar];
-* Click ''Link sweet package'' link to add it to your project.
+* Click the ''Link sweet package'' link to add it to your project.
-The result will be regular OBS repositories with native packages. The only difference is that after installing on target systems, the content of these packages will be placed to {{Code|/opt}} directory instead of regular {{Code|/usr}}. The reason is that sweets are not indented to be placed directly to the {{Code|/usr}} and there might be file name collisions with existed files.
+The result will be regular OBS repositories with native packages. The only difference is that after installation on target systems, the content of these packages will be placed in the {{Code|/opt}} directory instead of the regular {{Code|/usr}}. The reason is that sweets are not intended to be placed directly in the {{Code|/usr}} directory as there might be file name collisions with existing files.
 === Recipe based packages ===
-These are regular OBS packages except that instead of regular spec files, e.g., RPM {{Code|.spec}}, they might be build basing on [[Platform_Team/Recipe_Specification#.5BPackage.5D|sweets.recipe]] files. It is a kind of meta packaging but restricted by design. In comparing with sweet packages, these packages will be placed to {{Code|/usr}}.
+These are regular OBS packages except that instead of regular spec files, e.g., RPM {{Code|.spec}}, they might be built based on [[Platform_Team/Recipe_Specification#.5BPackage.5D|sweets.recipe]] files. It is a kind of meta packaging, but restricted by design. In comparison with sweet packages, these packages will be placed in the {{Code|/usr}} directory.
 === Regular packages ===