From 08db3811faffc17285452c71d2119ed4befac519 Mon Sep 17 00:00:00 2001 From: schutzbot Date: Tue, 20 Aug 2024 09:25:42 +0000 Subject: [PATCH] Automated developer guide update --- docs/bootc/index.md | 122 +++++++++++++++++- .../02-projects/cockpit-composer/index.md | 10 ++ .../02-projects/cockpit-composer/testing.md | 10 ++ .../02-projects/composer-cli/HACKING.md | 10 ++ .../02-projects/composer-cli/index.md | 10 ++ .../image-builder-frontend/index.md | 10 ++ .../02-projects/image-builder/HACKING.md | 10 ++ .../02-projects/image-builder/index.md | 4 + .../02-projects/images/cmds.md | 4 + .../images/code-manifest-generation.md | 10 ++ .../02-projects/images/developer.md | 10 ++ .../02-projects/images/index.md | 4 + .../02-projects/images/testing.md | 10 ++ .../osbuild-composer/CONTRIBUTING.md | 10 ++ .../02-projects/osbuild-composer/DEPLOYING.md | 10 ++ .../02-projects/osbuild-composer/HACKING.md | 10 ++ .../02-projects/osbuild-composer/index.md | 4 + .../osbuild-composer/test/README.md | 10 ++ .../02-projects/osbuild/index.md | 10 ++ .../modules/stages/org.osbuild.anaconda.md | 9 +- .../modules/stages/org.osbuild.authconfig.md | 9 +- .../modules/stages/org.osbuild.authselect.md | 9 +- ...org.osbuild.bootc.install-to-filesystem.md | 9 +- .../org.osbuild.bootc.install.config.md | 9 +- .../stages/org.osbuild.bootiso.mono.md | 9 +- .../org.osbuild.bootupd.gen-metadata.md | 9 +- .../modules/stages/org.osbuild.bootupd.md | 9 +- .../stages/org.osbuild.btrfs.subvol.md | 9 +- .../modules/stages/org.osbuild.buildstamp.md | 9 +- .../modules/stages/org.osbuild.chattr.md | 9 +- .../modules/stages/org.osbuild.chmod.md | 9 +- .../modules/stages/org.osbuild.chown.md | 9 +- .../modules/stages/org.osbuild.chrony.md | 9 +- .../stages/org.osbuild.clevis.luks-bind.md | 9 +- .../modules/stages/org.osbuild.cloud-init.md | 9 +- .../stages/org.osbuild.container-deploy.md | 9 +- .../org.osbuild.containers.storage.conf.md | 9 +- .../modules/stages/org.osbuild.copy.md | 9 +- .../stages/org.osbuild.coreos.platform.md | 9 +- .../modules/stages/org.osbuild.cpio.out.md | 9 +- .../modules/stages/org.osbuild.cron.script.md | 9 +- .../modules/stages/org.osbuild.crypttab.md | 9 +- .../modules/stages/org.osbuild.debug-shell.md | 9 +- .../modules/stages/org.osbuild.discinfo.md | 9 +- .../modules/stages/org.osbuild.dmverity.md | 9 +- .../org.osbuild.dnf-automatic.config.md | 9 +- .../modules/stages/org.osbuild.dnf.config.md | 9 +- .../modules/stages/org.osbuild.dnf4.mark.md | 9 +- .../modules/stages/org.osbuild.dracut.conf.md | 9 +- .../modules/stages/org.osbuild.dracut.md | 9 +- .../modules/stages/org.osbuild.erofs.md | 9 +- .../modules/stages/org.osbuild.error.md | 9 +- .../org.osbuild.experimental.ostree.config.md | 9 +- .../osbuild/modules/stages/org.osbuild.fdo.md | 9 +- .../modules/stages/org.osbuild.firewall.md | 9 +- .../modules/stages/org.osbuild.first-boot.md | 9 +- .../modules/stages/org.osbuild.fix-bls.md | 9 +- .../modules/stages/org.osbuild.fstab.md | 9 +- .../org.osbuild.gcp.guest-agent.conf.md | 9 +- .../modules/stages/org.osbuild.greenboot.md | 9 +- .../modules/stages/org.osbuild.groups.md | 9 +- .../modules/stages/org.osbuild.grub2.inst.md | 9 +- .../modules/stages/org.osbuild.grub2.iso.md | 9 +- .../stages/org.osbuild.grub2.legacy.md | 9 +- .../modules/stages/org.osbuild.grub2.md | 9 +- .../modules/stages/org.osbuild.gunzip.md | 9 +- .../modules/stages/org.osbuild.gzip.md | 9 +- .../modules/stages/org.osbuild.hostname.md | 9 +- .../modules/stages/org.osbuild.ignition.md | 9 +- .../stages/org.osbuild.implantisomd5.md | 9 +- .../modules/stages/org.osbuild.isolinux.md | 9 +- .../org.osbuild.kernel-cmdline.bls-append.md | 9 +- .../stages/org.osbuild.kernel-cmdline.md | 9 +- .../modules/stages/org.osbuild.keymap.md | 9 +- .../modules/stages/org.osbuild.kickstart.md | 9 +- .../modules/stages/org.osbuild.livesys.md | 9 +- .../modules/stages/org.osbuild.locale.md | 9 +- .../stages/org.osbuild.lorax-script.md | 9 +- .../stages/org.osbuild.luks2.format.md | 9 +- .../stages/org.osbuild.luks2.remove-key.md | 9 +- .../modules/stages/org.osbuild.lvm2.create.md | 9 +- .../stages/org.osbuild.lvm2.metadata.md | 9 +- .../modules/stages/org.osbuild.machine-id.md | 9 +- .../modules/stages/org.osbuild.mkdir.md | 9 +- .../modules/stages/org.osbuild.mkfs.btrfs.md | 9 +- .../modules/stages/org.osbuild.mkfs.ext4.md | 9 +- .../modules/stages/org.osbuild.mkfs.fat.md | 9 +- .../modules/stages/org.osbuild.mkfs.xfs.md | 9 +- .../modules/stages/org.osbuild.mkinitcpio.md | 9 +- .../modules/stages/org.osbuild.modprobe.md | 9 +- .../modules/stages/org.osbuild.nginx.conf.md | 9 +- .../modules/stages/org.osbuild.nm.conf.md | 9 +- .../modules/stages/org.osbuild.nm.conn.md | 9 +- .../modules/stages/org.osbuild.noop.md | 9 +- .../modules/stages/org.osbuild.oci-archive.md | 9 +- .../stages/org.osbuild.oscap.autotailor.md | 9 +- .../stages/org.osbuild.oscap.remediation.md | 9 +- .../stages/org.osbuild.ostree.aleph.md | 9 +- .../stages/org.osbuild.ostree.commit.md | 9 +- .../stages/org.osbuild.ostree.config.md | 9 +- .../org.osbuild.ostree.deploy.container.md | 9 +- .../stages/org.osbuild.ostree.deploy.md | 9 +- .../stages/org.osbuild.ostree.encapsulate.md | 9 +- .../stages/org.osbuild.ostree.fillvar.md | 9 +- .../stages/org.osbuild.ostree.genkey.md | 9 +- .../stages/org.osbuild.ostree.init-fs.md | 9 +- .../modules/stages/org.osbuild.ostree.init.md | 9 +- .../modules/stages/org.osbuild.ostree.md | 9 +- .../stages/org.osbuild.ostree.os-init.md | 9 +- .../stages/org.osbuild.ostree.passwd.md | 9 +- .../stages/org.osbuild.ostree.post-copy.md | 9 +- .../stages/org.osbuild.ostree.preptree.md | 9 +- .../modules/stages/org.osbuild.ostree.pull.md | 9 +- .../stages/org.osbuild.ostree.remotes.md | 9 +- .../stages/org.osbuild.ostree.selinux.md | 9 +- .../modules/stages/org.osbuild.ostree.sign.md | 9 +- .../osbuild/modules/stages/org.osbuild.ovf.md | 9 +- .../stages/org.osbuild.pacman-keyring.md | 9 +- .../modules/stages/org.osbuild.pacman.conf.md | 9 +- .../modules/stages/org.osbuild.pacman.md | 9 +- .../org.osbuild.pacman.mirrorlist.conf.md | 9 +- .../stages/org.osbuild.pam.limits.conf.md | 9 +- .../modules/stages/org.osbuild.parted.md | 9 +- .../stages/org.osbuild.pwquality.conf.md | 9 +- .../modules/stages/org.osbuild.qemu.md | 9 +- .../modules/stages/org.osbuild.resolv-conf.md | 9 +- .../modules/stages/org.osbuild.rhsm.facts.md | 9 +- .../modules/stages/org.osbuild.rhsm.md | 9 +- .../modules/stages/org.osbuild.rpm-ostree.md | 9 +- .../modules/stages/org.osbuild.rpm.macros.md | 9 +- .../osbuild/modules/stages/org.osbuild.rpm.md | 9 +- .../stages/org.osbuild.rpmkeys.import.md | 9 +- .../stages/org.osbuild.selinux.config.md | 9 +- .../modules/stages/org.osbuild.selinux.md | 9 +- .../modules/stages/org.osbuild.sfdisk.md | 9 +- .../modules/stages/org.osbuild.sgdisk.md | 9 +- .../modules/stages/org.osbuild.shell.init.md | 9 +- .../modules/stages/org.osbuild.skopeo.md | 9 +- .../modules/stages/org.osbuild.squashfs.md | 9 +- .../modules/stages/org.osbuild.sshd.config.md | 9 +- .../modules/stages/org.osbuild.sysconfig.md | 9 +- .../modules/stages/org.osbuild.sysctld.md | 9 +- .../stages/org.osbuild.systemd-journald.md | 9 +- .../stages/org.osbuild.systemd-logind.md | 9 +- .../modules/stages/org.osbuild.systemd.md | 9 +- .../stages/org.osbuild.systemd.preset.md | 9 +- .../stages/org.osbuild.systemd.unit.create.md | 9 +- .../stages/org.osbuild.systemd.unit.md | 9 +- .../osbuild/modules/stages/org.osbuild.tar.md | 9 +- .../modules/stages/org.osbuild.test.md | 9 +- .../modules/stages/org.osbuild.timezone.md | 9 +- .../modules/stages/org.osbuild.tmpfilesd.md | 9 +- .../modules/stages/org.osbuild.truncate.md | 9 +- .../modules/stages/org.osbuild.tuned.md | 9 +- .../modules/stages/org.osbuild.udev.rules.md | 9 +- .../osbuild/modules/stages/org.osbuild.uki.md | 9 +- .../modules/stages/org.osbuild.untar.md | 9 +- .../org.osbuild.update-crypto-policies.md | 9 +- .../modules/stages/org.osbuild.users.md | 9 +- .../modules/stages/org.osbuild.vagrant.md | 9 +- .../stages/org.osbuild.waagent.conf.md | 9 +- .../modules/stages/org.osbuild.wsl.conf.md | 9 +- .../modules/stages/org.osbuild.xorrisofs.md | 9 +- .../osbuild/modules/stages/org.osbuild.xz.md | 9 +- .../modules/stages/org.osbuild.yum.config.md | 9 +- .../modules/stages/org.osbuild.yum.repos.md | 9 +- .../osbuild/modules/stages/org.osbuild.zip.md | 9 +- .../modules/stages/org.osbuild.zipl.inst.md | 9 +- .../modules/stages/org.osbuild.zipl.md | 9 +- .../modules/stages/org.osbuild.zstd.md | 9 +- .../02-projects/rpmrepo/index.md | 4 + 171 files changed, 1488 insertions(+), 153 deletions(-) diff --git a/docs/bootc/index.md b/docs/bootc/index.md index f11d940079..a94659da52 100644 --- a/docs/bootc/index.md +++ b/docs/bootc/index.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/bootc-image-builder/blob/main/README.md +--- # bootc-image-builder + + A container to create disk images from [bootc](https://github.com/containers/bootc) container inputs, especially oriented towards [Fedora/CentOS bootc](https://docs.fedoraproject.org/en-US/bootc/) or derivatives. @@ -343,6 +352,55 @@ Example: ``` +### Filesystems (`filesystem`, array) + +The filesystem section of the customizations can be used to set the minimum size of the base partitions (`/` and `/boot`) as well as to create extra partitions with mountpoints under `/var`. + +```toml +[[customizations.filesystem]] +mountpoint = "/" +minsize = "10 GiB" + +[[customizations.filesystem]] +mountpoint = "/var/data" +minsize = "20 GiB" +``` + +```json +{ + "customizations": { + "filesystem": [ + { + "mountpoint": "/", + "minsize": "10 GiB" + }, + { + "mountpoint": "/var/data", + "minsize": "20 GiB" + } + ] + } +} +``` + +#### Interaction with `rootfs` + +#### Filesystem types + +The `--rootfs` option also sets the filesystem types for all additional mountpoints, where appropriate. See the see [Detailed description of optional flags](#detailed-description-of-optional-flags). + + +#### Allowed mountpoints and sizes + +The following restrictions and rules apply, unless the rootfs is `btrfs`: +- `/` can be specified to set the desired (minimum) size of the root filesystem. The final size of the filesystem, mounted at `/sysroot` on a booted system, is the value specified in this configuration or 2x the size of the base container, whichever is largest. +- `/boot`can be specified to set the desired size of the boot partition. +- Subdirectories of `/var` are supported, but symlinks in `/var` are not. For example, `/var/home` and `/var/run` are symlinks and cannot be filesystems on their own. +- `/var` itself cannot be a mountpoint. + +The `rootfs` option (or source container config, see [Detailed description of optional flags](#detailed-description-of-optional-flags) section) defines the filesystem type for the root filesystem. Currently, creation of btrfs subvolumes at build time is not supported. Therefore, if the `rootfs` is `btrfs`, no custom mountpoints are supported under `/var`. Only `/` and `/boot` can be configured. + + ### Anaconda ISO (installer) options (`installer`, mapping) Users can include kickstart file content that will be added to an ISO build to configure the installation process. @@ -375,6 +433,66 @@ The equivalent in json would be: Note that bootc-image-builder will automatically add the command that installs the container image (`ostreecontainer ...`), so this line or any line that conflicts with it should not be included. See the relevant [Kickstart documentation](https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html#ostreecontainer) for more information. No other kickstart commands are added by bootc-image-builder in this case, so it is the responsibility of the user to provide all other commands (for example, for partitioning, network, language, etc). +#### Anaconda ISO (installer) Modules + +The Anaconda installer can be configured by enabling or disabling its dbus modules. + +```toml +[customizations.installer.modules] +enable = [ + "org.fedoraproject.Anaconda.Modules.Localization" +] +disable = [ + "org.fedoraproject.Anaconda.Modules.Users" +] +``` + +```json +{ + "customizations": { + "installer": { + "modules": { + "enable": [ + "org.fedoraproject.Anaconda.Modules.Localization" + ], + "disable": [ + "org.fedoraproject.Anaconda.Modules.Users" + ] + } + } + } +} +``` + +The following module names are known and supported: +- `org.fedoraproject.Anaconda.Modules.Localization` +- `org.fedoraproject.Anaconda.Modules.Network` +- `org.fedoraproject.Anaconda.Modules.Payloads` +- `org.fedoraproject.Anaconda.Modules.Runtime` +- `org.fedoraproject.Anaconda.Modules.Security` +- `org.fedoraproject.Anaconda.Modules.Services` +- `org.fedoraproject.Anaconda.Modules.Storage` +- `org.fedoraproject.Anaconda.Modules.Subscription` +- `org.fedoraproject.Anaconda.Modules.Timezone` +- `org.fedoraproject.Anaconda.Modules.Users` + +*Note: The values are not validated. Any name listed under `enable` will be added to the Anaconda configuration. This way, new or unknown modules can be enabled. However, it also means that mistyped or incorrect values may cause Anaconda to fail to start.* + +By default, the following modules are enabled for all Anaconda ISOs: +- `org.fedoraproject.Anaconda.Modules.Network` +- `org.fedoraproject.Anaconda.Modules.Payloads` +- `org.fedoraproject.Anaconda.Modules.Security` +- `org.fedoraproject.Anaconda.Modules.Services` +- `org.fedoraproject.Anaconda.Modules.Storage` +- `org.fedoraproject.Anaconda.Modules.Users` + + +##### Enable vs Disable priority + +The `disable` list is processed after the `enable` list and therefore takes priority. In other words, adding the same module in both `enable` and `disable` will result in the module being **disabled**. +Furthermore, adding a module that is enabled by default to `disable` will result in the module being **disabled**. + + ## Building To build the container locally you can run @@ -413,8 +531,7 @@ The contents of the file `$(pwd)/wheel-passwordless-sudo` should be Please report bugs to the [Bug Tracker](https://github.com/osbuild/bootc-image-builder/issues) and include instructions to reproduce and the output of: ``` -$ sudo podman run --rm -it --entrypoint=/usr/bin/bootc-image-builder \ - quay.io/centos-bootc/bootc-image-builder:latest version +$ sudo podman run --rm -it quay.io/centos-bootc/bootc-image-builder:latest version ``` ## 📊 Project @@ -440,3 +557,4 @@ workflow, code style and more. - **Apache-2.0** - See LICENSE file for details. + diff --git a/docs/developer-guide/02-projects/cockpit-composer/index.md b/docs/developer-guide/02-projects/cockpit-composer/index.md index d756a1dc45..a5128f4b43 100644 --- a/docs/developer-guide/02-projects/cockpit-composer/index.md +++ b/docs/developer-guide/02-projects/cockpit-composer/index.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/cockpit-composer/blob/main/README.md +--- # Cockpit Composer + + [![codecov](https://codecov.io/gh/osbuild/cockpit-composer/branch/main/graph/badge.svg)](https://codecov.io/gh/osbuild/cockpit-composer) **The web interface for on-premises Image Builder!** @@ -164,3 +173,4 @@ This source code is licensed under the MIT license found in the [`LICENSE.txt`]( --- Made with ♥ by the [OSBuild team](https://github.com/orgs/osbuild/people), [Welder team](https://github.com/orgs/weldr/people), [Cockpit team](https://github.com/orgs/cockpit-project/people), and contributors + diff --git a/docs/developer-guide/02-projects/cockpit-composer/testing.md b/docs/developer-guide/02-projects/cockpit-composer/testing.md index 2d16259e2b..3ff310754e 100644 --- a/docs/developer-guide/02-projects/cockpit-composer/testing.md +++ b/docs/developer-guide/02-projects/cockpit-composer/testing.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/cockpit-composer/blob/main/test/README.md +--- # Cockpit-Composer Integration Test + + The integration test for Cockpit Composer! It is performed on the application level and tests whether the business requirements are met regardless of app internal architecture, dependencies, data integrity and such. @@ -107,3 +116,4 @@ the number of json files will be equal or less to the number of test cases. Python code in this project should follow [Flake8](https://www.flake8rules.com/). + diff --git a/docs/developer-guide/02-projects/composer-cli/HACKING.md b/docs/developer-guide/02-projects/composer-cli/HACKING.md index 52e4837844..14e1ec50b1 100644 --- a/docs/developer-guide/02-projects/composer-cli/HACKING.md +++ b/docs/developer-guide/02-projects/composer-cli/HACKING.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/weldr-client/blob/main/HACKING.md +--- # Hacking on composer-cli + + This new implementation of composer-cli is broken up into 2 major pieces. The `./weldr/` package contains the library functions for communicating with the API server. These functions are publicly accessible and should be documented so @@ -146,3 +155,4 @@ Integration tests are run by a test binary. You can build the binary by running output more verbose details about the tests being run. + diff --git a/docs/developer-guide/02-projects/composer-cli/index.md b/docs/developer-guide/02-projects/composer-cli/index.md index 5b4e0c20b3..998a65f174 100644 --- a/docs/developer-guide/02-projects/composer-cli/index.md +++ b/docs/developer-guide/02-projects/composer-cli/index.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/weldr-client/blob/main/README.md +--- # composer-cli + + `composer-cli` is a command line utility used with [osbuild-composer](https://www.osbuild.org) to manage blueprints, build and upload images, and manage source repositories. @@ -505,3 +514,4 @@ When adding additional sources you must make sure that the packages in the sourc conflict with any other package sources, otherwise depsolving will fail. [examples]: https://github.com/osbuild/weldr-client/tree/main/examples + diff --git a/docs/developer-guide/02-projects/image-builder-frontend/index.md b/docs/developer-guide/02-projects/image-builder-frontend/index.md index 1c577a4d97..5d8077a682 100644 --- a/docs/developer-guide/02-projects/image-builder-frontend/index.md +++ b/docs/developer-guide/02-projects/image-builder-frontend/index.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/image-builder-frontend/blob/main/README.md +--- # Image Builder Frontend + + ## Principles 1. We want to use the latest and greatest web technologies. @@ -305,3 +314,4 @@ Follow these steps to find and paste the certification file into the 'Keychain A 8. Close the localhost screen. 9. Run `npm run stage-beta:msw` and open the Firefox browser to verify that it is working as expected. + diff --git a/docs/developer-guide/02-projects/image-builder/HACKING.md b/docs/developer-guide/02-projects/image-builder/HACKING.md index 433d6597e5..e7d02f8681 100644 --- a/docs/developer-guide/02-projects/image-builder/HACKING.md +++ b/docs/developer-guide/02-projects/image-builder/HACKING.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/image-builder/blob/main/HACKING.md +--- # Image Builder contributing guide + + Please refer to the [developer guide](https://www.osbuild.org/docs/developer-guide/index) to learn about our workflow, code style and more. ## Running the project locally @@ -32,3 +41,4 @@ file to generate a package list. If the repository requires a client tls key/cert you can supply them with `--key` and `--cert`. + diff --git a/docs/developer-guide/02-projects/image-builder/index.md b/docs/developer-guide/02-projects/image-builder/index.md index 68a8f27488..6097746504 100644 --- a/docs/developer-guide/02-projects/image-builder/index.md +++ b/docs/developer-guide/02-projects/image-builder/index.md @@ -1,3 +1,6 @@ +--- +custom_edit_url: https://github.com/osbuild/image-builder/blob/main/README.md +--- Image Builder ============= @@ -62,3 +65,4 @@ To run the project use `make run` target - **Apache-2.0** - See LICENSE file for details. + diff --git a/docs/developer-guide/02-projects/images/cmds.md b/docs/developer-guide/02-projects/images/cmds.md index c8ec742fc2..90fbf56eea 100644 --- a/docs/developer-guide/02-projects/images/cmds.md +++ b/docs/developer-guide/02-projects/images/cmds.md @@ -1,3 +1,6 @@ +--- +custom_edit_url: https://github.com/osbuild/images/blob/main/docs/developer/cmds.md +--- ### Useful cmds The following utilities, defined in the `cmd/` directory, are useful for @@ -160,3 +163,4 @@ perform the same actions as the `teardown` subcommand. The `cmd/list-images` utility simply lists all available combinations of distribution, architecture, and image type. It also supports filtering one or more of those three variables. + diff --git a/docs/developer-guide/02-projects/images/code-manifest-generation.md b/docs/developer-guide/02-projects/images/code-manifest-generation.md index 996660d3d4..68132c5232 100644 --- a/docs/developer-guide/02-projects/images/code-manifest-generation.md +++ b/docs/developer-guide/02-projects/images/code-manifest-generation.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/images/blob/main/docs/developer/code-manifest-generation.md +--- # Manifest generation + + This document explains how manifests are generated in code. It is useful for understanding how (and where) changes should be made in the pipeline generation code to have the desired effect. @@ -184,3 +193,4 @@ function. [godoc-manifest-manifest-serialize]: https://pkg.go.dev/github.com/osbuild/images@main/pkg/manifest#Manifest.Serialize [godoc-json-marshal]: https://pkg.go.dev/encoding/json#Marshal [godoc-image-imagekind]: https://pkg.go.dev/github.com/osbuild/images@main/pkg/image#ImageKind + diff --git a/docs/developer-guide/02-projects/images/developer.md b/docs/developer-guide/02-projects/images/developer.md index 7a5dac17e8..f3e8180f17 100644 --- a/docs/developer-guide/02-projects/images/developer.md +++ b/docs/developer-guide/02-projects/images/developer.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/images/blob/main/docs/developer/README.md +--- # Hacking on osbuild/images + + ## Local development environment To build most binaries defined in `cmd` and run tests you will need to install `gpgme-devel`. @@ -19,3 +28,4 @@ The full list of dependencies is: - [Useful cmds](./cmds.md) for development and testing. - [Manifest generation code](./code-manifest-generation.md) + diff --git a/docs/developer-guide/02-projects/images/index.md b/docs/developer-guide/02-projects/images/index.md index 3c04f3644c..b91044ba52 100644 --- a/docs/developer-guide/02-projects/images/index.md +++ b/docs/developer-guide/02-projects/images/index.md @@ -1,3 +1,6 @@ +--- +custom_edit_url: https://github.com/osbuild/images/blob/main/README.md +--- Images ====== @@ -38,3 +41,4 @@ will launch theses tests automatically. - **Apache-2.0** - See LICENSE file for details. + diff --git a/docs/developer-guide/02-projects/images/testing.md b/docs/developer-guide/02-projects/images/testing.md index f592c9aa47..5a924ada75 100644 --- a/docs/developer-guide/02-projects/images/testing.md +++ b/docs/developer-guide/02-projects/images/testing.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/images/blob/main/test/README.md +--- # osbuild/images testing information + + [./test/configs/](https://github.com/osbuild/images/tree/main/test/configs/) contains configuration files for building images for testing. The files are used by the following tools: - [./cmd/build](https://github.com/osbuild/images/tree/main/cmd/build) takes a config file as argument to build an image. For example: @@ -150,3 +159,4 @@ Each build job runs in parallel. For each image that is successfully built, a fi - ``: a concatenation of all the elements that define a unique build configuration. It is created as `---` with dashes `-` in each component replaced by underscores `_` (e.g. `fedora_38-x86_64-qcow2-all_customizations`). - ``: the ID of the last stage of the manifest. The manifest ID is unaffected by content sources (RPM or commit URLs for example) but not by content hashes. - ``: the commit ID specified in the `Schutzfile` under `.dependencies.osbuild.commit`. If not specified, it defaults to `RELEASE` and means that osbuild version was installed from the distribution repositories and the `` is the released version for the given distribution. + diff --git a/docs/developer-guide/02-projects/osbuild-composer/CONTRIBUTING.md b/docs/developer-guide/02-projects/osbuild-composer/CONTRIBUTING.md index f0b26e2a4f..75737790a0 100644 --- a/docs/developer-guide/02-projects/osbuild-composer/CONTRIBUTING.md +++ b/docs/developer-guide/02-projects/osbuild-composer/CONTRIBUTING.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/osbuild-composer/blob/main/CONTRIBUTING.md +--- # Contributing to osbuild-composer + + First of all, thank you for taking the time to contribute to osbuild-composer. In this document you will find information that can help you with your contribution. @@ -85,3 +94,4 @@ The commits in the PR should have these properties: [1] If you are running macOS, you can still compile osbuild-composer. If it doesn't work out of the box, use `-tags macos` together with any `go` command, for example: `go test -tags macos ./...` + diff --git a/docs/developer-guide/02-projects/osbuild-composer/DEPLOYING.md b/docs/developer-guide/02-projects/osbuild-composer/DEPLOYING.md index 4c3fb4db84..86c856fb00 100644 --- a/docs/developer-guide/02-projects/osbuild-composer/DEPLOYING.md +++ b/docs/developer-guide/02-projects/osbuild-composer/DEPLOYING.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/osbuild-composer/blob/main/DEPLOYING.md +--- # Deploying osbuild-composer + + *osbuild-composer* has currently has to be deployed in a virtual machine. The [tools](https://github.com/osbuild/osbuild-composer/tree/main/tools) subdirectory contains various scripts (those starting with `deploy-`) to deploy it into cloud-init-enabled environemnts. These scripts all @@ -46,3 +55,4 @@ machine to create. For example: "network": "my-network-id" } ``` + diff --git a/docs/developer-guide/02-projects/osbuild-composer/HACKING.md b/docs/developer-guide/02-projects/osbuild-composer/HACKING.md index 34d72dd7ca..af69c93989 100644 --- a/docs/developer-guide/02-projects/osbuild-composer/HACKING.md +++ b/docs/developer-guide/02-projects/osbuild-composer/HACKING.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/osbuild-composer/blob/main/HACKING.md +--- # Hacking on osbuild-composer + + ## Virtual Machine *osbuild-composer* cannot be run from the source tree, but has to be installed @@ -115,3 +124,4 @@ You can use curl to access the Cloud API: ``` curl --unix-socket /run/cloudapi/api.socket -XGET http://localhost/api/image-builder-composer/v2/openapi ``` + diff --git a/docs/developer-guide/02-projects/osbuild-composer/index.md b/docs/developer-guide/02-projects/osbuild-composer/index.md index 624af07015..f109e44747 100644 --- a/docs/developer-guide/02-projects/osbuild-composer/index.md +++ b/docs/developer-guide/02-projects/osbuild-composer/index.md @@ -1,3 +1,6 @@ +--- +custom_edit_url: https://github.com/osbuild/osbuild-composer/blob/main/README.md +--- OSBuild Composer ================ @@ -132,3 +135,4 @@ right side of the Schutzbot check in the pull request page. - **Apache-2.0** - See LICENSE file for details. + diff --git a/docs/developer-guide/02-projects/osbuild-composer/test/README.md b/docs/developer-guide/02-projects/osbuild-composer/test/README.md index ffef9377e5..0d4441f692 100644 --- a/docs/developer-guide/02-projects/osbuild-composer/test/README.md +++ b/docs/developer-guide/02-projects/osbuild-composer/test/README.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/osbuild-composer/blob/main/test/README.md +--- # osbuild-composer testing information + + With the exception of unit tests, all the osbuild-composer tests are shipped in a dedicated RPM: osbulid-composer-tests, and they are meant to be installed onto a pristine system and executed from there, rather than executed from a @@ -388,3 +397,4 @@ just trigger it manually. !['Create pipeline schedule'](https://github.com/osbuild/osbuild-composer/tree/main/test/gitlab_ci_scheduled_pipeline.png) !['Trigger scheduled pipeline'](https://github.com/osbuild/osbuild-composer/tree/main/test/gitlab_ci_schedule_trigger.png) + diff --git a/docs/developer-guide/02-projects/osbuild/index.md b/docs/developer-guide/02-projects/osbuild/index.md index 252cc32517..077d94aafc 100644 --- a/docs/developer-guide/02-projects/osbuild/index.md +++ b/docs/developer-guide/02-projects/osbuild/index.md @@ -1,5 +1,14 @@ +--- +custom_edit_url: https://github.com/osbuild/osbuild/blob/main/README.md +--- # OSBuild + + Build-Pipelines for Operating System Artifacts OSBuild is a pipeline-based build system for operating system artifacts. It @@ -99,3 +108,4 @@ sudo dnf install ./rpmbuild/RPMS/noarch/*.rpm - **Apache-2.0** - See LICENSE file for details. + diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.anaconda.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.anaconda.md index 62dca00816..c16ec493ef 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.anaconda.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.anaconda.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.anaconda.meta.json +--- # org.osbuild.anaconda + **Configure basic aspects of the anaconda installer** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.authconfig.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.authconfig.md index f802196427..3ace75643d 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.authconfig.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.authconfig.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.authconfig.meta.json +--- # org.osbuild.authconfig + **Configure authentication sources using authconfig.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.authselect.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.authselect.md index b9cffab878..b2dce80e0e 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.authselect.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.authselect.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.authselect.meta.json +--- # org.osbuild.authselect + **Select system identity and authentication sources with authselect.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootc.install-to-filesystem.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootc.install-to-filesystem.md index 03fe2afab5..6876511b8c 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootc.install-to-filesystem.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootc.install-to-filesystem.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.bootc.install-to-filesystem.meta.json +--- # org.osbuild.bootc.install-to-filesystem + **Run bootc install to-filesystem** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootc.install.config.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootc.install.config.md index 7ffa1f1ea9..b477e20045 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootc.install.config.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootc.install.config.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.bootc.install.config.meta.json +--- # org.osbuild.bootc.install.config + **Write bootc-install-config(5) file** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootiso.mono.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootiso.mono.md index 78b7aec64a..c6d6a5aed0 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootiso.mono.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootiso.mono.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.bootiso.mono.meta.json +--- # org.osbuild.bootiso.mono + **Assemble a file system tree for a bootable iso** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootupd.gen-metadata.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootupd.gen-metadata.md index d6d6595d69..647e2268d7 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootupd.gen-metadata.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootupd.gen-metadata.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.bootupd.gen-metadata.meta.json +--- # org.osbuild.bootupd.gen-metadata + **Transforms /usr/lib/ostree-boot into a bootupd-compatible update payload.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootupd.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootupd.md index 95c9edee6c..8faa9a0037 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootupd.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.bootupd.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.bootupd.meta.json +--- # org.osbuild.bootupd + **Install GRUB on both BIOS and UEFI systems, ensuring that your bootloader stays up-to-date.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.btrfs.subvol.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.btrfs.subvol.md index 8519a7aacc..9c565360a1 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.btrfs.subvol.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.btrfs.subvol.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.btrfs.subvol.meta.json +--- # org.osbuild.btrfs.subvol + **Create subvolumes on a mounted btrfs partition.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.buildstamp.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.buildstamp.md index 88d48a9e3b..87c659673c 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.buildstamp.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.buildstamp.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.buildstamp.meta.json +--- # org.osbuild.buildstamp + **Create a /.buildstamp file describing the system** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chattr.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chattr.md index 148f22b28e..c9b94fe81f 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chattr.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chattr.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.chattr.meta.json +--- # org.osbuild.chattr + **Runs `chattr` to set file/directory attributes.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chmod.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chmod.md index bdeaac9d83..00f2763442 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chmod.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chmod.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.chmod.meta.json +--- # org.osbuild.chmod + **Change file mode bits** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chown.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chown.md index b2e5e349a1..49163ec29b 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chown.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chown.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.chown.meta.json +--- # org.osbuild.chown + **Change file owner and group** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chrony.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chrony.md index 8a52883f14..225cfbee9a 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chrony.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.chrony.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.chrony.meta.json +--- # org.osbuild.chrony + **Configure chrony to set system time from the network.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.clevis.luks-bind.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.clevis.luks-bind.md index 8d667af9c1..2b115f6520 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.clevis.luks-bind.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.clevis.luks-bind.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.clevis.luks-bind.meta.json +--- # org.osbuild.clevis.luks-bind + **Bind a LUKS device using the specified policy.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cloud-init.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cloud-init.md index ef90938190..63050f3e72 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cloud-init.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cloud-init.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.cloud-init.meta.json +--- # org.osbuild.cloud-init + **Configure cloud-init** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.container-deploy.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.container-deploy.md index 406f53ddaa..4d7fd649cb 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.container-deploy.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.container-deploy.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.container-deploy.meta.json +--- # org.osbuild.container-deploy + **Deploy a container.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.containers.storage.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.containers.storage.conf.md index d60135ba1d..3f0fb16e95 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.containers.storage.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.containers.storage.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.containers.storage.conf.meta.json +--- # org.osbuild.containers.storage.conf + **Edit containers-storage.conf(5) files.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.copy.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.copy.md index 8218f17c1b..7d136a72b8 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.copy.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.copy.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.copy.meta.json +--- # org.osbuild.copy + **Copy items** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.coreos.platform.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.coreos.platform.md index 43c3116968..6cc7843e0e 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.coreos.platform.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.coreos.platform.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.coreos.platform.meta.json +--- # org.osbuild.coreos.platform + **Setup a CoreOS platform** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cpio.out.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cpio.out.md index 8ec124b9ca..4cceba62a9 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cpio.out.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cpio.out.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.cpio.out.meta.json +--- # org.osbuild.cpio.out + **Assembles the tree into a CPIO archive.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cron.script.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cron.script.md index 6a7fc9c92e..86085eb627 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cron.script.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.cron.script.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.cron.script.meta.json +--- # org.osbuild.cron.script + **Run a script at regular intervals.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.crypttab.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.crypttab.md index 1408a5acda..05b3fc8a37 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.crypttab.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.crypttab.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.crypttab.meta.json +--- # org.osbuild.crypttab + **Create /etc/crypttab entries for encrypted block devices** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.debug-shell.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.debug-shell.md index 90af8f81e0..7818b10a98 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.debug-shell.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.debug-shell.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.debug-shell.meta.json +--- # org.osbuild.debug-shell + **Set up an early root shell on a certain tty** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.discinfo.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.discinfo.md index 18153fa470..528b5950bb 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.discinfo.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.discinfo.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.discinfo.meta.json +--- # org.osbuild.discinfo + **Create a `.discinfo` file describing disk** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dmverity.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dmverity.md index 33b4ca3a0a..88eafca157 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dmverity.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dmverity.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.dmverity.meta.json +--- # org.osbuild.dmverity + **Enables dm-verity protection** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf-automatic.config.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf-automatic.config.md index 09481692e3..3d6f940406 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf-automatic.config.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf-automatic.config.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.dnf-automatic.config.meta.json +--- # org.osbuild.dnf-automatic.config + **Change DNF Automatic configuration.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf.config.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf.config.md index 7865ae198e..1e667bb5ed 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf.config.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf.config.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.dnf.config.meta.json +--- # org.osbuild.dnf.config + **Change DNF configuration.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf4.mark.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf4.mark.md index 36e5301a77..d6c539be85 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf4.mark.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dnf4.mark.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.dnf4.mark.meta.json +--- # org.osbuild.dnf4.mark + **Mark packages in the DNF state database.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dracut.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dracut.conf.md index 770d1aa8e6..61b10e36c8 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dracut.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dracut.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.dracut.conf.meta.json +--- # org.osbuild.dracut.conf + **Configure dracut.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dracut.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dracut.md index 7fa3c4b26b..8a9122a710 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dracut.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.dracut.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.dracut.meta.json +--- # org.osbuild.dracut + **Create (re-create) the initial RAM file-system** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.erofs.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.erofs.md index 479b9d2676..12f4a6e963 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.erofs.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.erofs.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.erofs.meta.json +--- # org.osbuild.erofs + **Create a file containing an erofs filesystem named `filename`.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.error.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.error.md index 43f92b22f7..3439bb8526 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.error.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.error.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.error.meta.json +--- # org.osbuild.error + **Return an error** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.experimental.ostree.config.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.experimental.ostree.config.md index cb0fd5a638..1e2e9416ab 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.experimental.ostree.config.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.experimental.ostree.config.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.experimental.ostree.config.meta.json +--- # org.osbuild.experimental.ostree.config + **Change OSTree configuration experimental options** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fdo.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fdo.md index 1f5c4a735b..acc3c067f1 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fdo.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fdo.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.fdo.meta.json +--- # org.osbuild.fdo + **FDO initial DIUN certificates** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.firewall.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.firewall.md index d050b8a714..33e5c1ba83 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.firewall.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.firewall.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.firewall.meta.json +--- # org.osbuild.firewall + **Configure firewall** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.first-boot.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.first-boot.md index c37e2043cc..5a0cfe4aa4 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.first-boot.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.first-boot.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.first-boot.meta.json +--- # org.osbuild.first-boot + **Execute commands on first-boot** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fix-bls.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fix-bls.md index 33f1aca4a9..bca58a8658 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fix-bls.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fix-bls.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.fix-bls.meta.json +--- # org.osbuild.fix-bls + **Fix paths in /boot/loader/entries** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fstab.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fstab.md index b1ab415df9..8702501a4d 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fstab.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.fstab.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.fstab.meta.json +--- # org.osbuild.fstab + **Create /etc/fstab entries for filesystems** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gcp.guest-agent.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gcp.guest-agent.conf.md index 6476311aca..fcbe2e25bb 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gcp.guest-agent.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gcp.guest-agent.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.gcp.guest-agent.conf.meta.json +--- # org.osbuild.gcp.guest-agent.conf + **Create or modify the GCP guest-agent config** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.greenboot.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.greenboot.md index 7a4debf641..83feb2fbc2 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.greenboot.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.greenboot.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.greenboot.meta.json +--- # org.osbuild.greenboot + **Configure greenboot** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.groups.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.groups.md index 0269d6cd5c..10ac927669 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.groups.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.groups.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.groups.meta.json +--- # org.osbuild.groups + **Create group accounts** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.inst.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.inst.md index 627f2f66e7..07a4130d97 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.inst.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.inst.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.grub2.inst.meta.json +--- # org.osbuild.grub2.inst + **Install the grub2 boot loader for non-UEFI systems or hybrid boot** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.iso.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.iso.md index 3fcd271040..8d16a185ae 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.iso.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.iso.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.grub2.iso.meta.json +--- # org.osbuild.grub2.iso + **Create a boot filesystem tree, can be consumed to create an efiboot.img.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.legacy.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.legacy.md index fdf3fa8678..f668d0c69d 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.legacy.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.legacy.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.grub2.legacy.meta.json +--- # org.osbuild.grub2.legacy + **Configure GRUB2 bootloader and set boot options (legacy, i.e. non-BLS)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.md index 33bd890efd..15e21aef9f 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.grub2.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.grub2.meta.json +--- # org.osbuild.grub2 + **Configure GRUB2 bootloader and set boot options** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gunzip.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gunzip.md index d681e92141..14e47308e1 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gunzip.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gunzip.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.gunzip.meta.json +--- # org.osbuild.gunzip + **Extract a gzipped file** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gzip.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gzip.md index 3eb0c59c86..c54b9e6a22 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gzip.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.gzip.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.gzip.meta.json +--- # org.osbuild.gzip + **Compress a file using gzip** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.hostname.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.hostname.md index d31f59e1c7..7e850a3be6 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.hostname.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.hostname.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.hostname.meta.json +--- # org.osbuild.hostname + **Set system hostname** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ignition.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ignition.md index d786f455fc..70abfcf95f 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ignition.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ignition.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ignition.meta.json +--- # org.osbuild.ignition + **Setup ignition so it will be triggered on first boot.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.implantisomd5.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.implantisomd5.md index fc164cdb9c..8f49ed3429 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.implantisomd5.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.implantisomd5.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.implantisomd5.meta.json +--- # org.osbuild.implantisomd5 + **Implant an MD5 checksum in an ISO9660 image** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.isolinux.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.isolinux.md index 6b08dbf28f..e39bbe34c0 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.isolinux.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.isolinux.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.isolinux.meta.json +--- # org.osbuild.isolinux + **Create an isolinux bootloader** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kernel-cmdline.bls-append.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kernel-cmdline.bls-append.md index 3e10c40a22..a6927d8ad2 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kernel-cmdline.bls-append.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kernel-cmdline.bls-append.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.kernel-cmdline.bls-append.meta.json +--- # org.osbuild.kernel-cmdline.bls-append + **Add kernel command line parameters to a BLS \[1\] config either in the tree or in a mount.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kernel-cmdline.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kernel-cmdline.md index a7393896c1..1ce00c7d22 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kernel-cmdline.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kernel-cmdline.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.kernel-cmdline.meta.json +--- # org.osbuild.kernel-cmdline + **Configure the kernel command-line parameters** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.keymap.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.keymap.md index 58b3cdfd99..7a5e313e4c 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.keymap.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.keymap.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.keymap.meta.json +--- # org.osbuild.keymap + **Set image's default keymap for vconsole and X11 keyboard.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kickstart.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kickstart.md index 79ffc21538..5574fa93d5 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kickstart.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.kickstart.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.kickstart.meta.json +--- # org.osbuild.kickstart + **Create an Anaconda kickstart file** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.livesys.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.livesys.md index c0e97246bf..31dee73a1d 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.livesys.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.livesys.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.livesys.meta.json +--- # org.osbuild.livesys + **Configure basic aspects of the `/etc/sysconfig/livesys` file, necessary for live installations.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.locale.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.locale.md index 18154a0cde..4bd88d988a 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.locale.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.locale.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.locale.meta.json +--- # org.osbuild.locale + **Set system language.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lorax-script.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lorax-script.md index b1923bb113..27e7207133 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lorax-script.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lorax-script.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.lorax-script.meta.json +--- # org.osbuild.lorax-script + **Run a lorax template script on the tree** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.luks2.format.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.luks2.format.md index 0907ab62f4..db29e922b9 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.luks2.format.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.luks2.format.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.luks2.format.meta.json +--- # org.osbuild.luks2.format + **Create an LUKS2 container via `cryptsetup`.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.luks2.remove-key.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.luks2.remove-key.md index eb9d535fed..3d371fe55f 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.luks2.remove-key.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.luks2.remove-key.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.luks2.remove-key.meta.json +--- # org.osbuild.luks2.remove-key + **Removes the supplied passphrase from the LUKS device.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lvm2.create.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lvm2.create.md index efb7fad75e..5714d995dd 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lvm2.create.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lvm2.create.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.lvm2.create.meta.json +--- # org.osbuild.lvm2.create + **Create LVM2 physical volumes, volume groups and logical volumes** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lvm2.metadata.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lvm2.metadata.md index 1df2b81b15..61a4e88429 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lvm2.metadata.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.lvm2.metadata.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.lvm2.metadata.meta.json +--- # org.osbuild.lvm2.metadata + **Set LVM2 volume group metadata** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.machine-id.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.machine-id.md index bc552eb6db..15f44aa05d 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.machine-id.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.machine-id.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.machine-id.meta.json +--- # org.osbuild.machine-id + **Deal with /etc/machine-id** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkdir.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkdir.md index 2be0825375..7c2262fb6b 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkdir.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkdir.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.mkdir.meta.json +--- # org.osbuild.mkdir + **Create directories within the tree.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.btrfs.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.btrfs.md index de15d24939..900ab0a755 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.btrfs.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.btrfs.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.mkfs.btrfs.meta.json +--- # org.osbuild.mkfs.btrfs + **Construct an btrfs file-system via mkfs.btrfs(8)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.ext4.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.ext4.md index f62d5fdb87..40ab94f461 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.ext4.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.ext4.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.mkfs.ext4.meta.json +--- # org.osbuild.mkfs.ext4 + **Construct an ext4 file-system via mkfs.ext4(8)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.fat.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.fat.md index 58c3330068..8b73deb6e6 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.fat.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.fat.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.mkfs.fat.meta.json +--- # org.osbuild.mkfs.fat + **Construct an FAT file-system via mkfs.fat(8)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.xfs.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.xfs.md index 52c5aa56fd..acc730923c 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.xfs.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkfs.xfs.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.mkfs.xfs.meta.json +--- # org.osbuild.mkfs.xfs + **Construct an XFS file-system via mkfs.xfs(8)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkinitcpio.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkinitcpio.md index 6ac2a0f88d..a6fa615024 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkinitcpio.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.mkinitcpio.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.mkinitcpio.meta.json +--- # org.osbuild.mkinitcpio + **Run mkinitcpio for Arch based distributions** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.modprobe.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.modprobe.md index 6653e71e63..574a45c746 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.modprobe.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.modprobe.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.modprobe.meta.json +--- # org.osbuild.modprobe + **Configure modprobe** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nginx.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nginx.conf.md index 466a6cfdb5..590fa826bd 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nginx.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nginx.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.nginx.conf.meta.json +--- # org.osbuild.nginx.conf + **Write nginx configuration** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nm.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nm.conf.md index aa9660ba8b..023b1abddc 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nm.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nm.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.nm.conf.meta.json +--- # org.osbuild.nm.conf + **Create NetworkManager configuration files.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nm.conn.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nm.conn.md index 875d4da039..076cbe91a1 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nm.conn.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.nm.conn.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.nm.conn.meta.json +--- # org.osbuild.nm.conn + **Configure Network Manager Connections** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.noop.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.noop.md index 91d9f3e7c9..6dc437cb4a 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.noop.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.noop.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.noop.meta.json +--- # org.osbuild.noop + **Do Nothing** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oci-archive.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oci-archive.md index 87daf983ec..e11fe3b400 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oci-archive.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oci-archive.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.oci-archive.meta.json +--- # org.osbuild.oci-archive + **Assemble an OCI image archive** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oscap.autotailor.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oscap.autotailor.md index 2acb3dfc6a..2cc79cc260 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oscap.autotailor.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oscap.autotailor.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.oscap.autotailor.meta.json +--- # org.osbuild.oscap.autotailor + **Execute oscap autotailor** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oscap.remediation.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oscap.remediation.md index 6a54c5dce4..a693a8570a 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oscap.remediation.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.oscap.remediation.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.oscap.remediation.meta.json +--- # org.osbuild.oscap.remediation + **Execute oscap remediation** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.aleph.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.aleph.md index e96991ae4a..982cbeb419 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.aleph.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.aleph.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.aleph.meta.json +--- # org.osbuild.ostree.aleph + **Create aleph version file for the deployment.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.commit.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.commit.md index 9a734d3fc3..abed44ff5c 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.commit.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.commit.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.commit.meta.json +--- # org.osbuild.ostree.commit + **Assemble a file system tree into a ostree commit** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.config.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.config.md index b131ae15bb..10246ff87c 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.config.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.config.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.config.meta.json +--- # org.osbuild.ostree.config + **Change OSTree configuration** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.deploy.container.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.deploy.container.md index 7a897556ec..a14600bd05 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.deploy.container.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.deploy.container.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.deploy.container.meta.json +--- # org.osbuild.ostree.deploy.container + **Deploy an OStree commit** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.deploy.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.deploy.md index bb0c818ecd..1820d91736 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.deploy.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.deploy.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.deploy.meta.json +--- # org.osbuild.ostree.deploy + **Deploy an OStree commit** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.encapsulate.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.encapsulate.md index 29eb0d27d2..47779d9918 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.encapsulate.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.encapsulate.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.encapsulate.meta.json +--- # org.osbuild.ostree.encapsulate + **Wrap OSTree commits into a oci container image** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.fillvar.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.fillvar.md index e1e13d06d1..86427e28ec 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.fillvar.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.fillvar.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.fillvar.meta.json +--- # org.osbuild.ostree.fillvar + **Pre-populate /var directory for a given stateroot.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.genkey.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.genkey.md index de123bc51a..9cb7c6254f 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.genkey.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.genkey.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.genkey.meta.json +--- # org.osbuild.ostree.genkey + **Generate ed25519 public/private keypair in format used by `ostree sign`.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.init-fs.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.init-fs.md index 84e51ea383..b36bce07f6 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.init-fs.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.init-fs.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.init-fs.meta.json +--- # org.osbuild.ostree.init-fs + **Initialize a new root file system** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.init.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.init.md index 0e4a3a1973..44af0697d5 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.init.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.init.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.init.meta.json +--- # org.osbuild.ostree.init + **Create an ostree repository** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.md index a47a629a97..06a1160422 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.meta.json +--- # org.osbuild.ostree + **WARNING: This stage is deprecated and shouldn't be used when defining new pipelines. Please use the individual ostree.* stages instead.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.os-init.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.os-init.md index d2102cc357..205f6b94cc 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.os-init.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.os-init.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.os-init.meta.json +--- # org.osbuild.ostree.os-init + **Initialize a new stateroot for a new OS** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.passwd.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.passwd.md index 29e5ce48c3..8e6b5be9d6 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.passwd.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.passwd.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.passwd.meta.json +--- # org.osbuild.ostree.passwd + **Populate buildroot with /etc/passwd and /etc/group from an OSTree checkout** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.post-copy.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.post-copy.md index e6b597f52a..8d174e504a 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.post-copy.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.post-copy.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.post-copy.meta.json +--- # org.osbuild.ostree.post-copy + **Apply post-copy updates to an ostree repo/deployment** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.preptree.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.preptree.md index 1c51a130d7..5687ec02ec 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.preptree.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.preptree.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.preptree.meta.json +--- # org.osbuild.ostree.preptree + **Transforms the tree to an ostree layout** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.pull.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.pull.md index dfe771661c..ab520fa0ff 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.pull.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.pull.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.pull.meta.json +--- # org.osbuild.ostree.pull + **Pull OSTree commits into an existing repo** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.remotes.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.remotes.md index b901d18976..df7cfc5dbf 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.remotes.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.remotes.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.remotes.meta.json +--- # org.osbuild.ostree.remotes + **Configure OSTree remotes for a repository.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.selinux.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.selinux.md index bf4b6ec1c1..79174ae05b 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.selinux.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.selinux.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.selinux.meta.json +--- # org.osbuild.ostree.selinux + **Fix SELinux labels for an OSTree deployment\[1\].** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.sign.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.sign.md index e482eab32e..f9d86bae7f 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.sign.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ostree.sign.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ostree.sign.meta.json +--- # org.osbuild.ostree.sign + **Sign a commit in an ostree repo** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ovf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ovf.md index 45da1f2c41..9be37e612a 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ovf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.ovf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.ovf.meta.json +--- # org.osbuild.ovf + **Create OVF descriptor and manifest** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman-keyring.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman-keyring.md index 43414aaa31..5da13da5b5 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman-keyring.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman-keyring.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.pacman-keyring.meta.json +--- # org.osbuild.pacman-keyring + **Initialize the Arch Linux keyring for Arch based distributions** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.conf.md index fbb10d08d8..c278c1bb98 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.pacman.conf.meta.json +--- # org.osbuild.pacman.conf + **Configure pacman** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.md index 2c11d5d59c..c59ea127b2 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.pacman.meta.json +--- # org.osbuild.pacman + **Verify, and install pacman packages** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.mirrorlist.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.mirrorlist.conf.md index 865a8d87e2..516b4726e5 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.mirrorlist.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pacman.mirrorlist.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.pacman.mirrorlist.conf.meta.json +--- # org.osbuild.pacman.mirrorlist.conf + **Configure pacman's mirrorlist** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pam.limits.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pam.limits.conf.md index 34e1bde1cf..96ec2d3d31 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pam.limits.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pam.limits.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.pam.limits.conf.meta.json +--- # org.osbuild.pam.limits.conf + **Create pam_limits module configuration.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.parted.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.parted.md index 4830c9afc7..cb406f829e 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.parted.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.parted.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.parted.meta.json +--- # org.osbuild.parted + **Partition a target using parted(8)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pwquality.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pwquality.conf.md index dcce626f5f..f16049a33a 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pwquality.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.pwquality.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.pwquality.conf.meta.json +--- # org.osbuild.pwquality.conf + **Configure libpwquality.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.qemu.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.qemu.md index 5b20600633..71e0dbbb16 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.qemu.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.qemu.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.qemu.meta.json +--- # org.osbuild.qemu + **Convert a disk image to a different format.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.resolv-conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.resolv-conf.md index 55c86626fe..b0350544eb 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.resolv-conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.resolv-conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.resolv-conf.meta.json +--- # org.osbuild.resolv-conf + **Configure the resolver** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rhsm.facts.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rhsm.facts.md index 8d2cc7d0d9..52a7bf5a90 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rhsm.facts.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rhsm.facts.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.rhsm.facts.meta.json +--- # org.osbuild.rhsm.facts + **This stage allows storing artifact-properties of the Red Hat Subscription Manager (rhsm-facts) in the built image.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rhsm.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rhsm.md index 131222fcb1..cc871b2c2b 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rhsm.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rhsm.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.rhsm.meta.json +--- # org.osbuild.rhsm + **Configure Red Hat Subscription Management (RHSM)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm-ostree.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm-ostree.md index b21ebf5897..3ac234c319 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm-ostree.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm-ostree.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.rpm-ostree.meta.json +--- # org.osbuild.rpm-ostree + **Transforms the tree to an ostree layout** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm.macros.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm.macros.md index f57bf5211d..4b0e5d763f 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm.macros.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm.macros.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.rpm.macros.meta.json +--- # org.osbuild.rpm.macros + **Persistently set RPM macros** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm.md index e352473666..d412e87562 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpm.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.rpm.meta.json +--- # org.osbuild.rpm + **Verify, and install RPM packages** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpmkeys.import.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpmkeys.import.md index f842abb05b..be75ebba56 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpmkeys.import.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.rpmkeys.import.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.rpmkeys.import.meta.json +--- # org.osbuild.rpmkeys.import + **Import public keys into the RPM database** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.selinux.config.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.selinux.config.md index e9a0cde020..adffb7eb37 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.selinux.config.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.selinux.config.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.selinux.config.meta.json +--- # org.osbuild.selinux.config + **Configure the SELinux state on the system.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.selinux.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.selinux.md index ab78cf8add..a09efc3536 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.selinux.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.selinux.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.selinux.meta.json +--- # org.osbuild.selinux + **Set SELinux file contexts** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sfdisk.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sfdisk.md index 28e8029286..71805900f4 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sfdisk.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sfdisk.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.sfdisk.meta.json +--- # org.osbuild.sfdisk + **Partition a target using sfdisk(8)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sgdisk.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sgdisk.md index c963b00c15..8128a1e095 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sgdisk.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sgdisk.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.sgdisk.meta.json +--- # org.osbuild.sgdisk + **Partition a target using sgdisk(8)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.shell.init.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.shell.init.md index 73e0e3ce16..9bb6d8955b 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.shell.init.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.shell.init.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.shell.init.meta.json +--- # org.osbuild.shell.init + **Write systemwide initialization files, executed for login shells.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.skopeo.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.skopeo.md index e127efbb92..8371ff2a46 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.skopeo.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.skopeo.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.skopeo.meta.json +--- # org.osbuild.skopeo + **Copy a container image. The destination can be either a container store, or a directory compliant with 'Open Container Image Layout Specification'. diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.squashfs.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.squashfs.md index d4d823ca44..d8040f86e9 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.squashfs.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.squashfs.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.squashfs.meta.json +--- # org.osbuild.squashfs + **Create a squashfs named `filename`.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sshd.config.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sshd.config.md index e7faed5a99..298eaa79de 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sshd.config.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sshd.config.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.sshd.config.meta.json +--- # org.osbuild.sshd.config + **Configure the SSH daemon.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sysconfig.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sysconfig.md index 2056b8993d..6db4d4c25f 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sysconfig.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sysconfig.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.sysconfig.meta.json +--- # org.osbuild.sysconfig + **Configure sysconfig files** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sysctld.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sysctld.md index b6266ef110..26c4c85de2 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sysctld.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.sysctld.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.sysctld.meta.json +--- # org.osbuild.sysctld + **Configure kernel parameters at boot via sysctl.d.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd-journald.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd-journald.md index 751686ab66..9d21cb64f3 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd-journald.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd-journald.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.systemd-journald.meta.json +--- # org.osbuild.systemd-journald + **Configures systemd-journald** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd-logind.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd-logind.md index cf4de96575..bb168d0e59 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd-logind.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd-logind.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.systemd-logind.meta.json +--- # org.osbuild.systemd-logind + **Configure systemd-logind** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.md index 9cedb9a2fb..7cd4114273 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.systemd.meta.json +--- # org.osbuild.systemd + **Configure Systemd services.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.preset.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.preset.md index d327392fff..2e31510fb1 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.preset.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.preset.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.systemd.preset.meta.json +--- # org.osbuild.systemd.preset + **Configure Systemd services through presets.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.unit.create.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.unit.create.md index be04e9ff51..4f2da7df4a 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.unit.create.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.unit.create.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.systemd.unit.create.meta.json +--- # org.osbuild.systemd.unit.create + **Create a Systemd unit file** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.unit.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.unit.md index b17ac545ea..eebbcf316d 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.unit.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.systemd.unit.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.systemd.unit.meta.json +--- # org.osbuild.systemd.unit + **Configure Systemd services via unit file dropins** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tar.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tar.md index 780f29fd77..2c316b81e3 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tar.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tar.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.tar.meta.json +--- # org.osbuild.tar + **Assembles the tree into a tar archive named `filename`.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.test.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.test.md index 2e350a7995..e6bf1d1d3a 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.test.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.test.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.test.meta.json +--- # org.osbuild.test + **Enable osbuild Boot Test service** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.timezone.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.timezone.md index c4390c59dc..b978d6549e 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.timezone.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.timezone.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.timezone.meta.json +--- # org.osbuild.timezone + **Set system timezone** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tmpfilesd.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tmpfilesd.md index abe86e1484..7258585ddc 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tmpfilesd.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tmpfilesd.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.tmpfilesd.meta.json +--- # org.osbuild.tmpfilesd + **Create tmpfiles.d configuration.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.truncate.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.truncate.md index 68e57aed05..03dc8d7b78 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.truncate.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.truncate.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.truncate.meta.json +--- # org.osbuild.truncate + **Create, shrink or extend a file.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tuned.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tuned.md index 1a5548fff5..3029fe8a91 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tuned.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.tuned.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.tuned.meta.json +--- # org.osbuild.tuned + **Sets active TuneD profile.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.udev.rules.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.udev.rules.md index aaf7d07963..970263ba06 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.udev.rules.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.udev.rules.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.udev.rules.meta.json +--- # org.osbuild.udev.rules + **Create a udev rules file** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.uki.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.uki.md index be6a72d378..c41d690187 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.uki.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.uki.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.uki.meta.json +--- # org.osbuild.uki + **Create a Unified Kernel Image** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.untar.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.untar.md index 1e62640cb0..454c78fca4 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.untar.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.untar.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.untar.meta.json +--- # org.osbuild.untar + **Extract a tarball** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.update-crypto-policies.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.update-crypto-policies.md index f076b625fd..2164d967b7 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.update-crypto-policies.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.update-crypto-policies.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.update-crypto-policies.meta.json +--- # org.osbuild.update-crypto-policies + **Sets the policy applicable for the various cryptographic back-ends, such as SSL/TLS libraries.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.users.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.users.md index 54f1dde9d9..dbf79c9ad1 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.users.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.users.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.users.meta.json +--- # org.osbuild.users + **Add or modify user accounts** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.vagrant.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.vagrant.md index b1ca2dce35..be0b2e0b08 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.vagrant.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.vagrant.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.vagrant.meta.json +--- # org.osbuild.vagrant + **Create a Vagrant box** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.waagent.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.waagent.conf.md index f9c7a84b0f..52956c08bc 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.waagent.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.waagent.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.waagent.conf.meta.json +--- # org.osbuild.waagent.conf + **Configure the WALinuxAgent.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.wsl.conf.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.wsl.conf.md index 65f23dcfc2..1478f6c2ed 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.wsl.conf.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.wsl.conf.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.wsl.conf.meta.json +--- # org.osbuild.wsl.conf + **Configure advanced settings in Windows Subsystem for Linux.** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.xorrisofs.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.xorrisofs.md index 981d3ec014..1a324669a8 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.xorrisofs.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.xorrisofs.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.xorrisofs.meta.json +--- # org.osbuild.xorrisofs + **Assemble a Rock Ridge enhanced ISO 9660 filesystem (iso)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.xz.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.xz.md index b545a5443a..73802c79b8 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.xz.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.xz.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.xz.meta.json +--- # org.osbuild.xz + **Compress a file** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.yum.config.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.yum.config.md index 198ee45cfc..8d23049cbc 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.yum.config.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.yum.config.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.yum.config.meta.json +--- # org.osbuild.yum.config + **Configure yellowdog updater modified (YUM)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.yum.repos.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.yum.repos.md index 323c0cff89..f9eb68b970 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.yum.repos.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.yum.repos.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.yum.repos.meta.json +--- # org.osbuild.yum.repos + **Create YUM / DNF repo file in /etc/yum.repos.d** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zip.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zip.md index 64b7ef4a4e..d8721afff0 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zip.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zip.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.zip.meta.json +--- # org.osbuild.zip + **Assembles the tree into a zip archive named `filename`** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zipl.inst.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zipl.inst.md index b2a6e6414c..0fc176e838 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zipl.inst.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zipl.inst.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.zipl.inst.meta.json +--- # org.osbuild.zipl.inst + **Install the Z Initial Program Loader (zipl)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zipl.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zipl.md index 6927622ca6..1d4b33a2a4 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zipl.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zipl.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.zipl.meta.json +--- # org.osbuild.zipl + **Configure the z Initial Program Loader (zipl)** diff --git a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zstd.md b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zstd.md index 65a37a0fb7..5efaa517a5 100644 --- a/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zstd.md +++ b/docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.zstd.md @@ -1,5 +1,12 @@ - +--- +custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.zstd.meta.json +--- # org.osbuild.zstd + **Compress a file** diff --git a/docs/developer-guide/02-projects/rpmrepo/index.md b/docs/developer-guide/02-projects/rpmrepo/index.md index e5ae889cc5..edeb4e5263 100644 --- a/docs/developer-guide/02-projects/rpmrepo/index.md +++ b/docs/developer-guide/02-projects/rpmrepo/index.md @@ -1,3 +1,6 @@ +--- +custom_edit_url: https://github.com/osbuild/rpmrepo/blob/main/README.md +--- RPMrepo Snapshots ================= @@ -233,3 +236,4 @@ Which will return a JSON list of the snapshots names. - **Apache-2.0** - See LICENSE file for details. +