README.md

Linode Block Storage CSI Driver

Table of Contents

• Overview
• Deployment
  • Requirements
  • Secure a Linode API Access Token
  • Deployment Methods
    • Using Helm (Recommended)
    • Using kubectl
  • Advanced Configuration and Operational Details
• Usage Examples
  • Creating a PersistentVolumeClaim
  • Encrypted Drives using LUKS
  • Adding Tags to Created Volumes
• Development Setup
  • Prerequisites
  • Setting Up the Local Development Environment
  • Building the Project
  • Running Unit Tests
  • Creating a Development Cluster
  • Running E2E Tests
  • Contributing
• License
• Disclaimers
• Community

📚 Overview

The Container Storage Interface (CSI) Driver for Linode Block Storage enables container orchestrators such as Kubernetes to manage the lifecycle of persistent storage claims.

For more information about Kubernetes CSI, refer to the Kubernetes CSI and CSI Spec repositories.

⚠️ Disclaimers

• Version Compatibility: Until this driver has reached v1.0.0, it may not maintain compatibility between driver versions.
• Volume Size Constraints:
  • Requests for Persistent Volumes with a require_size less than the Linode minimum Block Storage size will be fulfilled with a Linode Block Storage volume of the minimum size (currently 10Gi) in accordance with the CSI specification.
  • The upper-limit size constraint (limit_bytes) will also be honored, so the size of Linode Block Storage volumes provisioned will not exceed this parameter.
• Volume Attachment Persistence: Block storage volume attachments are no longer persisted across reboots to support a higher number of attachments on larger instances.

For more details, refer to the CSI specification.

💬 Join Us on Slack

• General Help/Discussion: Kubernetes Slack - #linode
• Development/Debugging: Gopher's Slack - #linodego

License

This project is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.