Container Storage Interface (CSI) Driver for Intel® Rack Scale Design (Intel® RSD) NVMeoF

DISCONTINUATION OF PROJECT. This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.

About

Container Storage Interface (CSI) Driver for Intel® Rack Scale Design (Intel® RSD) NVMe is a storage driver for container orchestrators like Kubernetes. It makes remote NVMe storage volumes shared by Intel® RSD hardware available as filesystem volumes to container applications. The driver communicates with Intel® RSD hardware through Redfish/Swordfish protocols to create storage volumes, list them, attach them to the RSD nodes and delete them. Linux NVMe CLI is used to create NVME over Fabric Connections between RSD compute nodes and an RSD storage subsystem. The driver follows the CSI specification by listening for API requests and provisioning volumes accordingly.

Prerequisites

Build

This project uses Go modules to manage dependencies. It requires version 1.12 + of Go.
To build the container image an up to date version of Docker (18.03+) is required.

Run

The CSI Driver for RSD NVMe is designed to run on a Kubernetes 1.13+ installed on a preconfigured RSD set up.
The RSD set up should include at least one compute node and a pooled storage node with NVMe storage.
RSD Getting Started Guide
RSD Storage API Specifications
RSD Reference Implementation

Support requests for set up and configuration of RSD should be directed to the RSD Github repository.

Setup

Quick Start

1. Clone source code:
   git clone https://github.intel.com/kubernetes-rsd/csi-intel-rsd\
2. Build the driver:
   cd csi-intel-rsd && make all\
3. Create secret for RSD username and password:
   kubectl create secret generic intel-rsd-secret --from-literal=rsd-username='****' --from-literal=rsd-password='******'\
4. Create label for RSD node id:
   kubectl label node --overwrite $(hostname | tr '[:upper:]' '[:lower:]') csi.intel.com/rsd-node=<RSD node id>\
5. Build driver image:
   make driver-image\
6. Run deployment script:
   cd deployments/kubernetes-1.13 && ./deploy

Additional options

csi-intel-rsd driver, node-driver-registrar, csi-provisioner and csi-attacher parameters can be configured in deployments/kubernetes-1.13/driver.yaml\

The following flags can be passed to the driver binary

Usage

The driver enables usage of RSD NVMe over Fabric (NVMeoF) pooled storage in a Kubernetes cluster environment by implementing the CSI specification. RSD NVMeoF storage volumes can be used in Kubernetes pods as dynamically provisioned Persistent Volumes.
Kubernetes pods can then use the Persistent Volumes through PersistentVolumeClaim.

Usage example can be found in the deployments/kubernetes-1.13/example directory as follows

To deploy application user need to first run 'deploy-pvc' script to deploy the persistent volume.

'deploy-app' will then create an application that requests this volume, causing it to be created through the CSI RSD NVMeoF Driver and attached.

Components

The full CSI driver functionality comes from a collection of four components as per the CSI spec.

Communication and Contribution

Report a bug by filing a new issue. Contribute by opening a pull request.

Reporting a Potential Security Vulnerability: If you have discovered potential security vulnerability in this project, please send an e-mail to [email protected]. For issues related to Intel Products, please visit Intel Security Center.

It is important to include the following details:

• The projects and versions affected
• Detailed description of the vulnerability
• Information on known exploits

Vulnerability information is extremely sensitive. Please encrypt all security vulnerability reports using our PGP key.

A member of the Intel Product Security Team will review your e-mail and contact you to collaborate on resolving the issue. For more information on how Intel works to resolve security issues, see: vulnerability handling guidelines.