coreweave/ceph-csi

coreweave/ceph-csi

Description: CSI driver for Ceph

Language: Go

License: Apache-2.0

Stars: 0

Forks: 0

Open issues: 1

Created: 2021-05-13T03:00:27Z

Pushed: 2024-07-10T04:24:38Z

Default branch: devel

Fork: yes

Parent repository: ceph/ceph-csi

Archived: no

README:

Ceph CSI

  

• [Ceph CSI](#ceph-csi)
• [Overview](#overview)
• [Project status](#project-status)
• [Known to work CO platforms](#known-to-work-co-platforms)
• [Support Matrix](#support-matrix)
• [Ceph-CSI features and available versions](#ceph-csi-features-and-available-versions)
• [CSI spec and Kubernetes version compatibility](#csi-spec-and-kubernetes-version-compatibility)
• [Ceph CSI Container images and release compatibility](#ceph-csi-container-images-and-release-compatibility)
• [Contributing to this repo](#contributing-to-this-repo)
• [Troubleshooting](#troubleshooting)
• [Weekly Bug Triage call](#weekly-bug-triage-call)
• [Dev standup](#dev-standup)
• [Contact](#contact)

This repo contains the Ceph Container Storage Interface (CSI) driver for RBD, CephFS and Kubernetes sidecar deployment YAMLs to support CSI functionality: provisioner, attacher, resizer, driver-registrar and snapshotter.

Overview

Ceph CSI plugins implement an interface between a CSI-enabled Container Orchestrator (CO) and Ceph clusters. They enable dynamically provisioning Ceph volumes and attaching them to workloads.

Independent CSI plugins are provided to support RBD and CephFS backed volumes,

• For details about configuration and deployment of RBD plugin, please refer

rbd doc and for CephFS plugin configuration and deployment please refer cephFS doc.

• For example usage of the RBD and CephFS CSI plugins, see examples in examples/.
• Stale resource cleanup, please refer [cleanup doc](docs/resource-cleanup.md).

NOTE:

• Ceph CSI `Arm64` support is experimental.

Project status

Status: GA

Known to work CO platforms

Ceph CSI drivers are currently developed and tested exclusively in Kubernetes environments.

| Ceph CSI Version | Container Orchestrator Name | Version Tested| | -----------------| --------------------------- | --------------| | v3.9.0 | Kubernetes | v1.25, v1.26, v1.27| | v3.8.1 | Kubernetes | v1.25, v1.26, v1.27| | v3.8.0 | Kubernetes | v1.24, v1.25, v1.26, v1.27|

There is work in progress to make this CO-independent and thus support other orchestration environments (Nomad, Mesos..etc).

NOTE:

The supported window of Ceph CSI versions is "N.(x-1)": (N (Latest major release) . (x (Latest minor release) - 1)).

For example, if the Ceph CSI latest major version is 3.9.0 today, support is provided for the versions above 3.8.0. If users are running an unsupported Ceph CSI version, they will be asked to upgrade when requesting support.

Support Matrix

Ceph-CSI features and available versions

Please refer [rbd nbd mounter](./docs/rbd-nbd.md#support-matrix) for its support details.

| Plugin | Features | Feature Status | CSI Driver Version | CSI Spec Version | Ceph Cluster Version | Kubernetes Version | | ------ | --------------------------------------------------------- | -------------- | ------------------ | ---------------- | -------------------- | ------------------ | | RBD | Dynamically provision, de-provision Block mode RWO volume | GA | >= v1.0.0 | >= v1.0.0 | Octopus (>=15.0.0) | >= v1.14.0 | | | Dynamically provision, de-provision Block mode RWX volume | GA | >= v1.0.0 | >= v1.0.0 | Octopus (>=15.0.0) | >= v1.14.0 | | | Dynamically provision, de-provision Block mode RWOP volume| Alpha | >= v3.5.0 | >= v1.5.0 | Octopus (>=15.0.0) | >= v1.22.0 | | | Dynamically provision, de-provision File mode RWO volume | GA | >= v1.0.0 | >= v1.0.0 | Octopus (>=15.0.0) | >= v1.14.0 | | | Dynamically provision, de-provision File mode RWOP volume | Alpha | >= v3.5.0 | >= v1.5.0 | Octopus (>=15.0.0) | >= v1.22.0 | | | Provision File Mode ROX volume from snapshot | Alpha | >= v3.0.0 | >= v1.0.0 | Octopus (>=v15.0.0) | >= v1.17.0 | | | Provision File Mode ROX volume from another volume | Alpha | >= v3.0.0 | >= v1.0.0 | Octopus (>=v15.0.0) | >= v1.16.0 | | | Provision Block Mode ROX volume from snapshot | Alpha | >= v3.0.0 | >= v1.0.0 | Octopus (>=v15.0.0) | >= v1.17.0 | | | Provision Block Mode ROX volume from another volume | Alpha | >= v3.0.0 | >= v1.0.0 | Octopus (>=v15.0.0) | >= v1.16.0 | | | Creating and deleting snapshot | GA | >= v1.0.0 | >= v1.0.0 | Octopus (>=15.0.0) | >= v1.17.0 | | | Provision volume from snapshot | GA | >= v1.0.0 | >= v1.0.0 | Octopus (>=15.0.0) | >= v1.17.0 | | | Provision volume from another volume | GA | >= v1.0.0 | >= v1.0.0 | Octopus (>=15.0.0) | >= v1.16.0 | | | Expand volume | Beta | >= v2.0.0 | >= v1.1.0 | Octopus (>=15.0.0) | >= v1.15.0 | | | Volume/PV Metrics of File Mode Volume | GA | >= v1.2.0 | >= v1.1.0 | Octopus (>=15.0.0) | >= v1.15.0 | | | Volume/PV Metrics of Block Mode Volume | GA | >= v1.2.0 | >= v1.1.0 | Octopus (>=15.0.0) | >= v1.21.0 | | | Topology Aware Provisioning Support | Alpha | >= v2.1.0 | >= v1.1.0 | Octopus (>=15.0.0) | >= v1.14.0 | | CephFS | Dynamically provision, de-provision File mode RWO volume | GA | >= v1.1.0 | >= v1.0.0 | Octopus (>=15.0.0) | >= v1.14.0 | | | Dynamically provision, de-provision File mode RWX volume | GA | >= v1.1.0 | >= v1.0.0 | Octopus (>=v15.0.0) | >= v1.14.0 | | | Dynamically provision, de-provision File mode ROX volume | Alpha | >= v3.0.0 | >= v1.0.0 | Octopus (>=v15.0.0) | >= v1.14.0 | | | Dynamically provision, de-provision File mode RWOP volume | Alpha | >= v3.5.0 | >= v1.5.0 | Octopus (>=15.0.0) | >= v1.22.0 | | | Creating and deleting snapshot | GA | >= v3.1.0 | >= v1.0.0 | Octopus (>=v15.2.4) | >= v1.17.0 | | | Provision volume from snapshot | GA | >= v3.1.0 | >= v1.0.0 | Octopus (>=v15.2.4) | >= v1.17.0 | | | Provision volume from another volume | GA | >= v3.1.0 | >=…