Skip to content

Commit 2f915ec

Browse files
authored
Merge pull request #144 from andyxning/add_setup_readme
add setup readme
2 parents b9857dc + 963a977 commit 2f915ec

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,20 @@ For example, to run without auth, use the following config:
8181
* `--hostname-override`: A customized node name used for node-problem-detector to update conditions and emit events. node-problem-detector gets node name first from `hostname-override`, then `NODE_NAME` environment variable and finally fall back to `os.Hostname`.
8282

8383
## Build Image
84-
Run `make` in the top directory. It will:
85-
* Build the binary.
86-
* Build the docker image. The binary and `config/` are copied into the docker image.
84+
* `go get` or `git clone` node-problem-detector repo into `$GOPATH/src/k8s.io` or `$GOROOT/src/k8s.io`
85+
with one of the below directions:
86+
* `cd $GOPATH/src/k8s.io && git clone [email protected]:kubernetes/node-problem-detector.git`
87+
* `cd $GOROOT/src/k8s.io && git clone [email protected]:kubernetes/node-problem-detector.git`
88+
* `cd $GOPATH/src/k8s.io && go get k8s.io/node-problem-detector`
89+
90+
* run `make` in the top directory. It will:
91+
* Build the binary.
92+
* Build the docker image. The binary and `config/` are copied into the docker image.
93+
94+
**Note**:
95+
By default node-problem-detector will be built with systemd support with `make` command. This requires systemd develop files.
96+
You should download the systemd develop files first. For Ubuntu, `libsystemd-journal-dev` package should
97+
be installed.
8798

8899
## Push Image
89100
`make push` uploads the docker image to registry. By default, the image will be uploaded to

0 commit comments

Comments
 (0)