Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/integration-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ jobs:
kubectl create serviceaccount backup-app-service-account
kubectl create clusterrolebinding csi-client-cluster-role-binding --clusterrole=external-snapshot-metadata-client-runner --serviceaccount=default:backup-app-service-account

go build -o snapshot-metadata-lister ./examples/snapshot-metadata-lister/main.go
go build -o snapshot-metadata-verifier ./examples/snapshot-metadata-verifier/main.go
go build -o snapshot-metadata-lister ./tools/snapshot-metadata-lister/main.go

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we keep the tools in examples repo?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

symlinks?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we keep the tools in examples repo?

we will end up with ambiguous import because Go finds the same package path in module cache: When examples/snapshot-metadata-verifier/go.mod requires github.com/kubernetes-csi/external-snapshot-metadata v0.2.0.

Since the published v0.2.0 module doesn't have a tools/ directory, there's no conflict, Go can only find it from the local go.mod.

go build -o snapshot-metadata-verifier ./tools/snapshot-metadata-verifier/main.go

./snapshot-metadata-lister -h

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ The repository provides the following components:
- [Mocks for the CSI SnapshotMetadataService API client](https://github.com/kubernetes-csi/external-snapshot-metadata/tree/master/pkg/csiclientmocks)
- Examples
- [Instructions on how to deploy a CSI driver with the `external-snapshot-metadata` sidecar](https://github.com/kubernetes-csi/external-snapshot-metadata/tree/main/deploy).
- A [snapshot-metadata-lister](https://github.com/kubernetes-csi/external-snapshot-metadata/tree/master/examples/snapshot-metadata-lister)
- A [snapshot-metadata-lister](https://github.com/kubernetes-csi/external-snapshot-metadata/tree/master/tools/snapshot-metadata-lister)
example command to illustrate how a Kubernetes backup application could fetch snapshot metadata.
This is based on [pkg/iterator](https://github.com/kubernetes-csi/external-snapshot-metadata/tree/master/pkg/iterator),
which a backup application developer could use directly to fetch snapshot metadata, if desired.
- A [snapshot-metadata-verifier](https://github.com/kubernetes-csi/external-snapshot-metadata/tree/master/examples/snapshot-metadata-verifier) command to provide a way to verify allocated or changed blocks metadata generated by CSI Drivers.
- A [snapshot-metadata-verifier](https://github.com/kubernetes-csi/external-snapshot-metadata/tree/master/tools/snapshot-metadata-verifier) command to provide a way to verify allocated or changed blocks metadata generated by CSI Drivers.

## Community, discussion, contribution, and support

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ spec:
- /bin/sh
- -c
- |
go install github.com/kubernetes-csi/external-snapshot-metadata/examples/snapshot-metadata-lister@latest
go install github.com/kubernetes-csi/external-snapshot-metadata/tools/snapshot-metadata-lister@latest
cp $(go env GOPATH)/bin/snapshot-metadata-lister /output
volumeMounts:
- name: shared-volume
Expand Down
53 changes: 53 additions & 0 deletions tools/snapshot-metadata-lister/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
module github.com/kubernetes-csi/external-snapshot-metadata/tools/snapshot-metadata-lister

go 1.25.0

require (
github.com/kubernetes-csi/external-snapshot-metadata v0.2.0
k8s.io/client-go v0.35.0
)

require (
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
github.com/emicklei/go-restful/v3 v3.12.2 // indirect
github.com/fxamacker/cbor/v2 v2.9.0 // indirect
github.com/go-logr/logr v1.4.3 // indirect
github.com/go-openapi/jsonpointer v0.21.1 // indirect
github.com/go-openapi/jsonreference v0.21.0 // indirect
github.com/go-openapi/swag v0.23.1 // indirect
github.com/google/gnostic-models v0.7.0 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/josharian/intern v1.0.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect
github.com/kubernetes-csi/external-snapshot-metadata/client v0.1.0 // indirect
github.com/kubernetes-csi/external-snapshotter/client/v8 v8.4.0 // indirect
github.com/mailru/easyjson v0.9.1 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee // indirect
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/spf13/pflag v1.0.9 // indirect
github.com/x448/float16 v0.8.4 // indirect
go.yaml.in/yaml/v2 v2.4.3 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/net v0.47.0 // indirect
golang.org/x/oauth2 v0.30.0 // indirect
golang.org/x/sys v0.38.0 // indirect
golang.org/x/term v0.37.0 // indirect
golang.org/x/text v0.31.0 // indirect
golang.org/x/time v0.11.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20250303144028-a0af3efb3deb // indirect
google.golang.org/grpc v1.72.1 // indirect
google.golang.org/protobuf v1.36.8 // indirect
gopkg.in/evanphx/json-patch.v4 v4.13.0 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
k8s.io/api v0.35.0 // indirect
k8s.io/apimachinery v0.35.0 // indirect
k8s.io/klog/v2 v2.130.1 // indirect
k8s.io/kube-openapi v0.0.0-20250910181357-589584f1c912 // indirect
k8s.io/utils v0.0.0-20251002143259-bc988d571ff4 // indirect
sigs.k8s.io/json v0.0.0-20250730193827-2d320260d730 // indirect
sigs.k8s.io/randfill v1.0.0 // indirect
sigs.k8s.io/structured-merge-diff/v6 v6.3.0 // indirect
sigs.k8s.io/yaml v1.6.0 // indirect
)
Loading