1 Using the OBS Web UI

Your home project will be empty for now, but you can add packages containing sources/build recipes and projects which are containers for the build targets. As you can see, you're the default maintainer which grants you full write access to this project. You're also the bug owner of your project.

Figure 1.4: Project Page #

On every project page you will find a "Edit description" link. This link will lead you to a place were you can review and change your project's title and description. Click on the "Update project" button to save.

Figure 1.5: Updating project description #

Subprojects are projects that are part of another projects namespace. Subprojects are an easy way to organize multiple projects. On the "Subprojects" tab you can find a list subprojects that belong to a project. To create a new subproject click on the "New subproject" link, fill in the form and press the "Create project" button.

Note

Maintainers of upper projects can always modify the subprojects. Apart from that all projects are separated and have no influence on each other.

Figure 1.6: Creating Subprojects #

Right below packages, there's "Branch Package from other Project" .

Figure 1.10: Branch Package #

Open that page and enter for

Name of original project:
Apache

and for

Name of package in original project:
flood

- we'll leave "Name of linked package in target project" empty. This is shown on the next picture:

Figure 1.11: Apache Flood Branch #

Proceed with "Create Branch" and you'll be redirected to your home again. You'll see a new package "flood" and a notice about the branch being added.

Figure 1.12: Branched Package #

Wonderful, we've added a pointer to the sources! Now we need to add a repository, so the builder knows the target-distribution to build packages for. How to add a repository to a project is documented at Section 1.6.1, “Adding a repository”.

Next, it is time to explore the Monitor page, the package detail page and the build log. Just click on the links and explore the web interface. I recommend starting with your home project's top level 'overview' page - click on the Overview tab and you may see something like this:

Figure 1.13: flood_succeeded_finished #

If you wait a bit, you would see the below building success screen

Figure 1.14: flood_build_success #

Click the “succeeded” message, then you will see the build log as below.

Figure 1.15: flood_build_log #

To add a repository to your project, click on "Add Repositories" on the project's repository tab. This will direct you to a list of possible distributions you can build packages for, see Figure 1.18, “Adding a Repository to a Project”.

Figure 1.18: Adding a Repository to a Project #

Note

If you could not find a repository that fits your needs, you might want to switch to the expert mode. Click on the "Expert mode" link right to the button. This page allows you to search and select a repository of any project available in OBS and add it to your projects repository list.

This will take you back to your home: project. The build repository might be disabled: if so, click on the cogwheel to enable it. Congratulations, it is configured. On a heavily loaded server, it can sometimes take a few minutes for your changes to become effective, but your linked package will automatically begin building.

When you have administrator rights you will be able to add Download on Demand repositories to your project. To do so, click on the "Add DoD repository" link and enter your DoD repository data into the form.

Figure 1.19: Adding a Download on Demand Repository #

