From 906b1a075fe865c0cbfdb1d15ab90114e418a001 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Mon, 25 May 2020 10:22:33 +0300 Subject: [PATCH] README: document new hostmount prefix Makefile variables --- README.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index df3578c18..d512118e0 100644 --- a/README.md +++ b/README.md @@ -877,19 +877,21 @@ attribute in the spec template(s) to the new location There are several Makefile variables that control the build process and the name of the resulting container image. -| Variable | Description | Default value -| ---------------------- | -------------------------------------------- | ----------- | -| IMAGE_BUILD_CMD | Command to build the image | docker build -| IMAGE_BUILD_EXTRA_OPTS | Extra options to pass to build command | *empty* -| IMAGE_PUSH_CMD | Command to push the image to remote registry | docker push -| IMAGE_REGISTRY | Container image registry to use | k8s.gcr.io/nfd -| IMAGE_NAME | Container image name | node-feature-discovery -| IMAGE_TAG_NAME | Container image tag name | <nfd version> -| IMAGE_REPO | Container image repository to use | <IMAGE_REGISTRY>/<IMAGE_NAME> -| IMAGE_TAG | Full image:tag to tag the image with | <IMAGE_REPO>/<IMAGE_NAME> -| K8S_NAMESPACE | nfd-master and nfd-worker namespace | kube-system -| KUBECONFIG | Kubeconfig for running e2e-tests | *empty* -| E2E_TEST_CONFIG | Parameterization file of e2e-tests (see [example](test/e2e/e2e-test-config.exapmle.yaml)) | *empty* +| Variable | Description | Default value +| -------------------------- | ----------------------------------------------------------------- | ----------- | +| HOSTMOUNT_PREFIX | Prefix of system directories for feature discovery (local builds) | / +| CONTAINER_HOSTMOUNT_PREFIX | Prefix of system directories for feature discovery (container builds) | <HOSTMOUNT_PREFIX> (*if specified*) /host- (*otherwise*) +| IMAGE_BUILD_CMD | Command to build the image | docker build +| IMAGE_BUILD_EXTRA_OPTS | Extra options to pass to build command | *empty* +| IMAGE_PUSH_CMD | Command to push the image to remote registry | docker push +| IMAGE_REGISTRY | Container image registry to use | k8s.gcr.io/nfd +| IMAGE_NAME | Container image name | node-feature-discovery +| IMAGE_TAG_NAME | Container image tag name | <nfd version> +| IMAGE_REPO | Container image repository to use | <IMAGE_REGISTRY>/<IMAGE_NAME> +| IMAGE_TAG | Full image:tag to tag the image with | <IMAGE_REPO>/<IMAGE_NAME> +| K8S_NAMESPACE | nfd-master and nfd-worker namespace | kube-system +| KUBECONFIG | Kubeconfig for running e2e-tests | *empty* +| E2E_TEST_CONFIG | Parameterization file of e2e-tests (see [example](test/e2e/e2e-test-config.exapmle.yaml)) | *empty* For example, to use a custom registry: ```