1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-05 08:17:04 +00:00

docs: strip out some "easily", "just" etc

This commit is contained in:
Markus Lehtonen 2023-11-28 20:27:33 +02:00
parent cc6df8e74f
commit fea395d005
7 changed files with 13 additions and 13 deletions

View file

@ -15,7 +15,7 @@ sort: 3
---
Node Feature Discovery Helm chart allow to easily deploy and manage NFD.
Node Feature Discovery provides a Helm chart to manage its deployment.
> **NOTE:** NFD is not ideal for other Helm charts to depend on as that may
> result in multiple parallel NFD deployments in the same cluster which is not

View file

@ -15,8 +15,8 @@ sort: 2
---
[Kustomize](https://github.com/kubernetes-sigs/kustomize) provides easy
deployment of NFD. Customization of the deployment is done by maintaining
[Kustomize](https://github.com/kubernetes-sigs/kustomize) can be used to
deploy NFD. Customization of the deployment is done by maintaining
declarative overlays on top of the base overlays in NFD.
To follow the deployment instructions here,

View file

@ -69,7 +69,7 @@ in the `NodeFeatureDiscovery` object above.
## Uninstallation
If you followed the deployment instructions above you can simply do:
If you followed the deployment instructions above you can uninstall NFD with:
```bash
kubectl -n nfd delete NodeFeatureDiscovery my-nfd-deployment

View file

@ -49,14 +49,15 @@ The NFD source code repository contains an example kustomize overlay and helm
chart that can be used to deploy NFD with cert-manager supplied certificates
enabled.
To install `cert-manager` itself can be done as easily as this, below, or you
can refer to their documentation for other installation methods such as the
helm chart they provide.
To install `cert-manager` itself, you can run:
```bash
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.2/cert-manager.yaml
```
Alternatively, you can refer to cert-manager documentation for other
installation methods such as the Helm chart they provide.
To use the kustomize overlay to install node-feature-discovery with TLS enabled,
you may use the following:

View file

@ -150,7 +150,7 @@ Or to specify a build tool different from Docker, It can be done in 2 ways:
### Testing
Unit tests are automatically run as part of the container image build. You can
also run them manually in the source code tree by simply running:
also run them manually in the source code tree by running:
```bash
make test
@ -257,7 +257,7 @@ the steps below.
1. Install [tilt](https://docs.tilt.dev/install.html)
1. Create a local Kubernetes cluster
To start up your Tilt development environment, just run
To start up your Tilt development environment, run
```shell
tilt up
@ -300,8 +300,7 @@ make site-serve
This will build the documentation in a container and serve it under
[localhost:4000/](http://localhost:4000/) making it easy to verify the results.
Any changes made to the `docs/` will automatically re-trigger a rebuild and are
reflected in the served content and can be inspected with a simple browser
refresh.
reflected in the served content and can be inspected with a browser refresh.
In order to just build the html documentation run:

View file

@ -83,7 +83,7 @@ NFD-Master runs as a deployment, by default
it prefers running on the cluster's master nodes but will run on worker
nodes if no master nodes are found.
For High Availability, you should simply increase the replica count of
For High Availability, you should increase the replica count of
the deployment object. You should also look into adding
[inter-pod](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)
affinity to prevent masters from running on the same node.

View file

@ -20,7 +20,7 @@ This can be changed by using the
config option.
The worker configuration file is watched and re-read on every change which
provides a simple mechanism of dynamic run-time reconfiguration. See
provides a mechanism of dynamic run-time reconfiguration. See
[worker configuration](#worker-configuration) for more details.
## Worker configuration