From c65cce268f1701d146aa3a8a5ecc0f184296769a Mon Sep 17 00:00:00 2001 From: Carlos Eduardo Arango Gutierrez Date: Mon, 16 Jan 2023 17:13:39 +0100 Subject: [PATCH] Enhance README --- README.md | 41 +++++++++++++++++++++++++++++++---------- 1 file changed, 31 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 15750e08..26f43061 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,41 @@ # Node Feature Discovery Operator -The Node Feature Discovery operator is a powerful tool for Kubernetes administrators that makes it easy to detect and understand the hardware features and configurations of your cluster's nodes. With this operator, you can easily gather information about your nodes that can be used for scheduling, resource management, and more. +The Node Feature Discovery operator is a powerful tool for Kubernetes administrators that makes it easy to detect and understand the hardware features and configurations of a cluster's nodes. With this operator, administrators can easily gather information about their nodes that can be used for scheduling, resource management, and more. ## How it Works -The operator orchestrates all resources needed to run the Node-Feature-Discovery DaemonSet. This DaemonSet runs on each node in the cluster and detects the features and configurations of the node's hardware. The operator then collects and organizes this information, making it easily accessible to you. +The operator works by orchestrating all resources needed to run the Node-Feature-Discovery DaemonSet. This DaemonSet runs on each node in the cluster and detects the features and configurations of the node's hardware. The operator then collects and organizes this information, making it easily accessible. -## Getting Started +## Quick start -To get started using the Node Feature Discovery operator, simply follow these steps: +Get the source code -1. Install the operator by following the instructions in the `deploy` directory. -2. Create a NodeFeatureDiscovery custom resource in your cluster. -3. Watch the operator and the DaemonSet gather information about your nodes. +```bash +git clone -b v0.5.0 https://github.com/kubernetes-sigs/node-feature-discovery-operator +``` -That's it! You're now able to view and utilize the information about your nodes that the operator has collected. +Deploy the operator + +> By default it will deploy using the minimal tag image, is +> desired you can simply modify the IMAGE_TAG env var to point to the image +> tag to use. + +```bash +IMAGE_TAG={{ site.container_image }} +make deploy +``` + +By default the operator will watch `NodeFeatureDiscovery` objects +only in the namespace where the operator is deployed in. This is +specified by the `WATCH_NAMESPACE` env variable in the operator +deployment manifest. If unset the operator will watch ALL +namespaces. + +Create a NodeFeatureDiscovery instance + +```bash +kubectl apply -f config/samples/nfd.kubernetes.io_v1_nodefeaturediscovery.yaml +``` ## Documentation @@ -22,8 +43,8 @@ For more detailed information on how to use the Node Feature Discovery operator, ## Contributing -We welcome contributions to the Node Feature Discovery operator! If you're interested in helping out, please take a look at our [contributing guidelines](CONTRIBUTING.md) and [open issues](https://github.com/kubernetes-sigs/node-feature-discovery-operator/issues). We're excited to have you join our community of contributors. +The Node Feature Discovery operator welcomes contributions, and interested parties are encouraged to take a look at the [contributing guidelines](CONTRIBUTING.md) and [open issues](https://github.com/kubernetes-sigs/node-feature-discovery-operator/issues). We're excited to have you join our community of contributors. ## Support -If you have any issues or questions about the Node Feature Discovery operator, please open an issue on our [GitHub repository](https://github.com/kubernetes-sigs/node-feature-discovery-operator/issues) or reach out to us on our [Slack channel](https://kubernetes.slack.com/messages/node-feature-discovery-operator). +If there are any issues or questions about the Node Feature Discovery operator, they can be addressed by opening an issue on the [GitHub repository](https://github.com/kubernetes-sigs/node-feature-discovery-operator/issues) or reaching out on the [Slack channel](https://kubernetes.slack.com/messages/node-feature-discovery-operator).