Skip to content

Updated the external snapshot metadata sidecar version to Beta. #637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
k8s-ci-robot merged 2 commits into from
Apr 29, 2026
Merged

Updated the external snapshot metadata sidecar version to Beta. #637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbd6921
Updated the external snapshot metadata sidecar version to Beta.
carlbraganza Feb 24, 2026
a96be96
Update book/src/external-snapshot-metadata.md
carlbraganza Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions book/src/changed-block-tracking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Status | Min K8s Version | Max K8s Version | Min CSI Version | Max CSI Version |
-------|-----------------|-----------------|-----------------|-----------------|
Alpha | 1.33 | - | [v1.10.0](https://github.com/container-storage-interface/spec/releases/tag/v1.10.0) | -
Beta | 1.36 | - | [v1.12.0](https://github.com/container-storage-interface/spec/releases/tag/v1.12.0) | -


## Overview
Expand All @@ -26,6 +26,9 @@ CSI drivers that implement this feature should deploy the
[external-snapshot-metadata](./external-snapshot-metadata.md)
sidecar and create the associated
[Snapshot Metadata Service CR](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/3314-csi-changed-block-tracking#snapshot-metadata-service-custom-resource).
The related [SnapshotMetadataService CRD](https://github.com/kubernetes-csi/external-snapshot-metadata/blob/3a139dd44d4ffa01343a91bed40996b1db56fd38/client/config/crd/cbt.storage.k8s.io_snapshotmetadataservices.yaml)
should be installed by the Kubernetes distribution or the cluster
administrator, and must exist prior to installing the CSI driver.

The `external-snapshot-metadata` sidecar implements the server side of the
[Kubernetes SnapshotMetadata Service API](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/3314-csi-changed-block-tracking#the-kubernetes-snapshotmetadata-service-api).
Expand All @@ -34,4 +37,3 @@ through this API, bypassing the Kubernetes API server for the most part.
Backup application developers should refer to the [Usage](external-snapshot-metadata.md#usage)
and [Resources](external-snapshot-metadata.md#resources)
sections of the sidecar documentation for details.

14 changes: 11 additions & 3 deletions book/src/external-snapshot-metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@

Latest stable release | Branch | Min CSI Version | Max CSI Version | Container Image | [Min K8s Version](project-policies.md#minimum-version) | [Max K8s Version](project-policies.md#maximum-version) | [Recommended K8s Version](project-policies.md#recommended-version) |
--|--|--|--|--|--|--|--
v0.1.0 | [v0.1.0](https://github.com/kubernetes-csi/external-snapshot-metadata/releases/tag/v0.1.0) | [v1.10.0](https://github.com/container-storage-interface/spec/releases/tag/v1.10.0) | - | registry.k8s.io/sig-storage/csi-snapshot-metadata:v0.1.0 | v1.33 | - | v1.33
v1.0.0 | [v1.0.0](https://github.com/kubernetes-csi/external-snapshot-metadata/releases/tag/v1.0.0) | [v1.12.0](https://github.com/container-storage-interface/spec/releases/tag/v1.12.0) | - | registry.k8s.io/sig-storage/csi-snapshot-metadata:v1.0.0 | v1.36 | - | v1.36


## Alpha
## Beta

### Description
This sidecar securely serves snapshot metadata to Kubernetes clients through the
Expand Down Expand Up @@ -87,13 +87,21 @@ availability of this optional feature to Kubernetes backup application clients.
The CR contains the CA certificate and Service endpoint address
of the sidecar and the audience string needed for the client
authentication token.
The related [SnapshotMetadataService CRD](https://github.com/kubernetes-csi/external-snapshot-metadata/blob/3a139dd44d4ffa01343a91bed40996b1db56fd38/client/config/crd/cbt.storage.k8s.io_snapshotmetadataservices.yaml)
should be installed by the Kubernetes distribution or the cluster administrator,
and must exist prior to installing the CSI driver.
The CSI driver installer must examine the version of the CRD, and should either
fail the installation of the driver or not provide support for this optional feature
if the CRD version is not supported.

### Resources

The [external-snapshot-metadata repository](https://github.com/kubernetes-csi/external-snapshot-metadata) contains
the [protobuf specification](https://github.com/kubernetes-csi/external-snapshot-metadata/tree/main/proto/schema.proto)
of the
[Kubernetes SnapshotMetadata Service API](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/3314-csi-changed-block-tracking#the-kubernetes-snapshotmetadata-service-api).
[Kubernetes SnapshotMetadata Service API](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/3314-csi-changed-block-tracking#the-kubernetes-snapshotmetadata-service-api)
and the
[SnapshotMetadataService CRD](https://github.com/kubernetes-csi/external-snapshot-metadata/blob/3a139dd44d4ffa01343a91bed40996b1db56fd38/client/config/crd/cbt.storage.k8s.io_snapshotmetadataservices.yaml).

In addition, the repository has a number of useful artifacts to support Go language programs:

Expand Down
Loading