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

[velero] Improve docs and add examples #166

Closed
wants to merge 8 commits into from
Closed

[velero] Improve docs and add examples #166

wants to merge 8 commits into from

Conversation

MaxymVlasov
Copy link

@MaxymVlasov MaxymVlasov commented Sep 28, 2020

Special notes for your reviewer:

I also can add Terraform 0.13 code for setup AWS and vSphere from zero, but not sure that it should be here.

P.S. Sad, but helm-chart not be used for up Velero 1.5.1 yet, so examples based on 1.4.2.

Checklist

[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]

  • DCO signed
  • Chart Version bumped
  • Variables are documented in the README.md
  • Title of the PR starts with chart name (e.g. [velero])

@jenting
Copy link
Collaborator

jenting commented Oct 5, 2020

I'm sure not is it good to put an example in the released helm chart 🤔 or would it be good to add the examples to the README.
What are other reviewers think? @nrb @carlisia @ashish-amarnath @cpanato

@jenting jenting added the documentation Improvements or additions to documentation label Oct 26, 2020
Signed-off-by: MaxymVlasov <[email protected]>
@MaxymVlasov
Copy link
Author

Looks like the AWS plugin not support Velero v1.5 yet, so examples stay for v1.4.

@MaxymVlasov MaxymVlasov requested a review from cpanato November 13, 2020 18:22
@nrb
Copy link
Contributor

nrb commented Nov 13, 2020

Looks like the AWS plugin not support Velero v1.5 yet, so examples stay for v1.4.

It does, I'll update the compatibility chart.

@MaxymVlasov
Copy link
Author

MaxymVlasov commented Nov 14, 2020

Okay, maybe it was another issue, because I try up and run 1.5.2 yesterday, after full removal of 1.4.2. but velero version not found Velero Server version at all, when Velero pod works fine and schedule triggered backup.

All that I changed - chart version to latest and tag to 1.5.2. All AWS infra was recreated from scratch, namespace deleted and recreated, velero client binary updated too.

@jenting jenting requested review from jenting and carlisia November 18, 2020 03:02
@carlisia
Copy link
Contributor

I love the intention of this PR and some things are useful, but replicating the documentation in this repo creates a maintenance burden because we will need to keep it in sync with the original documentation, and I'm not sure it buys us much. I'll take a closer look at this today.

@mkilchhofer
Copy link
Contributor

I'm sure not is it good to put an example in the released helm chart 🤔 or would it be good to add the examples to the README.

When the examples directory is ignored from packaging by adding it to the .helmignore file, this would be okay.

@MaxymVlasov
Copy link
Author

Added examples/ to .helmignore

charts/velero/examples/vsphere/secret.yaml Outdated Show resolved Hide resolved
charts/velero/examples/aws/secret.yaml Outdated Show resolved Hide resolved
@jenting
Copy link
Collaborator

jenting commented Mar 4, 2021

I love the intention of this PR and some things are useful, but replicating the documentation in this repo creates a maintenance burden because we will need to keep it in sync with the original documentation, and I'm not sure it buys us much. I'll take a closer look at this today.

@carlisia,
I'd prefer we could add these examples to https://github.com/vmware-tanzu/helm-charts/tree/main/charts/velero/ci
So, we could make sure these examples work well by CI testing.

@carlisia carlisia removed the request for review from cpanato April 23, 2021 01:02
ndegory pushed a commit to ndegory/helm-charts that referenced this pull request Jul 12, 2021
@carlisia carlisia removed their request for review September 28, 2021 16:26
@MaxymVlasov
Copy link
Author

Well, I think now it's completely outdated so there is no sense to keep that PR open

@MaxymVlasov MaxymVlasov deleted the improve_examples branch October 10, 2023 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation velero
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants