csi-digitalocean
csi-digitalocean copied to clipboard
Discrepancies with docs about importing snapshots in Kubernetes
Note: not sure if this is the correct place to do docs suggestions, but the feedback button on that page led me to https://ideas.digitalocean.com/, which seems to me like a less logical location for this list, given the content more or less matches this repo.
When comparing the instructions about importing snapshots in this repo (https://github.com/digitalocean/csi-digitalocean/tree/master/examples/kubernetes/import-snapshot) to the variant in the docs (https://docs.digitalocean.com/products/kubernetes/how-to/import-snapshot/), I noticed a few discrepancies which are probably just slight mistakes in the docs.
- The docs specify
testdriver.csi.k8s.io
in the spec of theVolumeSnapshotContent
, which probably will not work and should always bedobs.csi.digitalocean.com
like in the example in this repo. - The part about the
name
keys in the docs is slightly more vague then the part in this repo; moreover it mentions thename
in thevolumeSnapshotRef
should match the name of theVolumeSnapshot
, but in the given example they don't actually match. Similarly the reverse reference does also not match with the name. - The docs mention the
deletionPolicy
is set toRetain
like here, but the example actually usesDelete
, which is possibly dangerous for those who are a little uncareful.
Where I do think the docs are correct and the example is wrong, is using spec.source.volumeSnapshotContentName
on the VolumeSnapshot
resource to reference the VolumeSnapshotContent
resource. This seems to actually match the most recent CRD spec I could find.
Maybe the differences are intentional, but I think the version in this repo is generally better, so it should be considered changing these things in the docs.