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

Document all filesystem directories k0s uses #4910

Open
jnummelin opened this issue Aug 29, 2024 · 1 comment
Open

Document all filesystem directories k0s uses #4910

jnummelin opened this issue Aug 29, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jnummelin
Copy link
Member

We need to document the directories k0s puts data on. Also/especially from the point of view which ones are affected by --data-dir option.

There's some confusions on where k0s puts which things, for example #3508 and #1842

For each dir k0s uses, we should document at least:

  • what's here
  • why here
  • does --data-dir affect this
@jnummelin jnummelin added the documentation Improvements or additions to documentation label Aug 29, 2024
@twz123
Copy link
Member

twz123 commented Sep 6, 2024

When documenting this, it should be clear which folders are intended to be used by k0s users, i.e., which of them are subject to the semver guarantees, and which of them are considered internal and may change without notice.

@jnummelin jnummelin added this to the 1.32 milestone Sep 13, 2024
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