Skip to content
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.

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

Discrepancies with docs about importing snapshots in Kubernetes #468

Open
jnoordsij opened this issue Dec 13, 2022 · 0 comments
Open

Discrepancies with docs about importing snapshots in Kubernetes #468

jnoordsij opened this issue Dec 13, 2022 · 0 comments

Comments

@jnoordsij
Copy link

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.

  1. The docs specify testdriver.csi.k8s.io in the spec of the VolumeSnapshotContent, which probably will not work and should always be dobs.csi.digitalocean.com like in the example in this repo.
  2. The part about the name keys in the docs is slightly more vague then the part in this repo; moreover it mentions the name in the volumeSnapshotRef should match the name of the VolumeSnapshot, but in the given example they don't actually match. Similarly the reverse reference does also not match with the name.
  3. The docs mention the deletionPolicy is set to Retain like here, but the example actually uses Delete, 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant