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

docs: Write guide for semi-complex multi-cluster tenancy repo structure #3505

Closed
Callisto13 opened this issue Mar 13, 2023 · 1 comment
Closed
Labels
documentation Improvements or additions to documentation

Comments

@Callisto13
Copy link
Contributor

Callisto13 commented Mar 13, 2023

Part of #3502

As a WG User
Who has a one management and one+ leaf clusters and a handful (~10) of objects (apps/kustomizations/etc)
I would like to read a guide which shows me how to organise my gitops repository
According to a hypothetical tenancy model

Elements to include:

  • An explanation of what the guide is for, why a user would want to follow it and a summary of the outcome
  • A complete list of prerequisites
    • what state does the cluster need to be in?
    • do i need to have set anything up outside the cluster?
    • is this guide for a development environment? or do i need a "real" env with network/dns/routing etc?
  • An intuitive journey through the steps
  • Yaml/command output collapsed so that the page is not saturated
  • Screenshots if applicable (zoom in on these please so they can actually be read)
  • Tested copy-pastable commands (such as those i would run to commit things to my gitops repo)
  • An example repository which shows the completed solution which users can easily clone and apply to their cluster if they want
@Callisto13 Callisto13 added the documentation Improvements or additions to documentation label Mar 13, 2023
@lasomethingsomething
Copy link
Contributor

Merged the ask with #3504 #3504

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
Projects
None yet
Development

No branches or pull requests

2 participants