CSI Snapshot Exporter

---

🌐 Links

• Documentation: https://docs.outscale.com/en/userguide/Exporting-a-Snapshot-to-a-Bucket.html
• Project website: https://github.com/outscale/csi-snapshot-exporter
• Join our community on Discord

---

📄 Table of Contents

• Overview
• Installation
• Configuration
• Usage
• Examples
• License
• Contributing

---

🧭 Overview

CSI Snapshot Exporter is a sidecar container to the CSI driver. It allows exporting Volume Snapshots to OOS.

---

⚙ Installation

Installation is usually done through the CSI Helm chart.

---

🛠 Configuration

See the CSI Helm chart configuration.

---

🚀 Usage

The following parameters may be added to a VolumeSnapshotClass:

• exportToOOS (boolean) - enable exports,
• exportImageFormat (qcow2 | raw) - the export format, defaults to qcow2,
• exportBucket (string) - required,
• exportPrefix (string) - optional.

The following annotations will be added to VolumeSnapshotContent resources:

• bsu.csi.outscale.com/export-task - the id of the export task (e.g., snap-export-12d8b47d),
• bsu.csi.outscale.com/export-state - the state of the export task (pending, active, completed, cancelled or failed),
• bsu.csi.outscale.com/export-path - the path (including exportPrefix) of the file exported in the OOS bucket.

Placeholders may be added to exportPrefix:

• {date} will be replaced by the date, using the YYYY-MM-DD format,
• {vs} will be replaced by the name of the source VolumeSnapshot,
• {ns} will be replaced by the namespace of the source VolumeSnapshot.

---

💡 Examples

apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
  name: snapshot-exporter-test
driver: bsu.csi.outscale.com
parameters:
  exportBucket: my-snapshot-exports
  exportImageFormat: qcow2
  exportPrefix: {ns}/{vs}/{date}/
  exportToOOS: "true"

---

📜 License

CSI Snapshot Exporter is released under the BSD 3-Clause license.

© 2025 Outscale SAS

This project complies with the REUSE Specification.

See LICENSES/ directory for full license information.

---

🤝 Contributing

We welcome contributions!

Please read our Contributing Guidelines and Code of Conduct before submitting a pull request.