Skip to content

Commit fc8294c

Browse files
committed
nfd: Update README.md
Optimize and clean up the readme content for clarity. Signed-off-by: Hersh Pathak hersh.pathak@intel.com
1 parent d056c9b commit fc8294c

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

nfd/README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
## NFD
22

3-
The [Node Feature Discovery](https://github.com/openshift/node-feature-discovery) (NFD) manages the detection of hardware features and configuration in OCP cluster by labeling the nodes with hardware-specific information.
3+
The [Node Feature Discovery](https://github.com/openshift/node-feature-discovery) (NFD) manages the detection of hardware features and configuration in a OCP cluster by labeling the nodes with hardware-specific information.
44

5-
NFD labels the host with node-specific attributes, such as PCI cards, kernel, operating system version, and so on. In this project NFD is used to automatically label nodes with specific Hardware features like Intel dGPU card, Intel SGX and Intel QAT etc.
5+
NFD labels the host with node-specific attributes, such as PCI cards, kernel, operating system version, and so on. In this project, NFD is used to automatically label nodes with specific hardware features such as Intel® Data Center GPU Flex Series, Intel® SGX and Intel® QAT etc.
66

7-
### Labels discription
7+
### Steps to install and configure NFD operator:
88

9-
* Label name - label discription
10-
11-
### Steps to install and configure NFD operator on OCP Cluster.
12-
13-
1. [NFD operator](https://github.com/openshift/cluster-nfd-operator) is used to manage the NFD stack. So firstly follow [NFD operator installation instructions](https://docs.openshift.com/container-platform/4.12/hardware_enablement/psap-node-feature-discovery-operator.html#install-operator-web-console_node-feature-discovery-operator) to install NFD operator on the OCP cluster.
9+
1. Follow the [NFD operator installation instructions](https://docs.openshift.com/container-platform/4.12/hardware_enablement/psap-node-feature-discovery-operator.html#install-operator-web-console_node-feature-discovery-operator) to install the NFD operator.
1410

1511
2. Create NodeFeatureDiscovery instance
1612

17-
```$ oc apply -f https://github.com/intel/intel-technology-enabling-for-openshift/blob/main/nfd/node-feature-discovery-openshift.yaml```
13+
```$ oc apply -f https://github.com/intel/intel-technology-enabling-for-openshift/blob/main/nfd/node-feature-discovery-openshift.yaml```
1814

1915
3. Create NodeFeatureRule instance
2016

21-
```$ oc apply -f https://github.com/intel/intel-technology-enabling-for-openshift/blob/main/nfd/node-feature-rules-openshift.yaml```
17+
```$ oc apply -f https://github.com/intel/intel-technology-enabling-for-openshift/blob/main/nfd/node-feature-rules-openshift.yaml```
18+
19+
4. If NFD has been configured properly, NFD will detect and label Intel® hardware features present on each node in the cluster.
20+
21+
FeatureName: NFD Label
2222

23+
```Intel® Data Center GPU Flex Series: intel.feature.node.kubernetes.io/gpu=true```
24+
25+
```Intel® QAT: intel.feature.node.kubernetes.io/qat=true```
26+
27+
```Intel® SGX: intel.feature.node.kubernetes.io/sgx=true```

0 commit comments

Comments
 (0)