diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 2876c844..f946eec5 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -10,6 +10,7 @@ * [#319](https://github.com/suse-edge/edge-image-builder/issues/319) - Combustion fails when combustion directory content is larger than half of the RAM of the system * [#233](https://github.com/suse-edge/edge-image-builder/issues/233) - Use different Helm chart sources for development and production builds +* [#95](https://github.com/suse-edge/edge-image-builder/issues/95) - Compressed images are not supported --- diff --git a/docs/building-images.md b/docs/building-images.md index e374d54f..3cbb5552 100644 --- a/docs/building-images.md +++ b/docs/building-images.md @@ -24,8 +24,8 @@ image: * `apiVersion` - Indicates the version of the definition file schema for EIB to expect * `imageType` - Must be either `iso` or `raw`. * `arch` - Must be either `x86_64` or `aarch64`. -* `baseImage` - Indicates the name of the image file used as the base for the built image. This file must be located - under the `images` directory of the image configuration directory (see below for more information). This image will +* `baseImage` - Indicates the name of the image file used as the base for the built image. Base image files must be uncompressed. This file must be located + under the `base-images` directory of the image configuration directory (see below for more information). This image will **not** directly be modified by EIB; a new image will be created each time EIB is run. * `outputImageName` - Indicates the name of the image that EIB will build. This may only be a filename; the image will be written to the root of the image configuration directory.