Skip to content

Commit 955095c

Browse files
authored
Merge pull request #1889 from ChaoyiHuang/fixtiltup
Doc: Fix tilt up issue in feature discovering in developer guide
2 parents d85d7ed + d08ea5e commit 955095c

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
@@ -242,19 +242,27 @@ the steps below.
242242
1. Install [kustomize](https://github.com/kubernetes-sigs/kustomize)
243243
1. Install [tilt](https://docs.tilt.dev/install.html)
244244
1. Create a local Kubernetes cluster
245+
- Create image registry first
246+
- Create a Kubernetes cluster. Please note that docker containers will be
247+
served as controller node and worker nodes, and NFD-worker will run as a
248+
DaemonSet in nested container. Therefore, to make sure the NFD-worker can
249+
discover the host features, the host folders "/boot" and "/lib" should be
250+
mounted into worker node docker containers when creating the Kubernetes
251+
cluster.
252+
1. Start up node feature discovery development environment
253+
To start up your Tilt development environment, run at the root of your
254+
local NFD codebase.
255+
256+
```shell
257+
tilt up
258+
```
245259
246-
To start up your Tilt development environment, run
247-
248-
```shell
249-
tilt up
250-
```
251-
252-
at the root of your local NFD codebase. Tilt will start a web interface in the
253-
localhost and port 10350. From the web interface, you are able to see how NFD worker
254-
and master are progressing, watch their build and runtime logs. Once your code changes
255-
are saved locally, Tilt will notice it and re-build the container image from the
256-
current code, push the image to the registry and re-deploy NFD pods with the latest
257-
container image.
260+
Tilt will start a web interface in the localhost and port 10350. From the
261+
web interface, you are able to see how NFD worker and master are
262+
progressing, watch their build and runtime logs. Once your code changes are
263+
saved locally, Tilt will notice it and re-build the container image from
264+
the current code, push the image to the registry and re-deploy NFD pods
265+
with the latest container image.
258266
259267
### Environment variables
260268

0 commit comments

Comments
 (0)