kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.48k stars 14.4k forks source link

Plan improvements to Storage concepts #45873

Open sftim opened 6 months ago

sftim commented 6 months ago

This is a Feature Request

What would you like to be added?

The work to do here is unusual. Rather than making pull requests, your first job is to make some more issues, about improvements to how we explain Kubernetes storage management.

This issue is done when we have a set of issues opened that describe a series of approachable issues that each propose a useful improvement to storage concepts.

Aim to plan out the set of issues so that they are mostly settled before opening the first of those approachable, single-improvement-at-a-time issues.

Why is this needed

The existing storage pages are not easy to understand, and the issues we have open are not very approachable. We might:

:information_source: try not to directly work on PRs for this issue; instead, start on making a complete set of storage-related issues, close this one off because it is done, and then work on each issue on turn.

It is OK to make an umbrella issue to act as a successor for this issue.

Selected existing pages

and associated tasks (in case we want to link to them):

sftim commented 6 months ago

/triage accepted /lifecycle frozen /priority important-longterm

sftim commented 6 months ago

Also see:

network-charles commented 6 months ago

I'm glad you brought this issue up, @sftim. I struggled through the docs while learning about storage concepts. For example, while attempting to provision a static local persistent volume, hence binding my persistent volume claim to my persistent volume, the docs only mentioned using a selector for binding, but they didn't explicitly specify that a volumeName could also be used. Plus, no proper example exists for each access mode. It will be nice to add one to the new task page. You could assign it to me if you think these few suggestions make sense.

Summary

  1. Add an example on the new task page titled "Configure a Pod to Use a Static Local Persistent Volume and ReadWriteOnce Access Mode"
  2. Add a subsection under "PersistentVolumeClaims" titled volumeName since it exists on the reference page.