README
¶
node-disk-manager
node-disk-manager (NDM) aims to make it easy to manage the disks attached to the node. It treats disks as resources that need to be monitored and managed just like other resources like CPU, Memory and Network. It contains a daemon which runs on each node, detects attached disks and loads them as BlockDevice objects (custom resource) into Kubernetes.
While PVs are well suited for stateful workloads, the BlockDevice objects are aimed towards helping hyper-converged Storage Operators by providing abilities like:
- Easy to access inventory of block devices available across the Kubernetes Cluster.
- Predict failures on the blockdevices, to help with taking preventive actions.
- Allow for dynamically attaching/detaching blockdevices to a Storage Pod, without requiring a restart.
NDM has 2 main components:
- node-disk-manager daemonset, which runs on each node and is responsible for device detection.
- node-disk-operator deployment, which acts as an inventory of block devices in the cluster.
and 2 optional components:
- ndm-cluster-exporter deployment, which fetches block device object from etcd and exposes it as prometheus metrics.
- ndm-node-exporter daemonset, which runs on each node, queries the disk for details like SMART and expose it as prometheus metrics.
The design of the project is covered under this design proposal
Project Status
Currently, the NDM project is in beta.
Usage
A detailed usage documentation is maintained in the wiki.
Start Node Disk Manager
- Edit ndm-operator.yaml to fit your environment: Set the
namespace,serviceAccount, configure filters in thenode-disk-manager-config-map. - Switch to Cluster Admin context and create the components with
kubectl create -f ndm-operator.yaml. - This will install the daemon, operator and the exporters
Using kubectl to fetch BlockDevice Information
kubectl get blockdevicesdisplays the blockdevices across the cluster, withNODENAMEshowing the node to which disk is attached,CLAIMSTATEshowing whether the device is currently in use andSTATEshowing whether the device is connected to the node.kubectl get blockdevices -o widedisplays the blockdevice along with the path at which the device is attached on the node.kubectl get blockdevices <blockdevice-cr-name> -o yamldisplays all the details of the disk captured byndmfor given disk resource.
Building, Testing and Pushing Image
Before building the image locally, you need to setup your development environment. The detailed instructions for setting up development environment, building and testing are available here.
Push Image
By default Github Action pushes the docker image to openebs/node-disk-manager, with ci tags.
You can push to your custom registry and modify the ndm-operator.yaml file for your testing.
License
Inspiration
- Thanks to Daniel for setting up the go-based SMART library.
- Thanks to Humble, Jan and other from the Kubernetes Storage Community for reviewing the approach and evaluating the use-case.
Directories
¶
| Path | Synopsis |
|---|---|
|
api-service
|
|
|
cmd
|
|
|
ndm_daemonset/app
Package app will instantiate and run the node-disk-manager in the context of the Container Orchestrator
|
Package app will instantiate and run the node-disk-manager in the context of the Container Orchestrator |
|
db
|
|
|
integration_tests
|
|
|
pkg
|
|
|
apis/openebs/v1alpha1
Package v1alpha1 contains API Schema definitions for the openebs v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=openebs.io Package v1alpha1 contains API Schema definitions for the openebs v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=openebs.io
|
Package v1alpha1 contains API Schema definitions for the openebs v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=openebs.io Package v1alpha1 contains API Schema definitions for the openebs v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=openebs.io |
|
logs
Package logs provides unified logging framework for all the binaries under node-disk-manager.
|
Package logs provides unified logging framework for all the binaries under node-disk-manager. |
|
smart
Package smart provides details about a particular disk device which includes both basic details such as vendor, model, serial, etc as well as smart details such as Raw_Read_Error_Rate, Temperature_Celsius, Spin_Up_Time, etc by parsing various disk pages such as inquiry page, ata command set page ,etc using various SCSI commands such as scsi inquiry, read device capacity, mode sense, etc.
|
Package smart provides details about a particular disk device which includes both basic details such as vendor, model, serial, etc as well as smart details such as Raw_Read_Error_Rate, Temperature_Celsius, Spin_Up_Time, etc by parsing various disk pages such as inquiry page, ata command set page ,etc using various SCSI commands such as scsi inquiry, read device capacity, mode sense, etc. |
|
spec
|
|