Skip to content

Commit d5b6d68

Browse files
authored
Merge pull request #637 from carlbraganza/snapshot-metadata-sidecar-beta
Updated the external snapshot metadata sidecar version to Beta.
2 parents fb6da9c + a96be96 commit d5b6d68

2 files changed

Lines changed: 15 additions & 5 deletions

File tree

book/src/changed-block-tracking.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

99

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

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

book/src/external-snapshot-metadata.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88

99
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) |
1010
--|--|--|--|--|--|--|--
11-
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
11+
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
1212

1313

14-
## Alpha
14+
## Beta
1515

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

9197
### Resources
9298

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

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

0 commit comments

Comments
 (0)