Skip to content

Commit 8a5f302

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #1439 from ArangoGutierrez/helm.lint
Make mdlint v0.13 happy
2 parents 59c6897 + 150c394 commit 8a5f302

File tree

7 files changed

+339
-334
lines changed

7 files changed

+339
-334
lines changed

‎docs/deployment/helm.md

Lines changed: 91 additions & 91 deletions
Large diffs are not rendered by default.

‎docs/deployment/metrics.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,24 @@ By default NFD Master and Worker expose metrics on port 8081.
1313

1414
The exposed metrics are
1515

16-
| Metric | Type | Description
17-
| ------------------------------------------------- | --------- | ---------------------------------------
18-
| `nfd_master_build_info` | Gauge | Version from which nfd-master was built
19-
| `nfd_worker_build_info` | Gauge | Version from which nfd-worker was built
20-
| `nfd_gc_build_info` | Gauge | Version from which nfd-gc was built
21-
| `nfd_topology_updater_build_info` | Gauge | Version from which nfd-topology-updater was built
22-
| `nfd_node_update_requests_total` | Counter | Number of node update requests received by the master over gRPC
23-
| `nfd_node_updates_total` | Counter | Number of nodes updated
24-
| `nfd_node_update_failures_total` | Counter | Number of nodes update failures
25-
| `nfd_node_labels_rejected_total` | Counter | Number of nodes labels rejected by nfd-master
26-
| `nfd_node_extendedresources_rejected_total` | Counter | Number of nodes extended resources rejected by nfd-master
27-
| `nfd_node_taints_rejected_total` | Counter | Number of nodes taints rejected by nfd-master
28-
| `nfd_nodefeaturerule_processing_duration_seconds` | Histogram | Time taken to process NodeFeatureRule objects
29-
| `nfd_nodefeaturerule_processing_errors_total` | Counter | Number or errors encountered while processing NodeFeatureRule objects
30-
| `nfd_feature_discovery_duration_seconds` | Histogram | Time taken to discover features on a node
31-
| `nfd_topology_updater_scan_errors_total` | Counter | Number of errors in scanning resource allocation of pods.
32-
| `nfd_gc_objects_deleted_total` | Counter | Number of NodeFeature and NodeResourceTopology objects garbage collected.
33-
| `nfd_gc_object_delete_failures_total` | Counter | Number of errors in deleting NodeFeature and NodeResourceTopology objects.
16+
| Metric | Type | Description |
17+
| ------------------------------------------------- | --------- | ------------------------------------------------------- |
18+
| `nfd_master_build_info` | Gauge | Version from which nfd-master was built |
19+
| `nfd_worker_build_info` | Gauge | Version from which nfd-worker was built |
20+
| `nfd_gc_build_info` | Gauge | Version from which nfd-gc was built |
21+
| `nfd_topology_updater_build_info` | Gauge | Version from which nfd-topology-updater was built |
22+
| `nfd_node_update_requests_total` | Counter | Number of node update requests received by the master over gRPC |
23+
| `nfd_node_updates_total` | Counter | Number of nodes updated |
24+
| `nfd_node_update_failures_total` | Counter | Number of nodes update failures |
25+
| `nfd_node_labels_rejected_total` | Counter | Number of nodes labels rejected by nfd-master |
26+
| `nfd_node_extendedresources_rejected_total` | Counter | Number of nodes extended resources rejected by nfd-master |
27+
| `nfd_node_taints_rejected_total` | Counter | Number of nodes taints rejected by nfd-master |
28+
| `nfd_nodefeaturerule_processing_duration_seconds` | Histogram | Time taken to process NodeFeatureRule objects |
29+
| `nfd_nodefeaturerule_processing_errors_total` | Counter | Number or errors encountered while processing NodeFeatureRule objects |
30+
| `nfd_feature_discovery_duration_seconds` | Histogram | Time taken to discover features on a node |
31+
| `nfd_topology_updater_scan_errors_total` | Counter | Number of errors in scanning resource allocation of pods. |
32+
| `nfd_gc_objects_deleted_total` | Counter | Number of NodeFeature and NodeResourceTopology objects garbage collected. |
33+
| `nfd_gc_object_delete_failures_total` | Counter | Number of errors in deleting NodeFeature and NodeResourceTopology objects. |
3434

3535
## Kustomize
3636

‎docs/developer-guide/index.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -110,22 +110,22 @@ name of the resulting container image. The following are targeted targeted for
110110
build customization and they can be specified via environment variables or
111111
makefile overrides.
112112

