Release notes

This page contains the releases notes of Fatbuildr with details about the new features, modifications and bug fixes coming with all releases.

This page is rendered based on the content of CHANGELOG.md in Fatbuildr source code.

unreleased

Added

  • Add AppArmor profile for u-nspawn wrapper to execute this program, systemd-nspawn and some packages build utilities in restricted sandboxes.

  • Add AppArmor profile for fatbuildrd to run mkosi in unconfined sandboxes without transition to default unprivileged_userns profile.

  • conf: Add img_create_use_sysusersd boolean parameter in [format:*] section to control if fatbuildr system user is created with sysusers.d configuration file during image creation or with raw seeds of /etc/passwd, /etc/group and /etc/gshadow.

  • pkgs: Install and enable AppArmor profile for u-nspawn on systems that support this LSM.

  • docs:

    • Mention img_create_use_sysusersd parameter in [format:*] sections of system configuration.

    • Mention template filters timestamp_rpmdate, timestamp_iso and rpm_version in artifact definition reference documentation.

Changed

  • Use uncompressed skeleton archive to bootstrap fatbuildr system user in build images for compatibility with latest version of mkosi.

  • Boostrap fatbuildr system user with raw seed of /etc/passwd, /etc/group and /etc/gshadow instead of sysusers.d configuraton file in mkosi skeleton archive for RPM and OSI formats.

  • Use mock --unpriv instead of pre-stage1-rpm.sh to run prescript in order to avoid relying on working su command in build environment (#216).

  • conf:

    • Convert definition and path variables to Path objects to render [images] > create_cmd template and remove dirpath variable (replaced by path.parent).

    • Update [images] > create_cmd, images definitions and postinstall scripts to support mkosi >= 15 (#198).

    • Use --resolv-conf=bind-stub instead of --resolv-conf=replace-stub option for systemd-nspawn by default.

  • pkgs: Add dependency on RFL.core >= 1.1.0, required for asyncio_run wrapper.

Fixed

  • Fix infinite recursion error with PatchesSubdir on Python 3.12+ (#195).

  • Fix PermissionError on os.setresuid() when building OSI on Ubuntu 24.04 with AppArmor and unprivileged_userns profile (#197).

  • Fix SyntaxWarning on regexp raised by Python 3.12 on in utils module (#201).

  • Replace calls to shlex.join() by shlex_join() backport provided by rfl.core external library (#199).

  • Add template filter rpm_version designed to replace illegal character - by ~ in RPM spec Version field (#210).

  • web: Send *.xml.gz files in repositories with application/zip mimetype to fool aiohttp library and workaround Pulp and Red Hat Satellite synchronization checksum mismatch error (#194).

  • hooks: Fix DeprecationWarning: There is no current event loop in fatbuildr-matrix-notify raised in Python 3.12+ (#196).

  • docs:

    • Add missing sudo matrix hooks installation procedure.

    • Update quickstart guide to reflect fatbuildrctl command changes (thanks @kjrstory).

2.1.0 - 2024-07-16

Added

  • Add man command in OSI format container image.

  • Additionally to *.tar images, publish OSI registry all other images formats supported by mkosi (#112).

  • Give the possibility to run OSI builds directly on host instead of container to support images formats for which mkosi utility require access to loop devices (#111).

  • Support multiples OSI images in the checksum file published in the same registry derivative directory (#114).

  • Possiblity to define patches templates with variables to replace (#128).

  • Support generation of prescript tarballs with subdirectory at any depth in source tree (#154).

  • Support distribution and format specific tokens of prescript rules to allow definition of different values for different distributions and formats (#156).

  • Support installation of DNF modules as prescript dependencies for RPM packages builds (#155).

  • Automatically exclude from generated archive files untracked by git (ex: referenced in .gitignore) when building or managing patches from local source tree with initialized git repository (#153).

  • Possibility to declare in instance pipelines definitions DNF modules to enable in Mock build environments (#163).

  • Add reference to build task ID and instance name in RPM/deb package changelog entries (#15).

  • Add result exportable field to all runnable tasks.

  • Possibility to execute hook program before and after tasks are run (#19).

  • Add prep templating variable for RPM spec files as shorthand for prep_sources and prep_patches (#89).

  • Bash completion script for fatbuildrctl (#28).

  • cli:

    • Possibility to list artifacts in registries in remote instance with the REST API (#141)

    • Possibility to remove artifacts from registries in remote instance with the REST API (#142)

    • Add --include-git-untracked option to build and patches commands to avoid automatic exclusion from generated archive of files untracked by git in local source tree.

    • Possibility to execute command in arguments of images shell and images env-shell (#98).

    • Support $FATBUILDR_URI environment variable to override value in user preferences file (#124).

    • Add git message template for patches to help filling and formatting patches metadata with expected fields and values (#30).

    • Add --batch option to fatbuildrctl keyring command for keyring creation and renewal tasks.

    • Add size attribute to artifacts found in registry.

  • web:

    • Report fatbuildr version in footer of fatbuildrweb HTML pages (#108).

    • Support file listing and folders browsing in registries (#65).

    • List RPM/Deb binary artifacts content (#22).

    • Display artifacts sizes in derivatives and artifacts pages of the web interface (#23).

  • api:

    • Add edit-registry permission action.

    • Possibility to remove artifact from registries with DELETE verb on artifact route.

    • Introduce ArtifactContent objects.

    • Add content key in ArtifactDescription object associated to a list of ArtifactContent objects for Deb and RPM binary packages.

    • Add size attribute to Artifact objects.

  • conf:

    • Add containerized parameter in [format:osi] section.

    • Add exec_cmd and exec_tmpfile parameters in [format:deb] and [format:rpm] sections.

    • Add support of multiple build environments initialization commands.

    • Add optional env_default_modules parameter in [format:rpm] section.

    • Add listing boolean parameter in [web] section to control activation of listing feature in fatbuildrweb.

    • Add hook parameter in [tasks] section.

  • pkgs:

    • Add patch to define upstream version at build time.

    • Install tasks hooks examples uncompressed.

    • Install default system-wide git commit message template for patches in both Deb and RPM packages.

    • Install fatbuildrctl bash completion script in both Deb and RPM packages.

    • Install fatbuildr tmpfiles.d configuration.

    • Add bootstrap-icon additional source archive.

    • Install bootstrap icon fonts in Deb and RPM packages.

  • dbus:

    • Add ArtifactDeleteAs method to org.rackslab.Fatbuildr.Instance object to submit artifact deletion task with another user identity.

    • Add ArtifactContent method to org.rackslab.Fatbuildr.Instance object to retrieve the content of binary artifacts.

    • Add command argument to ImageShell method.

    • Add command argument to ImageEnvironmentShell method.

  • polkit: Add org.rackslab.Fatbuildr.edit-registry-as action.

  • docs:

    • Mention containerized parameter in [format:osi] section of system configuration.

    • Mention exec_cmd and exec_tmpfile parameters in [format:deb] and [format:rpm] sections of system configuration.

    • Mention new env_default_modules optional parameter in [format:rpm] section of system configuration.

    • Mention listing parameter in [web] section of system configuration.

    • Mention hook parameter in [tasks] section of system configuration.

    • Mention new modules optional parameter for RPM distributions in instance pipelines definitions.

    • Document patches DEP-3 metadata support with Fatbuildr specific fields and their management with fatbuildrctl patches subcommand.

    • Mention patches deb822 Template field and the patches templating feature.

    • Mention possibility of missing JWT signing key for REST API HTTP/404 reponse code.

    • Document impact of HTTP reverse proxies buffering on tasks output streams with mention of possible configuration settings.

    • Document HTTP reverse proxies settings of interest to allow submission of large artifact builds and avoid timeout in live task output.

    • Mention org.rackslab.Fatbuildr.edit-registry-as Polkit action.

    • Mention edit-registry REST API permission action.

    • Mention REST API route to delete artifact.

    • Mention syntax, usage and behaviour of distribution and format specific tokens of prescript rules.

    • Mention possibility to install DNF modules as prescript dependencies with module: prefix.

    • Mention new --include-git-untracked option for build and patches commands in fatbuildrctl manpage.

    • Mention new command option for images shell and images env-shell commands in fatbuildrctl manpage.

    • Mention support of $FATBUILDR_URI environment variable in fatbuildrctl manpage.

    • Explain upstream debian/ directory in present artifact archives is removed and replaced by Fatbuildr during Deb packages builds.

    • Add two examples of tasks hooks in Python:

      • Basic hook to send syslog message.

      • Advanced hook to send custom notifications messages (based on templates) on Matrix room.

    • Add Tasks Hooks page.

    • Mention new prep templating variable in artifact definition reference documentation for RPM spec files.

    • Mention new commit_template parameter in user preferences documentation in fatbuildrctl manpage.

    • Mention new --batch option for fatbuildrctl keyring command in manpage.

    • Mention content section in binary artifact web interface page.

    • Mention content key in ArtifactDescription object and introduce ArtifactContent object in REST API reference documentation.

    • Mention new size property of Artifact object in REST API reference documentation.

Changed

  • Rename Mock and Cowbuilder build environments to add fatbuildr- prefix.

  • Support mkosi v22 in osi image (#173).

  • Factorize RPM repository updates by running it once for all packages that share the same architecture (#49).

  • Replace fatbuildrd service runtime directory by fatbuildr tmpfiles.d configuration with POSIX ACL to give access to subdirectories to fatbuildr system user and benefit from automatic cleanup by systemd-tmpfiles.

  • cli: Watch task output by default when submitting tasks. The -w, --watch option is replaced by the opposite --batch option to submit tasks in background (#123).

  • conf:

    • Rename init_cmd→init_cmds parameter in [format:deb] and [format:rpm] sections of system configuration.

    • Bump Fedora release from 38 to 40 in rpm and osi container images.

    • Install all mkosi 22 optional dependencies required to get all features and assign newuidmap/newgidmap ranges for Fatbuildr system user in osi container image.

    • Install podman for Mock in rpm container image.

  • docs:

    • Update table of available remote features with new registry content listing and artifact deletion possibilities.

    • Mention possibility of HTTP/404 response code on supported derivative in REST API reference.

    • Split documentation of images command options by subcommands in manpage.

    • Replace -w, --watch option by opposite --batch option in manpage.

    • Remove mention of --watch options in various pages of documentation.

    • Use fatbuildrctl shell images <command> in troubleshooting page.

    • Rename init_cmd→init_cmds parameter in [format:deb] and [format:rpm] sections of system configuration.

    • Mention usage of %autopatch macro behind prep_patches templating variable in artifact definition reference documentation for RPM spec files.

    • Update supported Linux distributions in quickstart guide (drop Debian 11, Fedora 37-38, add Debian 13, Ubuntu 24.04, RHEL9, Fedora 38-40).

  • pkgs:

    • Use new prep variable in Fatbuildr RPM package spec file template.

    • Bump boostrap version to 5.3.3.

Fixed

  • Fix crash on client side when loading artifact definition for OSI builds (#100).

  • Fix crash due to concatation with incompatible types when defining the full release for OSI build on server side (#101).

  • Add apt command in container for OSI image to meet Debian and Ubuntu based images build requirements (#102).

  • Fix systemd-nspawn execution error through mkosi in OSI format container caused by unavailability of DBus system session (#103).

  • Fix GPG keys unsupported filetype error when running apt-get update on build of Debian OSI images due to missing cmp command (#104).

  • Search mkosi output image and checksum file in distro~release subdirectory in OSI builds (#105).

  • Fix permission error on OSI artifacts produced by mkosi by faking sudo environment (#106).

  • Fix AttributeError in fatbuildrd when publishing OSI artifacts (#107).

  • Make RegistryOsi ensure instance registry directory exists (#109).

  • Add missing chattr command in OSI container image (#110).

  • Fix wrongly filtered out files containing debian or .git words in their path when building local archive on build submission (#113).

  • Fix unusable version.dist variable in packaging code templates (#116).

  • Fix crash on build on unsupported derivative in instance pipelines (#117).

  • Fix crash on retrieving derivative version in artifact definition (#118).

  • Fix crash when main archive source is not defined on build of Deb or RPM package (#119).

  • Fix crash on missing checksum for a specific version in artifact definition file (#125).

  • Fix crash in fatbuildrweb 404 error handler when HTTP request view arguments are not defined due to error during view matching (#126).

  • Fix retrieval of instances list in DBus and fatbuildrweb when default instance is not defined (#127).

  • Fix crash in fatbuildrctl when user preferences file is missing (#130).

  • Fix crash in fatbuildrd when running containers with empty init_opts in site configuration file (#131).

  • Return HTTP/404 with appropriate error message instead of HTTP/500 (internal error) when trying to access exported armored public key on nonexistent keyring with fatbuildrweb (#133).

  • Report error properly with fatbuildrctl when remote HTTP instance replies with internal error and HTTP/500 (#136).

  • Report meaningful error message instead of generic HTTP/500 internal error when authenticating with JWT token on unexisting remote HTTP instance (#137).

  • Fix crash with when watching streamed tasks output with HTTP REST API (#138).

  • Avoid buffering with HTTP response headers on reverse proxies (#139).

  • Fix crash of fatbuildrweb on builds with unsupported derivative (#149).

  • Fix crash of fatbuildrctl on unexpected end of task output (#147)

  • Fix crash of fatbuildrctl on task output connection closed by HTTP reverse proxy (#148).

  • Sanitize PRESCRIPT_TARBALLS names for correct detection by Debian build system.

  • Enable network access to run prescript in Mock during RPM build.

  • Prescript failure due to missing groupadd/useradd commands (passwd package) in Debian sid build environment (#169).

  • Conflict between fatbuildrctl --uri option and fatbuildrctl tokens save --uri option that prevent fatbuildrctl tokens generate from connecting to an instance other than the default (#168).

  • Support artifact archive with existing debian/ folder. During deb packages builds, this upstream debian/ folder is removed and replaced by one generated with the artifact definition (#174).

  • Detect console unix socket closed by server, generally due to unexpected fatbuildrd error, in order to avoid endless loop and properly stop the console on client side (fatbuildrctl and fatbuildrweb) with error message.

  • Check OSI artifact checksum file is properly created by mkosi or raise task execution error to report in task journal.

  • Check container image and build environment exist or fail with appropriate error at the beginning of build tasks (#17).

  • Fix fatbuildrctl crash when RPM spec file is not found (#165).

  • Use modern %autopatch macro instead of loop of %patchN to avoid deprecated syntax error during RPM packages builds (#170).

  • Fix crash of fatbuildrctl on missing source definition in YAML artifact definition file (#171).

  • Handle JSON decode error in fatbuildrctl in case of unexpected failure in fatbuildrweb (#146).

  • Report error instead of crashing in fatbuildrctl when unable to find format corresponding to a given distribution with fatbuildrweb REST API (#172).

  • Validate keyring renewal duration format in server-side fatbuildrd and client-side fatbuildrctl (#31).

  • Fix reporting of keyring errors during keyring creation and renewal tasks execution.

  • Drop off artifact and sources archives tarballs in subdirectory of fatbuildr runtime directory to avoid potential collisions between multiple builds in queue (#179).

  • Fix flask.helpers locked_cached_property import error in recent versions of Flask (#190).

  • docs:

    • Add missing path parameter in REST API to retrieve artifact information.

    • Add missing optional architectures parameter in instances pipelines definitions reference documentation.

  • pkgs: Add missing dependency on patch package (#145).

2.0.0 - 2023-05-05

Added

  • web: add JWT token based authentication with RBAC policy for managing access permissions to the REST API and the HTML web endpoints (#21). Fatbuildr provides a default policy that can be overriden by site administrators.

  • Associate tasks to originating users (#79)

  • Automatic static analysis of RPM and Deb packages based on rpmlint and lintian after successful build (#16)

  • Add support of interactive build for RPM packages format (#61)

  • Add support of multiple sources for packages artifacts (#66)

  • Report Deb and RPM packages content after successful builds, with additional pbuilder hook and mock plugin respectively (#74)

  • Add possibility to purge tasks history and their workspaces directories with multiple configurable policies (#34)

  • Add support of plain files as additional sources in RPM packages (#86)

  • conf:

    • Add [tokens] section with settings to control generation and validation of JWT tokens.

    • Add policy and vendor_policy settings in [web] section to define path to RBAC policy definition file loaded by Fatbuildrweb.

    • Add [tasks] section with parameters to specify tasks workspaces location and tasks history purge policy.

  • polkit:

    • Add org.rackslab.Fatbuildr.manage-token action.

    • Add org.rackslab.Fatbuildr.build-as action.

    • Add org.rackslab.Fatbuildr.purge-history action.

  • dbus:

    • Add BuildAs method to org.rackslab.Fatbuildr.Instance object to submit build task with another user identity.

  • cli:

    • Add shell and env-shell operations to fatbuildrctl images command to open an interactive shell in a container running the image dedicated to a given format or in a build environment associated to a distribution (#18).

    • Add -d, --distribution option to fatbuildrctl images command to filter the container images or the build environments targeted by the operation.

    • Add -a, --architecture option to fatbuildrctl images command to limit the build environments targeted by the operation to a specific hardware architecture.

    • Add short option -f as an alternative to --format long option of fatbuildrctl images command.

    • Add fatbuildrctl tokens command to list, generate and save JWT tokens for HTTP REST API authentication in user’s tokens directory.

    • Add support for JWT token based authentication to Fatbuildrweb REST API.

    • Add support of HTTP/404 REST API response codes.

  • prefs: add optional tokens parameter in the prefs section for specifying the path of user’s tokens directory.

  • utils:

    • Add support of multiple sources archives in import-srcrpm.

    • Add support of plain files as RPM packages sources in import-srcrpm.

  • pkgs: add dependency on PyJWT python external library for managing JWT tokens.

  • docs:

    • Document tokens command in fatbuildrctl manpage.

    • Document tokens parameter in user’s preferences file in fatbuildrctl manpage.

    • Document new history purge subcommand in in fatbuildrctl manpage

    • Add section about API tokens in fatbuildrctl manpage.

    • Add section about Local sources and --sources option value format in fatbuildrctl manpage.

    • Add section about authentication in REST API reference page.

    • Mention new polkit actions org.rackslab.Fatbuildr.manage-token, org.rackslab.Fatbuildr.purge-history and org.rackslab.Fatbuildr.build-as with a special note for *-as actions.

    • Mention permission action required by all Fatbuildrweb REST API and HTML endpoints in references pages.

    • Document error object returned by REST API for denied permission.

    • Add section about policy configuration in Fatbuildrweb administration page.

    • Document system configuration new [tokens] section and new parameters in [web] section.

    • Document new purge parameter in [tasks] section.

    • Mention multiple sources support, static analysis, packages content listing, RBAC policy and JWT authentication in advanced features description.

    • Add page about packages source tree with all principles followed for various types of sources illustrated by new diagrams.

    • Mention HTTP/404 reponse codes in REST API when instance or task is unknown by fatbuildrd and when format, distribution, derivative, architecture or artifact is not found in registries.

    • Add page about tasks history purge capabilities with the various policies, the expected format of the limit value in configuration parameter and a quick howto setup regular automatic purge with a cronjob.

    • Add example cronjob for automatic regular tasks history purge.

    • Mention possibility to have additional plain files in the rpm subdirectory of artifacts definitions repository.

Fixed

  • Static analysis errors reported by ruff tool with a simple initial configuration (#75).

  • Properly remove deprecated source RPM packages from repository after a successful build (#58).

  • Compiler -Wunused-result warnings with binary wrappers (#70).

  • cli:

    • Avoid hazardous handling of unsupported errors, as a basis for better error management.

    • Handle unknown distribution error in server pipeline (#71)

    • Handle connection error to HTTP URI with readable error message (#10)

    • Print clear error if YAML artifact definition is not found

  • daemon: avoid global hazardous catch of all RuntimeErrors and restrict handling to supported FatbuildrRuntimeError, as a basis for better error management.

  • Avoid removal of tilde from version extracted in source tarball filename when submitted during build through HTTP REST API (#81).

  • Remove useless imports

  • images:

    • Fix fatbuildr user and group with host UID/GID in deb format container image due to possible conflicts with other installed Debian sid packages (#83)

    • Add missing shebang in derivatives pbuilder hook

  • docs: Fix prescript token names in artifact definition reference.

Changed

  • Merge queue and archives directories into a common workspaces directory (#88)

  • cli:

    • Transform images command options --create, --update, --create-envs and --update-envs into an operation positional argument with the corresponding possible values create, update, env-create, env-update.

    • Replace fatbuildrctl {patches,build} command options --source-dir and --source-version by generic option --sources.

    • Replace fatbuildrctl archives by fatbuildrctl history command to avoid confusion with the notion of source archives (#87)

  • artifacts:

    • Rename YAML artifact definition file from meta.yml to artifact.yml. The old name is still supported but the user is warned with a deprecation notice (#73).

    • Replace tarball option by source or sources, depending on the number of archive sources.

    • Modify format of versions, derivatives and checksums keys to support optional multiple sources for packages artifacts.

    • The RPM spec file token {{ source }} is replaced by {{ sources }} to declare possibly multiple sources.

  • conf:

    • Replaced queue and archives parameters in [dirs] section of system configuration by workspaces parameter in [tasks] section.

    • Bump Fedora release from 37 to 38 in rpm and osi container images (#96).

  • dbus: Replace Archives() by History() method in org.rackslab.Fatbuildr.Instance object to avoid confusion with the notion of source archives.

  • web:

    • Build tasks are submitted to fatbuildrd with original requesting user’s identity when fatbuildrd runs with another user (typically fatbuildr system user) so the tasks are properly associated to the original user.

    • Return HTTP/404 with clear error message when instance or task is unknown by fatbuildrd and when format, distribution, derivative, architecture or artifact is not found in registries (#64).

    • Introduce new array of SourceArchive objects in the properties of Task JSON objects for build tasks.

    • Modify optional source archives filename multipart build requests to support sending of multiples sources.

  • docs:

    • Convert APT sources file in quickstart guide from one-line format to Deb822-style format (#72)

    • Modify artifact definition reference documentation with changes introduced to support packages artifacts with multiple sources and many examples to cover most cases.

    • Modify REST API reference with changes introduced to support packages artifacts with multiple sources.

    • Replace options --source-dir and --source-version by --sources in fatbuildrctl manpage.

    • Modify system configuration reference to mention replacement of queue and archives in [dirs] section by common workspaces parameter in [tasks] section.

    • Update example outputs with new common workspaces directory to match new default paths.

    • Replace notion of archives by history to designate the list of terminated tasks.

    • Update support fedora release in quickstart guide to 37 and 38. Also update example instance file to mention fedora 38 instead of fedora 36.

  • Rename fatbuildr.web module to fatbuildr.procotols.http.server for more proximity with fatbuildr.procotols.http.client code.

  • pkgs:

    • Adapt artifact definitions and packaging code for fatbuildr and its dependencies to new format defined for multiple sources support.

    • Replace fatbuildr prescript with a supplementary source for bootstrap.

    • Bump dasbus dependency to latest version 1.7 (#67).

  • examples: Change hello package artifact definition to new format defined for multiple sources support.

Removed

  • pkgs: removed support of Fedora 36

  • docs: removed mention of Fedora 36 in quickstart guide

1.1.0 - 2023-03-13

Added

  • docs:

    • Add large Fatbuildr logos intended for docs.rackslab.io landing page

    • Add Release notes page based on CHANGELOG.md

    • Use tabs for distributions in quickstart guide

    • Mention support of Fedora 37 in quickstart guide (#68)

  • conf: add env_as_root boolean parameter in format:{deb,rpm} section to control if commands to create and update build environments are executed as root super-user or the user running fatbuildrd daemon.

  • pkgs: add CHANGELOG.md in \{deb,rpm} packages

  • templates: add gittag filter which is notably useful to transform version number into valid Git tag in tarball URL.

  • lib: make PatchQueue subshell optional

  • utils: add import-srcrpm utility to import an existing source RPM package and convert it into an artifact defined ready to be consumed by Fatbuildr.

Fixed

  • pkgs: remove useless symbolic link in prescript

  • cli:

    • Avoid catching unwanted AttributeError exceptions while checking for action argument on Python < 3.7.

    • Remove temporary directory after the patch queue is exported instead of relying on cleanup registry.

  • web:

    • Add missing return to fix the index redirect view (from / to /registry) when Fatbuildrweb is executed in mono-instance mode.

    • Fix support of Flask >= 2.0 (#69)

Changed

  • pkgs:

    • Bump the packaged version of mkosi from 13 to 14

    • Update Fatbuildr packages to depend on mkosi >= 14

  • conf:

    • Rename mkosi --skeleton option to --skeleton-tree to follow mkosi 14 change.

    • Bump Fedora release from 35 to 37 in rpm and osi container images

  • docs:

    • set more generic names for packages repositories in install guide

    • docs: doc folder in sources renamed to docs

1.0.0 - 2022-09-05