From 4bb91e20960cf710b802e6d7db7561a16d446aff Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Wed, 6 Nov 2024 12:14:41 +0200 Subject: [PATCH] Deprecate separate metrics and health port args --- docs/deployment/helm.md | 14 +++++++------- docs/reference/master-commandline-reference.md | 2 ++ .../topology-updater-commandline-reference.md | 2 ++ docs/reference/worker-commandline-reference.md | 2 ++ 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/deployment/helm.md b/docs/deployment/helm.md index a469c41b1..acf14479c 100644 --- a/docs/deployment/helm.md +++ b/docs/deployment/helm.md @@ -177,8 +177,8 @@ API's you need to install the prometheus operator in your cluster. | `master.*` | dict | | NFD master deployment configuration | | `master.enable` | bool | true | Specifies whether nfd-master should be deployed | | `master.hostNetwork` | bool | false | Specifies whether to enable or disable running the container in the host's network namespace | -| `master.metricsPort` | integer | 8081 | Port on which to expose metrics from components to prometheus operator | -| `master.healthPort` | integer | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes | +| `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. | +| `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. | | `master.instance` | string | | Instance name. Used to separate annotation namespaces for multiple parallel deployments | | `master.resyncPeriod` | string | | NFD API controller resync period. | | `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. | `worker.*` | dict | | NFD worker daemonset configuration | | `worker.enable` | bool | true | Specifies whether nfd-worker should be deployed | | `worker.hostNetwork` | bool | false | Specifies whether to enable or disable running the container in the host's network namespace | -| `worker.metricsPort` | int | 8081 | Port on which to expose metrics from components to prometheus operator | -| `worker.healthPort` | int | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes | +| `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. | +| `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. | | `worker.config` | dict | | NFD worker [configuration](../reference/worker-configuration-reference) | | `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 | | `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. | `topologyUpdater.serviceAccount.annotations` | dict | {} | Annotations to add to the service account for topology updater | | `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 | | `topologyUpdater.rbac.create` | bool | true | Specifies whether to create [RBAC][rbac] configuration for topology updater | -| `topologyUpdater.metricsPort` | integer | 8081 | Port on which to expose prometheus metrics | -| `topologyUpdater.healthPort` | integer | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes | +| `topologyUpdater.metricsPort` | integer | 8081 | Port on which to expose prometheus metrics. **DEPRECATED**: will be replaced by `topologyUpdater.port` in NFD v0.18. | +| `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. | | `topologyUpdater.kubeletConfigPath` | string | "" | Specifies the kubelet config host path | | `topologyUpdater.kubeletPodResourcesSockPath` | string | "" | Specifies the kubelet sock path to read pod resources | | `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. | `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 | | `gc.resources.limits` | dict | {memory: 1Gi} | NFD Garbage Collector pod [resources limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits) | | `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) | -| `gc.metricsPort` | integer | 8081 | Port on which to serve Prometheus metrics | +| `gc.metricsPort` | integer | 8081 | Port on which to serve Prometheus metrics. **DEPRECATED**: will be replaced by `gc.port` in NFD v0.18. | | `gc.nodeSelector` | dict | {} | Garbage collector pod [node selector](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) | | `gc.tolerations` | dict | {} | Garbage collector pod [node tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) | | `gc.annotations` | dict | {} | Garbage collector pod [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) | diff --git a/docs/reference/master-commandline-reference.md b/docs/reference/master-commandline-reference.md index b2ee963c0..807e78088 100644 --- a/docs/reference/master-commandline-reference.md +++ b/docs/reference/master-commandline-reference.md @@ -49,6 +49,8 @@ resources from all Node objects of the cluster and exit. ### -metrics +**DEPRECATED**: Will be removed in NFD v0.17 and replaced by `-port`. + The `-metrics` flag specifies the port on which to expose [Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the metrics server on nfd-master. diff --git a/docs/reference/topology-updater-commandline-reference.md b/docs/reference/topology-updater-commandline-reference.md index 702567baa..149c8a976 100644 --- a/docs/reference/topology-updater-commandline-reference.md +++ b/docs/reference/topology-updater-commandline-reference.md @@ -74,6 +74,8 @@ nfd-topology-updater -oneshot -no-publish ### -metrics +**DEPRECATED**: Will be removed in NFD v0.17 and replaced by `-port`. + The `-metrics` flag specifies the port on which to expose [Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the metrics server on nfd-topology-updater. diff --git a/docs/reference/worker-commandline-reference.md b/docs/reference/worker-commandline-reference.md index ebc82e3a6..95ed1a4c6 100644 --- a/docs/reference/worker-commandline-reference.md +++ b/docs/reference/worker-commandline-reference.md @@ -128,6 +128,8 @@ nfd-worker -label-sources=kernel,system,local ### -metrics +**DEPRECATED**: Will be removed in NFD v0.17 and replaced by `-port`. + The `-metrics` flag specifies the port on which to expose [Prometheus](https://prometheus.io/) metrics. Setting this to 0 disables the metrics server on nfd-worker.