CSI Driver Administrators Guide

Configuration Overview

This article is for Kubernetes cluster administrators who perform the one-time configuration of Kubernetes that consists of:

  • Setting up each worker node that can use the CSI driver
  • Deploying the TrueNAS CSI driver in Kubernetes

After receiving the authentication credentials from the TrueNAS administrator, they then establish communication with TrueNAS using the API authentication key provided by TrueNAS and the TrueNAS system IP address.

Read full post gdoc_arrow_right_alt

CSI Driver

CSI Driver Overview

The TrueNAS CSI (Container Storage Interface) Driver is an official TrueNAS product that enables Kubernetes clusters to dynamically provision, manage, and consume storage from TrueNAS storage systems. The driver automatically creates storage volumes on-demand from Kubernetes, and leverages ZFS capabilities such as snapshots, clones, and compression in Kubernetes. The driver provides native Kubernetes integration via industry-standard CSI specifications.

Read full post gdoc_arrow_right_alt

CSI Driver User Guide

This guide is for developers/users using a Kubernetes cluster that want to use the TrueNAS CSI driver to create and submit requests for storage to use in pods. It covers creating PersistentVolumeClaims, mounting storage volumes, and using the features available to TrueNAS storage users.

For an overview of the Kubernetes/CSI driver integration see TrueNAS CSI Driver

For reference material including a glossary of terms, see CSI Driver Reference

Kubernetes Cluster Administrators Guide provides instructions on configuring StorageClasses and the Kubernetes integration with the CSI driver. The process involves creating a yaml file stored locally, and then submitting it to create the PVC using kubectl commands.

Read full post gdoc_arrow_right_alt

CSI Driver Reference

This article provides general reference information about the CSI Driver, a deployment checklist, capacity planning, troubleshooting and diagnostic commands for resolving issues between Kubernetes and the CSI driver, workflows for NFS and iSCSI deployments of the CSI driver integration with Kubernetes, best practices, a glossary of terms, as well as upgrade and suggested deployment options.

This article provides information that is not included in the administration and user guide articles.

Read full post gdoc_arrow_right_alt