55325a8549
This is the first patch in a series to add APIv1 support to the /projects/source routes. The change involves using the store.Sources key in a different way (as an id instead of as a duplicate of the struct's Name field) but does not actually involve changing the Sources json in the store. In the V0 API the name of the source was used as the identifier, and there was no short id. In V1 the source is identified by the API using a short id, and the Name is just a field in the struct to describe the source. This will become more obvious with the /projects/source/info response. This commit changes the following: Changes store.ListSources to ListSourcesByName and explicitly pulls the name from the source struct instead of the key. v0 will use this function call. Adds store.ListSourcesById which returns the source key as the identifier. This is used by v1. Adds a new weldr.SourcesListV1 response type, even though it is exactly the same as the V1 response in this specific case. I thought it would be better to have one called V1 than to reuse the V0 struct and possibly confuse people. The /projects/source/list API now lists the sources by name for v0 and id for v1. A test has been added. You will notice it still uses v0 to push and delete the sources. These will be updated when the new version of the functions are added in subsequent commits. |
||
|---|---|---|
| .github | ||
| cmd | ||
| distribution | ||
| docs | ||
| image-types | ||
| internal | ||
| osbuild@9cbedc0496 | ||
| repositories | ||
| schutzbot | ||
| test | ||
| tools | ||
| vendor | ||
| .gitignore | ||
| .gitmodules | ||
| .golangci.yml | ||
| .travis.yml | ||
| codecov.yml | ||
| CONTRIBUTING.md | ||
| dnf-json | ||
| go.mod | ||
| go.sum | ||
| golang-github-osbuild-composer.spec | ||
| LICENSE | ||
| Makefile | ||
| NEWS.md | ||
| osbuild-composer.spec | ||
| README.md | ||
OSBuild Composer
Operating System Image Composition Services
The composer project is a set of HTTP services for composing operating system images. It builds on the pipeline execution engine of osbuild and defines its own class of images that it supports building.
Multiple APIs are available to access a composer service. This includes support for the lorax-composer API, and as such can serve as drop-in replacement for lorax-composer.
You can control a composer instance either directly via the provided APIs, or through higher-level user-interfaces from external projects. This, for instance, includes a Cockpit Module or using the composer-cli command-line tool.
Project
- Website: https://www.osbuild.org
- Bug Tracker: https://github.com/osbuild/osbuild-composer/issues
About
Composer is a middleman between the workhorses from osbuild and the user-interfaces like cockpit-composer, composer-cli, or others. It defines a set of high-level image compositions that it supports building. Builds of these compositions can be requested via the different APIs of Composer, which will then translate the requests into pipeline-descriptions for osbuild. The pipeline output is then either provided back to the user, or uploaded to a user specified target.
The following image visualizes the overall architecture of the OSBuild infrastructure and the place that Composer takes:
Consult the osbuild-composer(7) man-page for an introduction into composer,
information on running your own composer instance, as well as details on the
provided infrastructure and services.
Requirements
The requirements for this project are:
osbuild >= 11systemd >= 244
At build-time, the following software is required:
go >= 1.12python-docutils >= 0.13
Build
The standard go package system is used. Consult upstream documentation for detailed help. In most situations the following commands are sufficient to build and install from source:
mkdir build
go build -o build ./...
The man-pages require python-docutils and can be built via:
make man
Repository:
- web: https://github.com/osbuild/osbuild-composer
- https:
https://github.com/osbuild/osbuild-composer.git - ssh:
git@github.com:osbuild/osbuild-composer.git
Pull request gating
Each pull request against osbuild-composer starts a series of automated
tests. Tests run via GitHub Actions, Travis CI, and Jenkins. Each push to
the pull request will launch theses tests automatically.
Jenkins only tests pull requests from members of the osbuild organization in
GitHub. A member of the osbuild organization must say ok to test in a pull
request comment to approve testing. Anyone can ask for testing to run by
saying the bot's favorite word, schutzbot, in a pull request comment.
Testing will begin shortly after the comment is posted.
Test results in Jenkins are available by clicking the Details link on the right side of the Schutzbot check in the pull request page.
License:
- Apache-2.0
- See LICENSE file for details.