This repo contains sidecar controller for the snapshot metadata service.

Go to file

Kubernetes Prow Robot c97af6ded7 Merge pull request #160 from iPraveenParihar/update/hostpath-container-image update: hostpath container image to v1.17.0		2025-07-15 20:02:24 -07:00
.github	ci: address the todo	2025-03-13 13:40:12 +05:30
CHANGELOG	add CHANGELOG folder and CHANGELOG-0.1.md	2025-01-24 20:41:13 +05:30
client	chore: update go to 1.23.6	2025-02-18 13:27:22 +00:00
cmd/csi-snapshot-metadata	update grpc-health-probe version to v0.4.37	2025-01-16 13:12:31 +05:30
deploy	update: hostpath container image to v1.17.0	2025-07-08 17:59:10 +05:30
examples	Add snapshot-metadata-verify tool	2025-02-18 22:40:02 +05:30
pkg	Add unit tests for VerifierEmitter methods	2025-02-18 22:40:02 +05:30
proto	Add server implementation for sidecar service	2024-07-03 21:07:47 +05:30
release-tools	Merge commit 'b5b81407ca81e880d6179f8dedd2056b89d7c9c0'	2025-05-05 12:15:59 +05:30
scripts	add intergration test github action	2025-01-09 18:28:00 +05:30
.cloudbuild.sh	add "./.cloudbuild.sh" symlink needed to build images	2024-11-05 13:31:18 +05:30
.gitignore	Fetch the optional snapshotter secrets from the VolumeSnapshotClass.	2024-09-13 03:46:42 +00:00
.golangci.yml	Fixed linter issues; added gci and importas rules.	2024-10-16 21:50:23 +00:00
.prow.sh	Log stream responses with progress with a separate detailed trace level.	2024-10-16 18:37:02 +00:00
CONTRIBUTING.md	update template files to include repo specific info	2024-04-24 12:50:12 +05:30
LICENSE	Initial commit	2024-04-24 12:41:05 +05:30
Makefile	Example illustrating how an application obtains snapshot metadata.	2024-11-26 02:32:02 +00:00
OWNERS	add rakshith-r to owners list	2025-01-08 22:24:27 +05:30
OWNERS_ALIASES	build: add release-tools files and makefile reference	2024-07-18 16:42:10 -04:00
README.md	Document snapshot-metadata-verifier command	2025-02-24 15:59:59 +05:30
RELEASE.md	Initial commit	2024-04-24 12:41:05 +05:30
SECURITY.md	Initial commit	2024-04-24 12:41:05 +05:30
SECURITY_CONTACTS	update template files to include repo specific info	2024-04-24 12:50:12 +05:30
cloudbuild.sh	build: add release-tools files and makefile reference	2024-07-18 16:42:10 -04:00
cloudbuild.yaml	Squashed 'release-tools/' changes from 406a79a..0496593	2024-12-17 14:58:10 +05:30
code-of-conduct.md	Initial commit	2024-04-24 12:41:05 +05:30
go.mod	Bump sigs.k8s.io/yaml from 1.4.0 to 1.5.0 in the k8s-dependencies group	2025-06-30 19:37:38 +00:00
go.sum	Bump sigs.k8s.io/yaml from 1.4.0 to 1.5.0 in the k8s-dependencies group	2025-06-30 19:37:38 +00:00

README.md

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
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:

Code of conduct

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