Skip to content

Commit 61ce3b3

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #1948 from marquiz/devel/deprecate-separate-ports
Deprecate separate metrics and health port args
2 parents 955095c + 4bb91e2 commit 61ce3b3

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

‎docs/deployment/helm.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -177,8 +177,8 @@ API's you need to install the prometheus operator in your cluster.
177177
| `master.*` | dict | | NFD master deployment configuration |
178178
| `master.enable` | bool | true | Specifies whether nfd-master should be deployed |
179179
| `master.hostNetwork` | bool | false | Specifies whether to enable or disable running the container in the host's network namespace |
180-
| `master.metricsPort` | integer | 8081 | Port on which to expose metrics from components to prometheus operator |
181-
| `master.healthPort` | integer | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes |
180+
| `master.metricsPort` | integer | 8081 | Port on which to expose metrics from components to prometheus operator. **DEPRECATED**: will be replaced by `master.port` in NFD v0.18. |
181+
| `master.healthPort` | integer | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes. **DEPRECATED**: will be replaced by `master.port` in NFD v0.18. |
182182
| `master.instance` | string | | Instance name. Used to separate annotation namespaces for multiple parallel deployments |
183183
| `master.resyncPeriod` | string | | NFD API controller resync period. |
184184
| `master.extraLabelNs` | array | [] | List of allowed extra label namespaces |
@@ -230,8 +230,8 @@ API's you need to install the prometheus operator in your cluster.
230230
| `worker.*` | dict | | NFD worker daemonset configuration |
231231
| `worker.enable` | bool | true | Specifies whether nfd-worker should be deployed |
232232
| `worker.hostNetwork` | bool | false | Specifies whether to enable or disable running the container in the host's network namespace |
233-
| `worker.metricsPort` | int | 8081 | Port on which to expose metrics from components to prometheus operator |
234-
| `worker.healthPort` | int | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes |
233+
| `worker.metricsPort` | int | 8081 | Port on which to expose metrics from components to prometheus operator. **DEPRECATED**: will be replaced by `worker.port` in NFD v0.18. |
234+
| `worker.healthPort` | int | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes. **DEPRECATED**: will be replaced by `worker.port` in NFD v0.18. |
235235
| `worker.config` | dict | | NFD worker [configuration](../reference/worker-configuration-reference) |
236236
| `worker.podSecurityContext` | dict | {} | [PodSecurityContext](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) holds pod-level security attributes and common container settins |
237237
| `worker.securityContext` | dict | {} | Container [security settings](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container) |
@@ -272,8 +272,8 @@ API's you need to install the prometheus operator in your cluster.
272272
| `topologyUpdater.serviceAccount.annotations` | dict | {} | Annotations to add to the service account for topology updater |
273273
| `topologyUpdater.serviceAccount.name` | string | | The name of the service account for topology updater to use. If not set and create is true, a name is generated using the fullname template and `-topology-updater` suffix |
274274
| `topologyUpdater.rbac.create` | bool | true | Specifies whether to create [RBAC][rbac] configuration for topology updater |
275-
| `topologyUpdater.metricsPort` | integer | 8081 | Port on which to expose prometheus metrics |
276-
| `topologyUpdater.healthPort` | integer | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes |
275+
| `topologyUpdater.metricsPort` | integer | 8081 | Port on which to expose prometheus metrics. **DEPRECATED**: will be replaced by `topologyUpdater.port` in NFD v0.18. |
276+
| `topologyUpdater.healthPort` | integer | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes. **DEPRECATED**: will be replaced by `topologyUpdater.port` in NFD v0.18. |
277277
| `topologyUpdater.kubeletConfigPath` | string | "" | Specifies the kubelet config host path |
278278
| `topologyUpdater.kubeletPodResourcesSockPath` | string | "" | Specifies the kubelet sock path to read pod resources |
279279
| `topologyUpdater.updateInterval` | string | 60s | Time to sleep between CR updates. Non-positive value implies no CR update. |
@@ -318,7 +318,7 @@ API's you need to install the prometheus operator in your cluster.
318318
| `gc.podSecurityContext` | dict | {} | [PodSecurityContext](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod) holds pod-level security attributes and common container settings |
319319
| `gc.resources.limits` | dict | {memory: 1Gi} | NFD Garbage Collector pod [resources limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits) |
320320
| `gc.resources.requests` | dict | {cpu: 10m, memory: 128Mi} | NFD Garbage Collector pod [resources requests](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits) |
321-
| `gc.metricsPort` | integer | 8081 | Port on which to serve Prometheus metrics |
321+
| `gc.metricsPort` | integer | 8081 | Port on which to serve Prometheus metrics. **DEPRECATED**: will be replaced by `gc.port` in NFD v0.18. |
322322
| `gc.nodeSelector` | dict | {} | Garbage collector pod [node selector](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) |
323323
| `gc.tolerations` | dict | {} | Garbage collector pod [node tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |
324324
| `gc.annotations` | dict | {} | Garbage collector pod [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) |

‎docs/reference/master-commandline-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ resources from all Node objects of the cluster and exit.
4949

5050
### -metrics
5151

52+
**DEPRECATED**: Will be removed in NFD v0.17 and replaced by `-port`.
53+
5254
The `-metrics` flag specifies the port on which to expose
5355
[Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the
5456
metrics server on nfd-master.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ nfd-topology-updater -oneshot -no-publish
7474

7575
### -metrics
7676

77+
**DEPRECATED**: Will be removed in NFD v0.17 and replaced by `-port`.
78+
7779
The `-metrics` flag specifies the port on which to expose
7880
[Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the
7981
metrics server on nfd-topology-updater.

‎docs/reference/worker-commandline-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ nfd-worker -label-sources=kernel,system,local
128128

129129
### -metrics
130130

131+
**DEPRECATED**: Will be removed in NFD v0.17 and replaced by `-port`.
132+
131133
The `-metrics` flag specifies the port on which to expose
132134
[Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the
133135
metrics server on nfd-worker.

0 commit comments

Comments
 (0)