diff --git a/Dockerfile b/Dockerfile index 95f5b284..910c58c3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,5 @@ ARG BASE_IMAGE_FULL +ARG BASE_IMAGE_MINIMAL # Build the manager biinary FROM golang:1.16.7-buster as builder diff --git a/docs/advanced/developer-guide.md b/docs/advanced/developer-guide.md index 38270988..d4b05be5 100644 --- a/docs/advanced/developer-guide.md +++ b/docs/advanced/developer-guide.md @@ -30,6 +30,13 @@ IMAGE_REGISTRY= make image ``` +Or for the `minimal` variant + +```bash +IMAGE_REGISTRY= +make image-minimal +``` + #### Push the container image ```bash @@ -37,6 +44,13 @@ IMAGE_REGISTRY= make push ``` +Or for the `minimal` variant + +```bash +IMAGE_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. diff --git a/docs/get-started/quick-start.md b/docs/get-started/quick-start.md index 2af0179c..bc6d62ac 100644 --- a/docs/get-started/quick-start.md +++ b/docs/get-started/quick-start.md @@ -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 @@ -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