fedora-kiwi-descriptions/README.md

# fedora-kiwi-descriptions

This project is used to manage the Fedora KIWI image descriptions used in composing Fedora release images.

The `rawhide` branch is used for Fedora Rawhide images and each release branch is used by that release.

All changes should be made via the PR workflow.

## Image variants

* Base Cloud Edition for clouds (image type: `oem`, image profiles: `Cloud-Base-Generic`/`Cloud-Base-AmazonEC2`/`Cloud-Base-Azure`/`Cloud-Base-GCE`)
* Base Cloud Edition for Vagrant (image type: `oem`, image profiles: `Cloud-Base-Vagrant-libvirt`/`Cloud-Base-Vagrant-VirtualBox`)
* Base Container (image type: `tbz`, image profiles `Container-Base-Generic-Minimal`/`Container-Base-Generic`)
* Toolbox Container (image type: `tbz`, image profiles `Container-Toolbox`)
* KDE Spin (image type: `iso`, image profiles: `KDE-Live`)
* Workstation Edition (image type: `iso`, image profiles: `Workstation-Live`)

## Image build quickstart

Set up your development environment and run the image build (substitute `<image_type>` and `<image_profile>` for the appropriate settings):

```bash
# Install kiwi
[]$ sudo dnf --assumeyes install kiwi
# Run the image build
[]$ sudo ./kiwi-build --image-type=<image_type> --image-profile=<image_profile> --output-dir ./outdir
```

## CI information

This project is tested using the [Software Factory Zuul CI instance](https://fedora.softwarefactory-project.io/zuul/project/pagure.io/fedora-kiwi-descriptions)
using the [Test Management Tool](https://tmt.readthedocs.io/).

## Licensing

This is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, under version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Initial commit 2021-09-10 20:51:18 +00:00			`# fedora-kiwi-descriptions`

			`This project is used to manage the Fedora KIWI image descriptions used in composing Fedora release images.`

			The `rawhide` branch is used for Fedora Rawhide images and each release branch is used by that release.

			`All changes should be made via the PR workflow.`

Initial import of descriptions 2023-10-14 19:21:23 +00:00			`## Image variants`

platforms, tmt: Rename and restructure cloud variants We now have more than one cloud system that is essentially a KVM environment that uses cloud-init to boot, so now we declare that "generic" and have the OpenStack and Oracle images reuse those definitions. Also, in preparation for layered cloud image variants, rename them from "Cloud-" to "Cloud-Base-". Vagrant variants are similarly prefixed to make it clear who provides them. Finally, restructure the layout of the tmt plans to match the description structure. 2023-12-21 14:04:37 +00:00			* Base Cloud Edition for clouds (image type: `oem`, image profiles: `Cloud-Base-Generic`/`Cloud-Base-AmazonEC2`/`Cloud-Base-Azure`/`Cloud-Base-GCE`)
			* Base Cloud Edition for Vagrant (image type: `oem`, image profiles: `Cloud-Base-Vagrant-libvirt`/`Cloud-Base-Vagrant-VirtualBox`)
Add base container definitions This adds the definitions for building the container tarballs for the base container, the minimal base container, and the toolbox container. 2024-01-08 03:16:11 +00:00			* Base Container (image type: `tbz`, image profiles `Container-Base-Generic-Minimal`/`Container-Base-Generic`)
			* Toolbox Container (image type: `tbz`, image profiles `Container-Toolbox`)
Initial import of descriptions 2023-10-14 19:21:23 +00:00			* KDE Spin (image type: `iso`, image profiles: `KDE-Live`)
README: Enumerate all available image variants in alphabetical order 2023-10-14 19:30:02 +00:00			* Workstation Edition (image type: `iso`, image profiles: `Workstation-Live`)
Initial import of descriptions 2023-10-14 19:21:23 +00:00
			`## Image build quickstart`

			Set up your development environment and run the image build (substitute `<image_type>` and `<image_profile>` for the appropriate settings):

			```bash
			`# Install kiwi`
			`[]$ sudo dnf --assumeyes install kiwi`
			`# Run the image build`
			`[]$ sudo ./kiwi-build --image-type=<image_type> --image-profile=<image_profile> --output-dir ./outdir`
			```

Add Zuul CI configuration This allows us to have pull requests tested before we review changes to merge. 2023-12-20 12:55:40 +00:00			`## CI information`

README: Add link to Zuul instance in CI section 2023-12-20 13:41:58 +00:00			`This project is tested using the [Software Factory Zuul CI instance](https://fedora.softwarefactory-project.io/zuul/project/pagure.io/fedora-kiwi-descriptions)`
Add Zuul CI configuration This allows us to have pull requests tested before we review changes to merge. 2023-12-20 12:55:40 +00:00			`using the [Test Management Tool](https://tmt.readthedocs.io/).`

Initial commit 2021-09-10 20:51:18 +00:00			`## Licensing`

			`This is free software: you can redistribute it and/or modify`
			`it under the terms of the GNU General Public License as published by`
			`the Free Software Foundation, under version 3 of the License, or`
			`(at your option) any later version.`

			`This program is distributed in the hope that it will be useful,`
			`but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`
			`GNU General Public License for more details.`

			`You should have received a copy of the GNU General Public License`
			`along with this program. If not, see <http://www.gnu.org/licenses/>.`