Skip to content

Commit

Permalink
Document minimal image
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
  • Loading branch information
ArangoGutierrez committed Aug 18, 2021
1 parent 8e404f2 commit 37457a7
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/advanced/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,27 @@ IMAGE_REGISTRY=<my registry>
make image
```

Or for the `minimal` variant

```bash
IMAGE_REGISTRY=<my registry>
make image-minimal
```

#### Push the container image

```bash
IMAGE_REGISTRY=<my registry>
make push
```

Or for the `minimal` variant

```bash
IMAGE_REGISTRY=<my registry>
make push-minimal
```

Alternatively, instead of specifying variables on the command line,
you can edit the Makefile to permanently change parameter defaults
like name of the image or namespace where the operator is deployed.
Expand Down
27 changes: 27 additions & 0 deletions docs/get-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ layout: default
sort: 2
---

# Requirements

1. Linux (x86_64/Arm64/Arm)
1. [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl)
(properly set up and configured to work with your Kubernetes cluster)

# Quick start

Get the source code
Expand All @@ -25,6 +31,27 @@ Create a NodeFeatureDiscovery instance
kubectl apply -f config/samples/nfd.kubernetes.io_v1_nodefeaturediscovery.yaml
```

## Image variants

Node-Feautre-Discovery-Operator currently offers two variants
of the container image. The "full" variant is currently
deployed by default.

### Full

This image is based on
[debian:buster-slim](https://hub.docker.com/_/debian) and contains a full Linux
system for doing live debugging and diagnosis of the operator.

### Minimal

This is a minimal image based on
[gcr.io/distroless/base](https://github.com/GoogleContainerTools/distroless/blob/master/base/README.md)
and only supports running statically linked binaries.

The container image tag has suffix `-minimal`
(e.g. `{{ site.container_image }}-minimal`)

## Verify

The Operator will deploy NFD based on the information
Expand Down

0 comments on commit 37457a7

Please sign in to comment.