Skip to content

Commit d08ea5e

Browse files
committed
Doc: Fix tilt up issue in feature discovering in developer guide
The issue is due to the k3d/kind cluster created by ctlptl will run inside containers(it will serve as the virtual hosts). Host folders which will be scaned by the nfd feature discovery should be mounted into the container ( the virtual host). otherwise the nfd-worker container which run inside the virtual host will just see the default base image rootfs /boot, /lib folders, which are usually empty, leads to the discovey failure. Signed-off-by: Chaoyi Huang <[email protected]>
1 parent 1c6ce89 commit d08ea5e

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

docs/developer-guide/index.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -256,19 +256,27 @@ the steps below.
256256
1. Install [kustomize](https://github.com/kubernetes-sigs/kustomize)
257257
1. Install [tilt](https://docs.tilt.dev/install.html)
258258
1. Create a local Kubernetes cluster
259+
- Create image registry first
260+
- Create a Kubernetes cluster. Please note that docker containers will be
261+
served as controller node and worker nodes, and NFD-worker will run as a
262+
DaemonSet in nested container. Therefore, to make sure the NFD-worker can
263+
discover the host features, the host folders "/boot" and "/lib" should be
264+
mounted into worker node docker containers when creating the Kubernetes
265+
cluster.
266+
1. Start up node feature discovery development environment
267+
To start up your Tilt development environment, run at the root of your
268+
local NFD codebase.
269+
270+
```shell
271+
tilt up
272+
```
259273
260-
To start up your Tilt development environment, run
261-
262-
```shell
263-
tilt up
264-
```
265-
266-
at the root of your local NFD codebase. Tilt will start a web interface in the
267-
localhost and port 10350. From the web interface, you are able to see how NFD worker
268-
and master are progressing, watch their build and runtime logs. Once your code changes
269-
are saved locally, Tilt will notice it and re-build the container image from the
270-
current code, push the image to the registry and re-deploy NFD pods with the latest
271-
container image.
274+
Tilt will start a web interface in the localhost and port 10350. From the
275+
web interface, you are able to see how NFD worker and master are
276+
progressing, watch their build and runtime logs. Once your code changes are
277+
saved locally, Tilt will notice it and re-build the container image from
278+
the current code, push the image to the registry and re-deploy NFD pods
279+
with the latest container image.
272280
273281
### Environment variables
274282

0 commit comments

Comments
 (0)