1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-16 13:28:18 +00:00

Merge pull request #620 from marquiz/backports/0.8

backports/v0.8: fixes to docs
This commit is contained in:
Kubernetes Prow Robot 2021-10-04 07:11:09 -07:00 committed by GitHub
commit 81b65ef857
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 28 additions and 47 deletions

View file

@ -6,12 +6,10 @@ published: false
--- ---
# Architecture # Architecture
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}

View file

@ -6,12 +6,10 @@ published: false
--- ---
# Customization guide # Customization guide
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}

View file

@ -5,12 +5,10 @@ sort: 1
--- ---
# Developer guide # Developer guide
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}
@ -284,4 +282,4 @@ make site-build
This will generate html documentation under `docs/_site/`. This will generate html documentation under `docs/_site/`.
<!-- Links --> <!-- Links -->
[e2e-config-sample]: https://github.com/kubernetes-sigs/node-feature-discovery/blob/{{site.release}}/test/e2e/e2e-test-config.exapmle.yaml [e2e-config-sample]: https://github.com/kubernetes-sigs/node-feature-discovery/blob/{{site.release}}/test/e2e/e2e-test-config.example.yaml

View file

@ -6,12 +6,10 @@ published: false
--- ---
# Configuration file reference of end-to-end tests # Configuration file reference of end-to-end tests
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}

View file

@ -5,12 +5,10 @@ sort: 2
--- ---
# Commandline flags of nfd-master # Commandline flags of nfd-master
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}

View file

@ -5,12 +5,10 @@ sort: 3
--- ---
# Commandline flags of nfd-worker # Commandline flags of nfd-worker
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}

View file

@ -5,12 +5,10 @@ sort: 4
--- ---
# Configuration file reference of nfd-worker # Configuration file reference of nfd-worker
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
***WORK IN PROGRESS.*** ***WORK IN PROGRESS.***

View file

@ -5,12 +5,10 @@ sort: 3
--- ---
# Deployment and usage # Deployment and usage
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}
@ -212,7 +210,7 @@ We have introduced the following Chart parameters.
| `image.repository` | string | `{{ site.container_image | split: ":" | first }}` | NFD image repository | | `image.repository` | string | `{{ site.container_image | split: ":" | first }}` | NFD image repository |
| `image.tag` | string | `{{ site.release }}` | NFD image tag | | `image.tag` | string | `{{ site.release }}` | NFD image tag |
| `image.pullPolicy` | string | `Always` | Image pull policy | | `image.pullPolicy` | string | `Always` | Image pull policy |
| `imagePullSecrets` | list | [] | 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. [https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod](More info) | | `imagePullSecrets` | list | [] | 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) |
| `serviceAccount.create` | bool | true | Specifies whether a service account should be created | | `serviceAccount.create` | bool | true | Specifies whether a service account should be created |
| `serviceAccount.annotations` | dict | {} | Annotations to add to the service account | | `serviceAccount.annotations` | dict | {} | Annotations to add to the service account |
| `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 | | `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 |
@ -285,7 +283,7 @@ labels. The provided template will configure these for you.
NFD-Worker is preferably run as a Kubernetes DaemonSet. This assures NFD-Worker is preferably run as a Kubernetes DaemonSet. This assures
re-labeling on regular intervals capturing changes in the system configuration re-labeling on regular intervals capturing changes in the system configuration
and mames sure that new nodes are labeled as they are added to the cluster. and makes sure that new nodes are labeled as they are added to the cluster.
Worker connects to the nfd-master service to advertise hardware features. Worker connects to the nfd-master service to advertise hardware features.
When run as a daemonset, nodes are re-labeled at an interval specified using When run as a daemonset, nodes are re-labeled at an interval specified using

View file

@ -5,12 +5,10 @@ sort: 5
--- ---
# Examples and demos # Examples and demos
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}

View file

@ -5,12 +5,10 @@ sort: 4
--- ---
# Feature discovery # Feature discovery
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}

View file

@ -5,12 +5,10 @@ sort: 1
--- ---
# Introduction # Introduction
{: .no_toc}
{: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta}
{: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}

View file

@ -1,4 +1,7 @@
all all
# Exclude MD022 - Headers should be surrounded by blank lines. The kramdown
# "class magic" (like {: .no_toc}) needs to be directly below the heading line.
exclude_rule 'MD022'
# Exclude MD041 - First line in file should be a top level header # Exclude MD041 - First line in file should be a top level header
exclude_rule 'MD041' exclude_rule 'MD041'
rule 'MD013', :tables => false rule 'MD013', :tables => false