Renames and readmes

* Add readme for cloud templates
* Modify readme for repo in general
* Change Rocky-X-OCP to be a base variant
This commit is contained in:
Louis Abel 2023-04-12 23:50:51 -07:00
parent e9be780fe4
commit d65003266c
Signed by untrusted user: label
GPG Key ID: B37E62D143879B36
4 changed files with 69 additions and 0 deletions

View File

@ -4,6 +4,26 @@ This branch has Rocky Linux 8 specific kickstarts. These kickstarts vary
between cloud images and live images provided in our repositories and
mirrors.
## Structure
In the root of the repository are the general kickstarts in use that any
user can pick up, use, or modify to their liking to make their own Rocky
Linux live images, cloud images, and so on. These kickstarts are generated
by templates that live in the various directories in this repository.
* `cloud` -> Cloud image templates
* `live` -> Live image templates
* `container` -> Container image templates
These kickstarts are generated using `ksflatten`. Changes made to the
kickstarts generally match between the templates and the full kickstarts
in the root.
For SIG/Core's usage, we use the `live` area as a "working" directory,
where we use the split parts in our automation for the images and the
pre-flattened versions are there for the convenience of all users. This
is easier than using the pre-made ones in empanadas.
## Building Live Images
To build live images, you will need to use `livecd-creator` or

49
cloud/README.md Normal file
View File

@ -0,0 +1,49 @@
# Cloud Templates
This directory contains templated versions of the cloud images. This is
extremely useful for us to be able to create more variants or modify
all variants at once if need be.
The general guidelines/ideas work like this:
* Start with a basic name, such as `rocky-${provider}-${variant}.ks`
* Optionally create additional kickstarts, such as an additional packages file
* Include the very base as necessary:
* rocky-cloud-base.ks
* rocky-cloud-parts-base.ks or rocky-cloud-parts-lvm.ks
* Include other customizations from another kickstart as necessary, such as an additional packages kickstart
* bootloader configuration and then final %post ... %end section
The most basic example of our most basic generic cloud image goes like this. See comments for details.
```
# rocky-genclo-base.ks
# Imports the absolute base for the cloud images. This is general setup settings.
%include rocky-cloud-base.ks
# Imports partition scheme and creation for the image. This is non-LVM.
%include rocky-cloud-parts-base.ks
# Imports base packages that all cloud images are expected to have
%include rocky-cloud-base-packages.ks
# bootloader information, each cloud will have different settings, so better we put it here.
bootloader --append="console=ttyS0,115200n8 no_timer_check crashkernel=auto net.ifnames=0" --location=mbr --timeout=1
# Anything else can go here that isn't fulfilled by custom or base templates.
# This can be repos if needed.
# the final post section is done here (we've removed all of it for the sake of the example)
%post --erroronfail
. . .
%end
```
At the end, you would run run ksflatten, and you now have a customized kickstart.
```
ksflatten -c rocky-genclo-base.ks -o Rocky-X-GenericCloud-Base.ks
```