external-snapshot-metadata

This repository contains components that implement the KEP-3314 CSI Changed Block Tracking feature.

Overview

The repository provides the following components:

• The External Snapshot Metadata sidecar container that exposes the Kubernetes SnapshotMetadataService API to backup applications, and interacts with a CSI driver's implementation of the CSI SnapshotMetadataService.
• The SnapshotMetadataService CRD used to advertise the CSI Driver's support for the CSI Changed Block Tracking feature.
• gRPC stubs
  • Kubernetes SnapshotMetadataService API
  • Mocks for the Kubernetes SnapshotMetadataService API client
  • Mocks for the CSI SnapshotMetadataService API client
• Examples
  • Instructions on how to deploy a CSI driver with the external-snapshot-metadata sidecar.
  • A snapshot-metadata-lister example command to illustrate how a Kubernetes backup application could fetch snapshot metadata. This is based on pkg/iterator, which a backup application developer could use directly to fetch snapshot metadata, if desired.
  • A snapshot-metadata-verifier command to provide a way to verify allocated or changed blocks metadata generated by CSI Drivers.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

• Slack
• Mailing List

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.