mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2025-03-17 22:08:33 +00:00
Format helm.md
Signed-off-by: Tobias Giese <tgiese@nvidia.com>
This commit is contained in:
Tobias Giese
parent
91f631b116
commit
901fbe2866
1 changed files with 153 additions and 138 deletions
|
|
@ -5,9 +5,11 @@ sort: 3
|
|||
---
|
||||
|
||||
# Deployment with Helm
|
||||
|
||||
{: .no_toc}
|
||||
|
||||
## Table of contents
|
||||
|
||||
{: .no_toc .text-delta}
|
||||
|
||||
1. TOC
|
||||
|
|
@ -71,7 +73,8 @@ To upgrade the `node-feature-discovery` deployment to {{ site.release }} via Hel
|
|||
|
||||
### From v0.7 and older
|
||||
|
||||
Please see the [uninstallation guide](https://kubernetes-sigs.github.io/node-feature-discovery/v0.7/get-started/deployment-and-usage.html#uninstallation).
|
||||
Please see
|
||||
the [uninstallation guide](https://kubernetes-sigs.github.io/node-feature-discovery/v0.7/get-started/deployment-and-usage.html#uninstallation).
|
||||
And then follow the standard [deployment instructions](#deployment).
|
||||
|
||||
### From v0.8 - v0.11
|
||||
|
|
@ -148,11 +151,11 @@ Chart parameters are available.
|
|||
### General parameters
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --------------------------------------------------- | ------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
|-----------------------------------------------------|--------|-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `image.repository` | string | `{{ site.container_image \| split: ":" \| first }}` | NFD image repository |
|
||||
| `image.tag` | string | `{{ site.release }}` | NFD image tag |
|
||||
| `image.pullPolicy` | string | `Always` | Image pull policy |
|
||||
| `imagePullSecrets` | array | [] | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. [More info](https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod). |
|
||||
| `imagePullSecrets` | array | [] | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. [More info](https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod). |
|
||||
| `nameOverride` | string | | Override the name of the chart |
|
||||
| `fullnameOverride` | string | | Override a default fully qualified app name |
|
||||
| `tls.enable` | bool | false | Specifies whether to use TLS for communications between components. **NOTE**: this parameter is related to the deprecated gRPC API and will be removed with it in a future release. |
|
||||
|
|
@ -174,7 +177,7 @@ API's you need to install the prometheus operator in your cluster.
|
|||
### Master pod parameters
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ----------------------------------- | ------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
|-------------------------------------|---------|-----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `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 |
|
||||
|
|
@ -198,7 +201,7 @@ API's you need to install the prometheus operator in your cluster.
|
|||
| `master.service.type` | string | ClusterIP | NFD master service type. **NOTE**: this parameter is related to the deprecated gRPC API and will be removed with it in a future release |
|
||||
| `master.service.port` | integer | 8080 | NFD master service port. **NOTE**: this parameter is related to the deprecated gRPC API and will be removed with it in a future release |
|
||||
| `master.resources.limits` | dict | {memory: 4Gi} | NFD master pod [resources limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits) |
|
||||
| `master.resources.requests` | dict | {cpu: 100m, memory: 128Mi} | NFD master pod [resources requests](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits). You may want to use the same value for `requests.memory` and `limits.memory`. The “requests” value affects scheduling to accommodate pods on nodes. If there is a large difference between “requests” and “limits” and nodes experience memory pressure, the kernel may invoke the OOM Killer, even if the memory does not exceed the “limits” threshold. This can cause unexpected pod evictions. Memory cannot be compressed and once allocated to a pod, it can only be reclaimed by killing the pod. [Natan Yellin 22/09/2022](https://home.robusta.dev/blog/kubernetes-memory-limit) that discusses this issue. |
|
||||
| `master.resources.requests` | dict | {cpu: 100m, memory: 128Mi} | NFD master pod [resources requests](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits). See `[0]` for more info |
|
||||
| `master.tolerations` | dict | _Schedule to control-plane node_ | NFD master pod [tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |
|
||||
| `master.annotations` | dict | {} | NFD master pod [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) |
|
||||
| `master.affinity` | dict | | NFD master pod required [node affinity](https://kubernetes.io/docs/tasks/configure-pod-container/assign-pods-nodes-using-node-affinity/) |
|
||||
|
|
@ -211,10 +214,21 @@ API's you need to install the prometheus operator in your cluster.
|
|||
| `master.livenessProbe` | dict | {"grpc":{"port":8082},"initialDelaySeconds":10} | NFD master pod [liveness probe](https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/#liveness-probe) |
|
||||
| `master.readinessProbe` | dict | {"grpc":{"port":8082},"initialDelaySeconds":5,"failureThreshold": 10} | NFD master pod [readiness probe](https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/#readiness-probe) |
|
||||
|
||||
> `[0]` Additional info for `master.resources.requests`: \
|
||||
> You may want to use the same value for `requests.memory` and `limits.memory`.
|
||||
> The “requests” value affects scheduling to accommodate pods on nodes.
|
||||
> If there is a large difference between “requests” and “limits” and nodes
|
||||
> experience memory pressure, the kernel may invoke the OOM Killer, even if
|
||||
> the memory does not exceed the “limits” threshold.
|
||||
> This can cause unexpected pod evictions. Memory cannot be compressed and
|
||||
> once allocated to a pod, it can only be reclaimed by killing the pod.
|
||||
> [Natan Yellin 22/09/2022](https://home.robusta.dev/blog/kubernetes-memory-limit)
|
||||
> that discusses this issue.
|
||||
|
||||
### Worker pod parameters
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ----------------------------------- | ------ | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|-------------------------------------|---------|-----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `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 |
|
||||
|
|
@ -244,7 +258,7 @@ API's you need to install the prometheus operator in your cluster.
|
|||
### Topology updater parameters
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --------------------------------------------- | ------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
|-----------------------------------------------|---------|-----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `topologyUpdater.*` | dict | | NFD Topology Updater configuration |
|
||||
| `topologyUpdater.enable` | bool | false | Specifies whether the NFD Topology Updater should be created |
|
||||
| `topologyUpdater.hostNetwork` | bool | false | Specifies whether to enable or disable running the container in the host's network namespace |
|
||||
|
|
@ -280,7 +294,7 @@ API's you need to install the prometheus operator in your cluster.
|
|||
### Garbage collector parameters
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| ------------------------------------- | ------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|---------------------------------|---------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `gc.*` | dict | | NFD Garbage Collector configuration |
|
||||
| `gc.enable` | bool | true | Specifies whether the NFD Garbage Collector should be created |
|
||||
| `gc.hostNetwork` | bool | false | Specifies whether to enable or disable running the container in the host's network namespace |
|
||||
|
|
@ -303,4 +317,5 @@ API's you need to install the prometheus operator in your cluster.
|
|||
| `gc.revisionHistoryLimit` | integer | | Specify how many old ReplicaSets for this Deployment you want to retain. [revisionHistoryLimit](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#revision-history-limit) |
|
||||
|
||||
<!-- Links -->
|
||||
|
||||
[rbac]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue