Skip to content

Commit

Permalink
Update READMEs to be more readme like
Browse files Browse the repository at this point in the history
Co-authored-by: Dmitri Popov <[email protected]>
  • Loading branch information
dirkmueller and dmpop committed Mar 22, 2024
1 parent 98d864c commit cdd2e12
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 23 deletions.
10 changes: 2 additions & 8 deletions src/bci_build/package/busybox/README.md.j2
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# SLE BCI-BusyBox: When you need the smallest and GPLv3-free image
# SLE BCI-BusyBox: the smallest and GPLv3-free image

Similar to SLE BCI-Micro, the SLE BCI-BusyBox image comes with the most
basic tools only. However, these tools are provided by the BusyBox
project. This has the benefit of further size reduction. Furthermore,
the image contains no GPLv3 licensed software. When using the image,
keep in mind that there are certain differences between the BusyBox
tools and the GNU Coreutils. So scripts written for a system that
uses GNU Coreutils may require modification to work with BusyBox.
The SLE BCI-BusyBox image comes with the most basic tools provided by the BusyBox project. The image contains no GPLv3 licensed software. When using the image, keep in mind that there are differences between the BusyBox tools and the GNU Coreutils. This means that scripts written for a system that uses GNU Coreutils may require modification to work with BusyBox.

## License
SPDX-License-Identifier: {{ image.license }}
2 changes: 1 addition & 1 deletion src/bci_build/package/micro/README.md.j2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SLE BCI-Micro: When you need to deploy static binaries
# SLE BCI-Micro: Suitable for deploying static binaries

This image is similar to SLE BCI-Minimal but without the RPM package manager.
The primary use case for the image is deploying static binaries produced
Expand Down
13 changes: 2 additions & 11 deletions src/bci_build/package/minimal/README.md.j2
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
# SLE BCI-Minimal: When you do not need Zypper
# SLE BCI-Minimal: Container image without Zypper

This is a stripped-down version of the SLE BCI-Base image. SLE BCI-Minimal
comes without Zypper, but it does have the RPM package manager installed.
This significantly reduces the size of the image. However, while RPM can
install and remove packages, it lacks support for repositories and
automated dependency resolution. The SLE BCI-Minimal image is therefore
intended for creating deployment containers, and then installing the
desired RPM packages inside the containers. Although you can install
the required dependencies, you need to download and resolve them
manually. However, this approach is not recommended as it is
prone to errors.
SLE BCI-Minimal comes without Zypper, but it does have the RPM package manager installed. While RPM can install and remove packages, it lacks support for repositories and automated dependency resolution. The SLE BCI-Minimal image is therefore intended for creating deployment containers, and then installing the desired RPM packages inside the containers. While you can install the required dependencies, you need to download and resolve them manually. However, this approach is not recommended as it is prone to errors.

## License
SPDX-License-Identifier: {{ image.license }}
5 changes: 2 additions & 3 deletions src/bci_build/package/registry/README.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ http:
addr: 0.0.0.0:5000
```

You can also create an empty directory to persistently store the images outside the container:
You can also create an empty directory for storing the images outside the container:

```bash
mkdir -p /var/lib/docker-registry
Expand All @@ -28,8 +28,7 @@ podman run -d --restart=always -p 5000:5000 -v /path/to/config.yml:/etc/docker/r
-v /var/lib/docker-registry:/var/lib/docker-registry --name registry {{ image.reference }}
```

The registry will be available at `http://localhost:5000`. To keep the registry running after a reboot,
you can create a systemd service:
The registry is available at `http://localhost:5000`. To keep the registry running after a reboot, create a systemd service as follows:

```bash
sudo podman generate systemd registry > /etc/systemd/system/registry.service
Expand Down

0 comments on commit cdd2e12

Please sign in to comment.