1
0
mirror of https://github.com/AlmaLinux/ks2rootfs.git synced 2024-11-14 15:04:22 +00:00

Update documentation

Signed-off-by: Bala Raman <srbala@gmail.com>
This commit is contained in:
Bala Raman 2021-09-11 14:40:46 -04:00
parent 1a52d520ea
commit bdcdb75de5
No known key found for this signature in database
GPG Key ID: 23A07BF21B5D6625

View File

@ -2,19 +2,36 @@
This project provides the ability build `rootfs` file from `kickstart` input file in a docker/podman container environment. Output rootfs files can be used create base images for different OSs (AlmaLinux, Cent OS, Rocky Linux) etc.
## HOW-TO
## Building local
Image yet ot published in `hub.docker.com`, until then use local build.
Two different variants of the image `almalinux/ks2rootfs` are avilable.
### Building local
* [**`latest`**](https://hub.docker.com/r/almalinux/ks2rootfs/tags?page=1&ordering=last_updated&name=latest)
* [**`livecd-tools`**](https://hub.docker.com/r/almalinux/ks2rootfs/tags?page=1&ordering=last_updated&name=livecd-tools)
### Building `almalinux/ks2rootfs:latest` image tag
Use follwing command `latest` tag image to create `rootfs` files for `docker` and `WSL` images.
```sh
docker build -t almalinux/ks2rootfs .
docker build -t almalinux/ks2rootfs -f Dockerfile .
```
### Using Image
### Building `almalinux/ks2rootfs:livecd-tools` image tag
Following command under `tests` folder. Run command uses the `kickstarts/almalinux-8-default.x86_64.ks` file to build.
Use follwing command `livecd-tools` tag image to create `SIG/LiveMedia ISO` images, check GitHub [repo](https://github.com/AlmaLinux/sig-livemedia).
```sh
docker build -t almalinux/ks2rootfs:livecd-tools -f Dockerfile.livecd .
```
## Using `almalinux/ks2rootfs:latest` image tag
Use `latest` tag image to create `rootfs` files for `docker` and `WSL` images.
### Using `lastet` Image tag
Run following command under `tests` folder. Test script kickstart files are available at `kickstarts`. **NOTE**: These scripts test use only. Official docker image kickstart files are avaialble in GitHub [docker-images](https://github.com/AlmaLinux/docker-images) repository.
Use command below to create `default` docker files
@ -68,10 +85,13 @@ FLAG_RETAIN_LOG : Optional - When enabled, generated logs files retained unde
BUILD_COMPTYPE : Optional - Build compression type default 'xz', 'gzip' and 'lzma'.
BUILD_TYPE : Optional - Build type 'base', 'default', 'init', 'micro', 'minimal' and 'wsl', Default value is 'default'.
USAGE:
ks2rootfs KICKSTART_FILE_NAME ROOTFS_FILE_NAME
EXAMPLES:
ks2rootfs os-minimal.ks os-minimal.tar.xz
ks2rootfs os-minimal.ks os-minimal.tar.gz
```
## Using `almalinux/ks2rootfs:livecd-tools` Image
`livecd-tools` tag image to create `SIG/LiveMedia ISO` images, check GitHub [repo](https://github.com/AlmaLinux/sig-livemedia) for more detailed use.