113-
| Variable | Description | Default value
114-
| -------------------------- | ----------------------------------------------------------------- | ----------- |
115-
| HOSTMOUNT_PREFIX | Prefix of system directories for feature discovery (local builds) | / (*local builds*) /host- (*container builds*)
116-
| IMAGE_BUILD_CMD | Command to build the image | docker build
117-
| IMAGE_BUILD_EXTRA_OPTS | Extra options to pass to build command | *empty*
118-
| IMAGE_BUILDX_CMD | Command to build and push multi-arch images with buildx | DOCKER_CLI_EXPERIMENTAL=enabled docker buildx build --platform=${IMAGE_ALL_PLATFORMS} --progress=auto --pull
119-
| IMAGE_ALL_PLATFORMS | Comma separated list of OS/ARCH tuples for mulit-arch builds | linux/amd64,linux/arm64
120-
| IMAGE_PUSH_CMD | Command to push the image to remote registry | docker push
121-
| IMAGE_REGISTRY | Container image registry to use | registry.k8s.io/nfd
122-
| IMAGE_TAG_NAME | Container image tag name | <nfd version>
123-
| IMAGE_EXTRA_TAG_NAMES | Additional container image tag(s) to create when building image | *empty*
124-
| K8S_NAMESPACE | nfd-master and nfd-worker namespace | node-feature-discovery
125-
| KUBECONFIG | Kubeconfig for running e2e-tests | *empty*
126-
| E2E_TEST_CONFIG | Parameterization file of e2e-tests (see [example][e2e-config-sample]) | *empty*
127-
| E2E_PULL_IF_NOT_PRESENT | True-ish value makes the image pull policy IfNotPresent (to be used only in e2e tests) | false
128-
| OPENSHIFT | Non-empty value enables OpenShift specific support (currently only effective in e2e tests) | *empty*
113+
| Variable | Description | Default value |
114+
| -------------------------- | ----------------------------------------------------------------- | ------------- |
115+
| HOSTMOUNT_PREFIX | Prefix of system directories for feature discovery (local builds) | / (*local builds*) /host- (*container builds*) |
116+
| IMAGE_BUILD_CMD | Command to build the image | docker build |
117+
| IMAGE_BUILD_EXTRA_OPTS | Extra options to pass to build command | *empty* |
118+
| IMAGE_BUILDX_CMD | Command to build and push multi-arch images with buildx | DOCKER_CLI_EXPERIMENTAL=enabled docker buildx build --platform=${IMAGE_ALL_PLATFORMS} --progress=auto --pull |
119+
| IMAGE_ALL_PLATFORMS | Comma separated list of OS/ARCH tuples for mulit-arch builds | linux/amd64,linux/arm64 |
120+
| IMAGE_PUSH_CMD | Command to push the image to remote registry | docker push |
121+
| IMAGE_REGISTRY | Container image registry to use | registry.k8s.io/nfd |
122+
| IMAGE_TAG_NAME | Container image tag name | <nfd version> |
123+
| IMAGE_EXTRA_TAG_NAMES | Additional container image tag(s) to create when building image | *empty* |
124+
| K8S_NAMESPACE | nfd-master and nfd-worker namespace | node-feature-discovery |
125+
| KUBECONFIG | Kubeconfig for running e2e-tests | *empty* |
126+
| E2E_TEST_CONFIG | Parameterization file of e2e-tests (see [example][e2e-config-sample]) | *empty* |
127+
| E2E_PULL_IF_NOT_PRESENT | True-ish value makes the image pull policy IfNotPresent (to be used only in e2e tests) | false |
128+
| OPENSHIFT | Non-empty value enables OpenShift specific support (currently only effective in e2e tests) | *empty* |
129129

130130
For example, to use a custom registry:
131131

‎docs/get-started/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@ An overview of the default feature labels:
100100

101101
NFD also annotates nodes it is running on:
102102

103-
| Annotation | Description
104-
| ------------------------------------------------------------ | -----------
105-
| [<instance>.]nfd.node.kubernetes.io/feature-labels | Comma-separated list of node labels managed by NFD. NFD uses this internally so must not be edited by users.
106-
| [<instance>.]nfd.node.kubernetes.io/extended-resources | Comma-separated list of node extended resources managed by NFD. NFD uses this internally so must not be edited by users.
103+
| Annotation | Description |
104+
| ------------------------------------------------------------ | ----------------------------------------------------------- |
105+
| [<instance>.]nfd.node.kubernetes.io/feature-labels | Comma-separated list of node labels managed by NFD. NFD uses this internally so must not be edited by users. |
106+
| [<instance>.]nfd.node.kubernetes.io/extended-resources | Comma-separated list of node extended resources managed by NFD. NFD uses this internally so must not be edited by users. |
107107

108108
> **NOTE:** the [`-instance`](../reference/master-commandline-reference.md#instance)
109109
> command line flag affects the annotation names

‎docs/mdl-style.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@
88
rule 'MD007', :indent => 2
99
rule 'MD013', :ignore_code_blocks => true
1010
rule 'MD024', :allow_different_nesting => true
11+
# MD056 - Inconsistent number of columns in table
12+
# docs/deployment/helm.md:98
13+
exclude_rule 'MD056'

0 commit comments

Comments
 (0)