Code Monkey home page Code Monkey logo

guides's Introduction

OSBuild

Build-Pipelines for Operating System Artifacts

OSBuild is a pipeline-based build system for operating system artifacts. It defines a universal pipeline description and a build system to execute them, producing artifacts like operating system images, working towards an image build pipeline that is more comprehensible, reproducible, and extendable.

See the osbuild(1) man-page for details on how to run osbuild, the definition of the pipeline description, and more.

Project

Principles

  1. OSBuild stages are never broken, only deprecated. The same manifest should always produce the same output.
  2. OSBuild stages should be explicit whenever possible instead of e.g. relying on the state of the tree.
  3. Pipelines are independent, so the tree is expected to be empty at the beginning of each.
  4. Manifests are expected to be machine-generated, so OSBuild has no convenience functions to support manually created manifests.
  5. The build environment is confined against accidental misuse, but this should not be considered a security boundary.
  6. OSBuild may only use Python language features supported by the oldest target distribution.

Contributing

Please refer to the developer guide to learn about our workflow, code style and more.

Requirements

The requirements for this project are:

  • bubblewrap >= 0.4.0
  • python >= 3.6

Additionally, the built-in stages require:

  • bash >= 5.0
  • coreutils >= 8.31
  • curl >= 7.68
  • qemu-img >= 4.2.0
  • rpm >= 4.15
  • tar >= 1.32
  • util-linux >= 235
  • skopeo

At build-time, the following software is required:

  • python-docutils >= 0.13
  • pkg-config >= 0.29

Testing requires additional software:

  • pytest

Build

Osbuild is a python script so it is not compiled. To verify changes made to the code use included makefile rules:

  • make lint to run linter on top of the code
  • make test-all to run base set of tests
  • sudo make test-run to run extended set of tests (takes long time)

Installation

Installing osbuild requires to not only install the osbuild module, but also additional artifacts such as tools (i.e: osbuild-mpp) sources, stages, schemas and SELinux policies.

For this reason, doing an installation from source is not trivial and the easier way to install it is to create the set of RPMs that contain all these components.

This can be done with the rpm make target, i.e:

make rpm

A set of RPMs will be created in the ./rpmbuild/RPMS/noarch/ directory and can be installed in the system using the distribution package manager, i.e:

sudo dnf install ./rpmbuild/RPMS/noarch/*.rpm

Repository

License

  • Apache-2.0
  • See LICENSE file for details.

guides's People

Contributors

7flying avatar achilleas-k avatar bcl avatar chloenayon avatar croissanne avatar diaasami avatar elianerpereira avatar elkoniu avatar ericzolf avatar evgenyz avatar gicmo avatar jordigilh avatar keilr avatar kingsleyzissou avatar lavocatt avatar lmilbaum avatar major avatar miabbott avatar mmartinv avatar msehnout avatar ochosi avatar oezeakachi avatar ondrejbudai avatar regexowl avatar rgolangh avatar schutzbot avatar supakeen avatar teg avatar thozza avatar ygalblum avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

guides's Issues

provide documentation on adding a copr repo as 3rd part repo

Managing repositories - OSBuild guides doesn't provide the documentation on adding a copr repo as 3rd part repo and neither does man composer-cli-sources,

Btw if I composer-cli sources add a TOML as follows,

id="kexec-tools-crashkernel"
name="kexec-tools-crashkernel"
url="https://download.copr.fedorainfracloud.org/results/coiby/kexec-tools-crashkernel/fedora-34-x86_64"
type="yum-baseurl"
check_gpg = false
check_ssl = false
system = false

Running composer-cli compose start crashkernel qcow2 gives the following error,

ERROR: DepsolveError: DNF error occured: RepoError: Error occurred when setting up repo: Failed to download metadata for repo '4': Cannot download repomd.xml: Cannot download repodata/repomd.xml: All mirrors were tried

Add glossary

It could explain terms that are used across our organization or it could point to the right place containing explanation:

  • manifest
  • blueprint
  • pipeline
  • upload target
  • etc

Provide CI build results in pull-requests

To enable better reviewing of PRs that refactor or restructure the guides (e.g. #86) it would be nice to add a step to our GitHub Actions workflow to provide the results of the build that happens anyway to the reviewer.

This is possible through the native archiving step (see https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts).
One limitation is that the archive is not available until after the workflow is done so you cannot easily post a comment with a link to the archive to the pull request.

"Managing repositories" section feedback

I have a few comments to the section:

  1. While the osbuild-composer does not inherit the system repositories, it comes with a few predefined repositories of its own in /usr/share/osbuild-composer. I think that it would make sense to mention it. Also it may make sense to mention, that /etc/osbuild-composer directory has a precedence over the one in /usr/share/ and can effectively override the default one shipped with osbuild-composer (since the list of paths is traversed in a specific order and the first found file is used).

  2. The sentence Then, create a JSON file with the following structure should be more specific, since it is mandatory for the JSON file to me named <distro>.json, e.g. fedora-32.json.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.