particle-os/debian-forge-composer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
2240 commits 1 branch 0 tags 688 MiB
Find a file
Ondřej Budai 5e8c022e6d docs: document the release process 
This commit adds RELEASING.md guide describing the process of making a new
upstream release and pushing it into Fedora and CentOS Stream 9.

Additionally, a new helper is added to the repository - update-distgit.py.
The purpose of this helper is to simplify work with the dist-git.

Random thoughts:
I decided to left off RHEL 8 because the guide would be full of internal
URLs and tools. I will probably write a similar guide for it and put it
into internal guides.

I decided to just reference the RHEL Developer Guide for CentOS Stream 9.
It's pretty well written and I didn't feel like duplicating the effort.

We should definitely switch to PR-based approach for Fedora and implement
at least some smoke tests. I believe that the current guide is good enough
and we can iterate later.

Signed-off-by: Ondřej Budai <ondrej@budai.cz>
2021-07-14 12:11:35 +02:00
.github bump minimum go version to 1.15 2021-07-07 17:26:18 +01:00
cmd osbuild-composer: Move InitWeldr code into weldr.New 2021-07-12 08:58:42 +02:00
containers/osbuild-composer containers: Specify port for the composer-api as argument 2020-12-23 17:31:29 +01:00
distribution distribution: Add cache dir to composer clouddot deployment 2021-06-23 10:33:22 +02:00
docs docs: Add release note about building for other distros 2021-07-12 08:58:42 +02:00
image-types image-types: Update RHEL8 Amazon EC2 image information 2021-01-15 17:48:19 +01:00
internal weldr: Filter the list of supported distributions 2021-07-12 08:58:42 +02:00
repositories distro: drop Fedora 32 2021-07-05 11:16:08 +02:00
schutzbot ci: add slack notfications 2021-07-12 11:21:01 +03:00
test test/fedora33: use rpmrepo instead of kernel mirrors 2021-07-14 12:05:45 +02:00
tools docs: document the release process 2021-07-14 12:11:35 +02:00
vendor worker: add azure image upload target 2021-03-06 15:40:48 +00:00
.gitignore gitignore: add config and OSX metadata 2021-02-20 14:53:49 +01:00
.gitlab-ci.yml ci: add slack notfications 2021-07-12 11:21:01 +03:00
.golangci.yml ci/lint: add integration tag 2020-03-17 20:36:58 +01:00
codecov.yml codevoc: fix threshold 2020-05-17 10:12:06 +02:00
CONTRIBUTING.md rcm: drop sub-package 2020-07-17 19:13:15 +01:00
DEPLOYING.md Add DEPLOYING.md 2020-10-20 15:43:30 +02:00
dnf-json dnf-json: don't initialize dnf plugins 2020-08-23 16:08:25 +02:00
go.mod bump minimum go version to 1.15 2021-07-07 17:26:18 +01:00
go.sum internal/upload: Add support for upload to GCP and CLI tool using it 2021-02-25 18:44:21 +00:00
HACKING.md HACKING: Typo fixes 2021-02-11 09:37:36 +01:00
krb5.conf upload/koji: add support for GSSAPI/Kerberos auth 2020-08-27 17:29:57 +01:00
LICENSE Revert "Fill in the license template" 2019-11-15 15:26:51 +01:00
Makefile Makefile: build osbuild-upload-gcp as part of build target 2021-03-12 12:17:02 +01:00
NEWS.md 30 2021-06-10 14:59:08 +02:00
osbuild-composer.spec spec: drop hacks for Fedora 32 2021-07-05 11:16:08 +02:00
README.md bump minimum go version to 1.15 2021-07-07 17:26:18 +01:00
RELEASING.md docs: document the release process 2021-07-14 12:11:35 +02:00
Schutzfile schutzfile: drop osbuild pin for CentOS Stream 8 2021-07-07 13:25:26 +02:00

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

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:

overview

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 >= 26
  • systemd >= 244

At build-time, the following software is required:

  • go >= 1.15
  • python-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:

Pull request gating

Each pull request against osbuild-composer starts a series of automated tests. Tests run via GitHub Actions 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.