mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2025-03-16 05:18:19 +00:00
6171c745a4
Introduce two main sections "Deployment" and "Usage" and move "Developer guide" to the top level, too. In particular, split the huge deployment-and-usage file into multiple parts under the new main sections. Move customization guide from "Advanced" to "Usage". This patch also renames "Advanced" to "Reference" as only that is left there is reference documentation.
85 lines
1.8 KiB
Markdown
85 lines
1.8 KiB
Markdown
---
|
|
title: "NFD Operator"
|
|
layout: default
|
|
sort: 4
|
|
---
|
|
|
|
# Deployment with NFD Operator
|
|
{: .no_toc}
|
|
|
|
## Table of contents
|
|
{: .no_toc .text-delta}
|
|
|
|
1. TOC
|
|
{:toc}
|
|
|
|
---
|
|
|
|
## Deployment
|
|
|
|
Deployment using the
|
|
[Node Feature Discovery Operator][nfd-operator]
|
|
is recommended to be done via
|
|
[operatorhub.io](https://operatorhub.io/operator/nfd-operator).
|
|
|
|
1. You need to have
|
|
[OLM][OLM]
|
|
installed. If you don't, take a look at the
|
|
[latest release](https://github.com/operator-framework/operator-lifecycle-manager/releases/latest)
|
|
for detailed instructions.
|
|
1. Install the operator:
|
|
|
|
```bash
|
|
kubectl create -f https://operatorhub.io/install/nfd-operator.yaml
|
|
```
|
|
|
|
1. Create `NodeFeatureDiscovery` object (in `nfd` namespace here):
|
|
|
|
```bash
|
|
cat << EOF | kubectl apply -f -
|
|
apiVersion: v1
|
|
kind: Namespace
|
|
metadata:
|
|
name: nfd
|
|
---
|
|
apiVersion: nfd.kubernetes.io/v1
|
|
kind: NodeFeatureDiscovery
|
|
metadata:
|
|
name: my-nfd-deployment
|
|
namespace: nfd
|
|
spec:
|
|
operand:
|
|
image: {{ site.container_image }}
|
|
imagePullPolicy: IfNotPresent
|
|
EOF
|
|
```
|
|
|
|
In order to deploy the [minimal](image-variants#minimal) image you need to use
|
|
|
|
```yaml
|
|
image: {{ site.container_image }}-minimal
|
|
```
|
|
|
|
in the `NodeFeatureDiscovery` object above.
|
|
|
|
## Uninstallation
|
|
|
|
If you followed the deployment instructions above you can simply do:
|
|
|
|
```bash
|
|
kubectl -n nfd delete NodeFeatureDiscovery my-nfd-deployment
|
|
```
|
|
|
|
Optionally, you can also remove the namespace:
|
|
|
|
```bash
|
|
kubectl delete ns nfd
|
|
```
|
|
|
|
See the [node-feature-discovery-operator][nfd-operator] and [OLM][OLM] project
|
|
documentation for instructions for uninstalling the operator and operator
|
|
lifecycle manager, respectively.
|
|
|
|
<!-- Links -->
|
|
[nfd-operator]: https://github.com/kubernetes-sigs/node-feature-discovery-operator
|
|
[OLM]: https://github.com/operator-framework/operator-lifecycle-manager
|