mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-14 11:57:51 +00:00
Code Activity

Makefile: reorganise container image variables

Browse source 
Change the structure and naming of the make variables that control the
container image name/tag that gets created. Default values and behavior
stay the same, but, this change tries to make it easier to customize the
build from command line.

Also, document all the relevant make variables in readme.
This commit is contained in:
Markus Lehtonen 2018-11-16 14:26:33 +02:00
parent 61ffd260bb
commit e7d272ad0f
2 changed files with 38 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
Makefile
View file

@ -2,19 +2,20 @@
IMAGE_BUILD_CMD := docker build
QUAY_DOMAIN_NAME := quay.io
QUAY_REGISTRY_USER := kubernetes_incubator
DOCKER_IMAGE_NAME := node-feature-discovery
VERSION := $(shell git describe --tags --dirty --always)
IMAGE_REGISTRY := quay.io/kubernetes_incubator
IMAGE_NAME := node-feature-discovery
IMAGE_TAG_NAME := $(VERSION)
IMAGE_REPO := $(IMAGE_REGISTRY)/$(IMAGE_NAME)
IMAGE_TAG := $(IMAGE_REPO):$(IMAGE_TAG_NAME)
all: image
# To override QUAY_REGISTRY_USER use the -e option as follows:
# QUAY_REGISTRY_USER=<my-username> make docker -e.
image:
$(IMAGE_BUILD_CMD) --build-arg NFD_VERSION=$(VERSION) \
-t $(QUAY_DOMAIN_NAME)/$(QUAY_REGISTRY_USER)/$(DOCKER_IMAGE_NAME):$(VERSION) ./
-t $(IMAGE_TAG) ./
mock:
mockery --name=FeatureSource --dir=source --inpkg --note="Re-generate by running 'make mock'"

43
README.md
View file

@ -560,32 +560,26 @@ Currently, the only available configuration options are related to the
## Building from source
Download the source code.
**Download the source code:**
```
git clone https://github.com/kubernetes-sigs/node-feature-discovery
```
**Build the container image:**
**Build the container image:**<br>
See [customizing the build](#customizing-the-build) below for altering the
container image registry, for example.
```
cd <project-root>
make
```
**NOTE**: Our default docker image is hosted in quay.io. To override the
`QUAY_REGISTRY_USER` use the `-e` option as follows:
`QUAY_REGISTRY_USER=<my-username> make image -e`
You can also specify a build tool different from Docker, for example:
```
make IMAGE_BUILD_CMD="buildah bud"
```
Push the container image (optional, this example with Docker)
**Push the container image:**<br>
Optional, this example with Docker.
```
docker push <quay-domain-name>/<registry-user>/<image-name>:<version>
docker push <image registry>/<image-name>:<version>
```
**Change the job spec to use your custom image (optional):**
@ -595,6 +589,29 @@ To use your published image from the step above instead of the
attribute in the spec template(s) to the new location
(`<quay-domain-name>/<registry-user>/<image-name>[:<version>]`).
### Customizing the Build
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_REGISTRY | Container image registry to use | quay.io/kubernetes_incubator
| IMAGE_NAME | Container image name | node-feature-discovery
| IMAGE_TAG_NAME | Container image tag name | &lt;nfd version&gt;
| IMAGE_REPO | Container image repository to use | &lt;IMAGE_REGISTRY&gt;/&lt;IMAGE_NAME&gt;
| IMAGE_TAG | Full image:tag to tag the image with | &lt;IMAGE_REPO&gt;/&lt;IMAGE_NAME&gt;
For example, to use a custom registry:
```
make IMAGE_REGISTRY=<my custom registry uri>
```
Or to specify a build tool different from Docker:
```
make IMAGE_BUILD_CMD="buildah bud"
```
## Targeting Nodes with Specific Features
Nodes with specific features can be targeted using the `nodeSelector` field. The