The minimal set of fields you have to enter are architecture, repository type and the URL that provides the binary packages. Detailed information about the data you can enter here you can find at the DoD concept section (http://openbuildservice.org/help/manuals/obs-reference-guide/cha.obs.concepts.html#concept_dod). Press "Save" to create the repository.

Figure 1.20: Download on Demand Repository Form #

When the repository got added you are able to edit, delete or add additional DoD repository sources.

Figure 1.21: Adding Download on Demand repository sources #

Open the DoD repository sources form by clicking the "Add" link. Here you can enter your additional DoD repository source. Click the "Add Download on Demand" button.

Figure 1.22: Form for Adding DoD Repository Sources #

To edit DoD repository sources after they got added click on the "Edit" link that you find right to each DoD repository source.

Figure 1.23: Form for editing DoD repository sources #

To delete a repository or repository source, click on the "Delete" link and accept the confirmation dialog.

Create a subproject of your home project.

Figure 1.25: Form for creating image template subproject #

Note

Published image templates are fetched via a project's attribute. Any package container living in a published project will be visible on the image templates page.

Within that project create a new package. That will be your actual image template.

Figure 1.26: New Image Template #

Add the 'KIWI image build' repository to your project. This repository is needed to build KIWI images in your project. Go to the 'Repositories' tab, click on 'Add repositories' and click on the 'KIWI image build' check box.

Figure 1.27: Enabling the KIWI Image Build Repository #

Add sources for your image configuration.

Figure 1.28: Overview of Sources of a Custom Image Template #

KIWI configurations usually consists of an xml configuration root tarball.

In addition, you can define an icon for your image templates by adding graphical image (for example, PNG, JPG) to your template sources and name it _icon. If that file exists, it will be used as icon for your image on the image templates page.

For a full list of image descriptions and general information about building images with KIWI, see the KIWI project page (http://opensuse.github.io/kiwi/) and the KIWI cookbook (https://doc.opensuse.org/projects/kiwi/doc/).

Once everything is set up and your templates are building, you might want to publish them. In that case contact the admin of the OBS instance you are using and ask them kindly to do so. If you happen to use the official OBS (https://build.opensuse.org/), that would be admin@opensuse.org.

Go to your package, and upload a file with the .kiwi extension (for example, test.kiwi), with valid KIWI content.

Figure 1.29: Example of a Package with a KIWI XML File #

Note

You should see now a "Edit KIWI" link (next to "Delete package" link).

Click on the "Edit KIWI" link and you will be redirected to the Editor.

Figure 1.30: KIWI Editor. Show screen #

To add a new repository click Add repository link and fill in the dialog. There are two ways to create it:

Figure 1.31: KIWI Adding a new repository - Basic Mode #

Figure 1.32: KIWI Adding a new repository - Expert Mode #

To use the configuration of the current project check the Use project repositories checkbox.

Figure 1.33: KIWI Use project configuration #

Note

This option will remove the other repositories from your kiwi file.

Adding a package is practically the same as adding a repository. We offer an autocomplete for the package name that will show you the package available in the repositories added previously.

Figure 1.34: KIWI Adding a new package #

Note

The package groups shown in the editor are only those with type image and the packages will be added in this kind of package group. If it did exist previously the KIWI Editor creates a package group with type image for you.

The creation of a Staging will automatically create two staging projects as a subproject of the main project. Before creating, we need to select a group of managers, they will be in charge of assigning requests to the staging projects and also excluding requests from the Staging.

Figure 1.36: Creating a Staging for openSUSE:Factory #

Note

An Admin should previously create the manager groups.

In this view, we can find all the staging projects with an associated request and their current state.

Figure 1.37: Staging Show screen #

By clicking on the delete button on the Staging index page, we are able to delete a Staging. By selecting the associated staging projects in the appearing modal window, we are able to delete them as well. If not selected, they will remain as regular subprojects.

Figure 1.38: Delete a Staging Workflow #

It is possible to create/delete staging projects (openSUSE:Factory:Staging:A, openSUSE:Factory:Staging:B, etc) and change the Managers Group of the Staging.

Figure 1.39: Configuring a Staging #

Note

Changing the Managers Group of a Stanging will automatically unassign the old group and assign the new group to the related staging projects.

1.10.4.1 Create Staging Project from Scratch #

Right after the creation of a Staging, two new staging projects are automatically created and assigned to it: Staging:A and Staging:B. However, it is also possible to create a new staging project from scratch.

On the Staging dashboard, click on Configure and then on Create Project to add a name for the new staging project.

Figure 1.40: Create a New Staging Project #

1.10.4.2 Create Staging Project from Template #

It is possible to create a staging from a template. Inside Staging Configure page, simply choose the staging project you want to copy from (the template), click on its Copy icon on the actions column and add a new name. The staging project copy is processing on background, so there might be a delay before it shows up.

Figure 1.41: Copy Staging Project from Template #

A staging project contains requests assigned by a Staging Manager. An overview page is provided for a staging project where you can find more detailed information about the requests, reviews and checks.

Figure 1.42: Looking into a Staging Project #

All the actions performed on requests that are assigned to the staging project are tracked. They are listed in the 'History' section.

Figure 1.43: History #