Skip to content

Commit c076314

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #1943 from ArangoGutierrez/grpc_docs
Docs: remove gRPC
2 parents a883878 + b997ade commit c076314

File tree

10 files changed

+4
-429
lines changed

10 files changed

+4
-429
lines changed

‎docs/deployment/helm.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,6 @@ Chart parameters are available.
158158
| `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). |
159159
| `nameOverride` | string | | Override the name of the chart |
160160
| `fullnameOverride` | string | | Override a default fully qualified app name |
161-
| `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. |
162-
| `tls.certManager` | bool | false | If enabled, requires [cert-manager](https://cert-manager.io/docs/) to be installed and will automatically create the required TLS certificates. **NOTE**: this parameter is related to the deprecated gRPC API and will be removed with it in a future release |
163-
| `tls.certManager.certManagerCertificate.issuerName` | string | | If specified, it will use a pre-existing issuer instead for the required TLS certificates. **NOTE**: this parameter is related to the deprecated gRPC API and will be removed with it in a future release. |
164-
| `tls.certManager.certManagerCertificate.issuerKind` | string | | Specifies on what kind of issuer is used, can be either ClusterIssuer or Issuer (default). Requires `tls.certManager.certManagerCertificate.issuerName` to be set. **NOTE**: this parameter is related to the deprecated gRPC API and will be removed with it in a future release |
165161
| `featureGates.NodeFeatureAPI` | bool | true | Enable the [NodeFeature](../usage/custom-resources.md#nodefeature) CRD API for communicating node features. This will automatically disable the gRPC communication. |
166162
| `featureGates.NodeFeatureGroupAPI` | bool | false | Enable the [NodeFeatureGroup](../usage/custom-resources.md#nodefeaturegroup) CRD API. |
167163
| `featureGates.DisableAutoPrefix` | bool | false | Enable [DisableAutoPrefix](../reference/feature-gates.md#disableautoprefix) feature gate. Disables automatic prefixing of unprefixed labels, annotations and extended resources. |
@@ -181,25 +177,20 @@ API's you need to install the prometheus operator in your cluster.
181177
| `master.*` | dict | | NFD master deployment configuration |
182178
| `master.enable` | bool | true | Specifies whether nfd-master should be deployed |
183179
| `master.hostNetwork` | bool | false | Specifies whether to enable or disable running the container in the host's network namespace |
184-
| `master.port` | integer | | Specifies the TCP port that nfd-master listens for incoming requests. **NOTE**: this parameter is related to the deprecated gRPC API and will be removed with it in a future release |
185180
| `master.metricsPort` | integer | 8081 | Port on which to expose metrics from components to prometheus operator |
186181
| `master.healthPort` | integer | 8082 | Port on which to expose the grpc health endpoint, will be also used for the probes |
187182
| `master.instance` | string | | Instance name. Used to separate annotation namespaces for multiple parallel deployments |
188183
| `master.resyncPeriod` | string | | NFD API controller resync period. |
189184
| `master.extraLabelNs` | array | [] | List of allowed extra label namespaces |
190185
| `master.resourceLabels` | array | [] | List of labels to be registered as extended resources |
191186
| `master.enableTaints` | bool | false | Specifies whether to enable or disable node tainting |
192-
| `master.crdController` | bool | null | Specifies whether the NFD CRD API controller is enabled. If not set, controller will be enabled if `master.instance` is empty. |
193-
| `master.featureRulesController` | bool | null | DEPRECATED: use `master.crdController` instead |
194187
| `master.replicaCount` | integer | 1 | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified |
195188
| `master.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 |
196189
| `master.securityContext` | dict | {} | Container [security settings](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container) |
197190
| `master.serviceAccount.create` | bool | true | Specifies whether a service account should be created |
198191
| `master.serviceAccount.annotations` | dict | {} | Annotations to add to the service account |
199192
| `master.serviceAccount.name` | string | | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
200193
| `master.rbac.create` | bool | true | Specifies whether to create [RBAC][rbac] configuration for nfd-master |
201-
| `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 |
202-
| `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 |
203194
| `master.resources.limits` | dict | {memory: 4Gi} | NFD master pod [resources limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits) |
204195
| `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 |
205196
| `master.tolerations` | dict | _Schedule to control-plane node_ | NFD master pod [tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |

‎docs/deployment/kustomize.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,6 @@ scenarios under
5959
- [`prune`](https://github.com/kubernetes-sigs/node-feature-discovery/blob/{{site.release}}/deployment/overlays/prune):
6060
clean up the cluster after uninstallation, see
6161
[Removing feature labels](uninstallation.md#removing-feature-labels)
62-
- [`samples/cert-manager`](https://github.com/kubernetes-sigs/node-feature-discovery/blob/{{site.release}}/deployment/overlays/samples/cert-manager):
63-
an example for supplementing the default deployment with cert-manager for TLS
64-
authentication, see
65-
[Automated TLS certificate management using cert-manager](tls.md)
66-
for details
6762
- [`samples/custom-rules`](https://github.com/kubernetes-sigs/node-feature-discovery/blob/{{site.release}}/deployment/overlays/samples/custom-rules):
6863
an example for spicing up the default deployment with a separately managed
6964
configmap of custom labeling rules, see

‎docs/deployment/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Metrics"
33
layout: default
4-
sort: 7
4+
sort: 6
55
---
66

77
# Metrics

‎docs/deployment/tls.md

Lines changed: 0 additions & 181 deletions
This file was deleted.

‎docs/deployment/uninstallation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Uninstallation"
33
layout: default
4-
sort: 6
4+
sort: 5
55
---
66

77
# Uninstallation

‎docs/developer-guide/index.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -171,29 +171,15 @@ e2e-tests:
171171
| E2E_GINKGO_LABEL_FILTER | Ginkgo label filter to use for running e2e tests | *empty* |
172172
| OPENSHIFT | Non-empty value enables OpenShift specific support (only affects e2e tests) | *empty* |
173173

174-
## Running locally
175-
176-
> ****DEPRECATED**: Running NFD locally is deprecated and will be removed in a
177-
> future release. It depends on the gRPC API which is deprecated and will be
178-
> removed in a future release. To run NFD locally, disable the NodeFeature API
179-
> with `-feature-gates NodeFeatureAPI=false` flag.
180-
181-
You can run NFD locally, either directly on your host OS or in containers for
182-
testing and development purposes. This may be useful e.g. for checking
183-
features-detection.
184-
185174
### NFD-Master
186175

187176
When running as a standalone container labeling is expected to fail because
188-
Kubernetes API is not available. Thus, it is recommended to use `-no-publish`
189-
Also specify `-crd-controller=false` and `-feature-gates NodeFeatureAPI=false`
190-
command line flags to disable CRD controller and enable gRPC. E.g.
177+
Kubernetes API is not available. Thus, it is recommended to use `-no-publish`.
191178

192179
```bash
193180
$ export NFD_CONTAINER_IMAGE={{ site.container_image }}
194181
$ docker run --rm --name=nfd-test ${NFD_CONTAINER_IMAGE} nfd-master -no-publish -crd-controller=false -feature-gates NodeFeatureAPI=false
195182
2019/02/01 14:48:21 Node Feature Discovery Master <NFD_VERSION>
196-
2019/02/01 14:48:21 gRPC server serving on port: 8080
197183
```
198184

199185
### NFD-Worker

0 commit comments

Comments
 (0)