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

Update install docs to use velero install instead of in-tree YAML #952

Closed
skriss opened this issue Oct 18, 2018 · 6 comments · Fixed by #1287
Closed

Update install docs to use velero install instead of in-tree YAML #952

skriss opened this issue Oct 18, 2018 · 6 comments · Fixed by #1287
Assignees
Labels
Area/Documentation Enhancement/User End-User Enhancement to Velero
Milestone

Comments

@skriss
Copy link
Contributor

skriss commented Oct 18, 2018

The install docs for our various supported platforms sometimes differ from each other for no apparent reason. For example, for Azure we kubectl apply the entire example folder, whereas for GCP we don't.

Additionally, we have a legacy numbering scheme on our YAML files that probably isn't necessary anymore and may just lead to confusion/annoyance. Look at possibly removing that.

cc @carlisia

@skriss skriss added Area/Documentation Enhancement/User End-User Enhancement to Velero labels Oct 18, 2018
@rosskukulinski
Copy link
Contributor

Not saying we need to solve #52 at this time, but thought we should link the issues.

@carlisia
Copy link
Contributor

Good point. This ticket could be the organization phase of moving towards an install.

@nrb
Copy link
Contributor

nrb commented Dec 3, 2018

Looking at what I may do for #52, I'm thinking the following:

  • YAML examples will be entirely from the repository. If YAML is needed, users can run ark install --dry-run -o yaml (exact args and flags not necessarily final)
  • Each provider's install invocation will be with instructions for preparing the necessary provider-specific steps. I'm thinking that doing provider set up like creating buckets and IAM roles/policy is out of scope for ark install - it just focuses on creating the CRDs + necessary objects in the cluster, plus the deployment. I'm not sure if I care where that goes, in light of the larger docs refactor.

@Bradamant3 The two points above seem fairly minimal to me. I can discuss further, but I think those are my main concerns at the moment.

@Bradamant3
Copy link
Contributor

@nrb makes sense. Agree with the assumptions in the second point about scope for ark install. Helps a lot with planning content -- thanks!

@skriss skriss added this to the v0.12.0 milestone Feb 11, 2019
@skriss skriss modified the milestones: v0.12.0, v1.0.0 Apr 3, 2019
@skriss
Copy link
Contributor Author

skriss commented Apr 15, 2019

Now that we have velero install, we'll standardize by updating the install docs to use this command, and largely doing away with static sample YAML.

@skriss skriss changed the title Simplify/standardize install docs across platforms Update install docs to use velero install instead of in-tree YAML Apr 15, 2019
@skriss skriss reopened this Apr 15, 2019
@skriss
Copy link
Contributor Author

skriss commented Apr 24, 2019

Can we close this issue now?

@nrb nrb closed this as completed Apr 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area/Documentation Enhancement/User End-User Enhancement to Velero
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants