Skip to content

Commit 480dddb

Browse files
authored
Merge pull request #2167 from marquiz/devel/docs-port-flag
docs: document -port flag
2 parents 7daeafa + e41a097 commit 480dddb

File tree

3 files changed

+15
-24
lines changed

3 files changed

+15
-24
lines changed

docs/reference/master-commandline-reference.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,20 +47,17 @@ The `-prune` flag is a sub-command like option for cleaning up the cluster. It
4747
causes nfd-master to remove all NFD related labels, annotations and extended
4848
resources from all Node objects of the cluster and exit.
4949

50-
### -metrics
50+
### -port
5151

52-
**DEPRECATED**: Will be removed in NFD v0.17 and replaced by `-port`.
52+
The `-port` flag specifies the port on which metrics and healthz endpoints are
53+
served on.
5354

54-
The `-metrics` flag specifies the port on which to expose
55-
[Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the
56-
metrics server on nfd-master.
57-
58-
Default: 8081
55+
Default: 8080
5956

6057
Example:
6158

6259
```bash
63-
nfd-master -metrics=12345
60+
nfd-master -port=12345
6461
```
6562

6663
### -instance

docs/reference/topology-updater-commandline-reference.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,17 @@ Example:
7272
nfd-topology-updater -oneshot -no-publish
7373
```
7474

75-
### -metrics
75+
### -port
7676

77-
**DEPRECATED**: Will be removed in NFD v0.17 and replaced by `-port`.
77+
The `-port` flag specifies the port on which metrics and healthz endpoints are
78+
served on.
7879

79-
The `-metrics` flag specifies the port on which to expose
80-
[Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the
81-
metrics server on nfd-topology-updater.
82-
83-
Default: 8081
80+
Default: 8080
8481

8582
Example:
8683

8784
```bash
88-
nfd-topology-updater -metrics=12345
85+
nfd-topology-updater -port=12345
8986
```
9087

9188
### -sleep-interval

docs/reference/worker-commandline-reference.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -126,20 +126,17 @@ Example:
126126
nfd-worker -label-sources=kernel,system,local
127127
```
128128

129-
### -metrics
129+
### -port
130130

131-
**DEPRECATED**: Will be removed in NFD v0.17 and replaced by `-port`.
131+
The `-port` flag specifies the port on which metrics and healthz endpoints are
132+
served on.
132133

133-
The `-metrics` flag specifies the port on which to expose
134-
[Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the
135-
metrics server on nfd-worker.
136-
137-
Default: 8081
134+
Default: 8080
138135

139136
Example:
140137

141138
```bash
142-
nfd-worker -metrics=12345
139+
nfd-worker -port=12345
143140
```
144141

145142
### -no-publish

0 commit comments

Comments
 (0)