Skip to content

Commit 3fcb9f0

Browse files
committed
doc: add notes about ubi builds
Signed-off-by: Tuomas Katila <tuomas.katila@intel.com>
1 parent f5c6e0f commit 3fcb9f0

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

DEVEL.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Table of Contents
1414
* [How to Develop Simple Device Plugins](#how-to-develop-simple-device-plugins)
1515
* [Logging](#logging)
1616
* [Error Conventions](#error-conventions)
17+
* [UBI images](#ubi-images)
1718
* [Checklist for New Device Plugins](#checklist-for-new-device-plugins)
1819

1920
## Day-to-day Development How to's
@@ -253,12 +254,12 @@ go test -v ./test/e2e/... -args -ginkgo.focus "Device:(dlb|dsa|iaa|qat|sgx)"
253254
It is possible to run predefined e2e tests with:
254255
```
255256
make e2e-<device> [E2E_LEVEL={basic|full}] [FOCUS=<labels in regex>] [SKIP=<labels in regex>]
256-
```
257+
```
257258

258259
| `E2E_LEVEL` | Equivalent `FOCUS` or `SKIP` | Explanation |
259260
:-------------- |:---------------------------- |:------------------------------------------------------------------------------------------------ |
260261
| `basic` | `FOCUS=App:noapp` | `basic` does not run any app pod, but checks if the plugin works and the resources are available |
261-
| `full` | `SKIP=App:noapp` | `full` checks all resources, runs all apps except the spec kept for no app running |
262+
| `full` | `SKIP=App:noapp` | `full` checks all resources, runs all apps except the spec kept for no app running |
262263

263264
### Examples
264265

@@ -426,6 +427,36 @@ Otherwise, they can be logged as simple values:
426427
klog.Warningf("Example of a warning due to an external error: %v", err)
427428
```
428429

430+
## UBI images
431+
432+
UBI based images use different base image.
433+
434+
|Default|UBI|
435+
|---|---|
436+
|gcr.io/distroless/static|registry.access.redhat.com/ubi9-micro:latest|
437+
|debian:unstable-slim|registry.access.redhat.com/ubi9/ubi:latest|
438+
439+
The UBI based images are required for deployments that run on OpenShift Container Platform (OCP).
440+
441+
To build these images:
442+
```bash
443+
UBI=1 make <image-name>
444+
```
445+
446+
### Containers with RPM dependencies
447+
448+
There are two containers that have external dependencies which are installed at build time from OSV repositories:
449+
* intel-idxd-config-initcontainer
450+
* intel-gpu-levelzero
451+
452+
To build these containers, the build host has to be registered via `subscription-manager`. Typically the host OS has to be RHEL or some other RPM based Linux variant (e.g. Fedora).
453+
454+
```bash
455+
UBI=1 BUILDER=podman make <image-name>
456+
```
457+
458+
Docker doesn't support installing RPM packages with `subscription-manager`, so Podman needs to be used.
459+
429460
## Checklist for New Device Plugins
430461

431462
For new device plugins contributed to this repository, below is a

0 commit comments

Comments
 (0)