Mark storage capacity as GA + related updates #32008

pohly · 2022-03-02T13:40:03Z

The feature is meant to graduate to GA in 1.24.

/hold

kubernetes/kubernetes#108445 needs to be merged first.

netlify · 2022-03-02T13:40:09Z

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

🔨 Explore the source changes: e86725d

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/622116f7f6bb9a0007e4e08d

sftim

Thanks for drafting this @pohly

I've added some inline feedback about showing what you need in order to use storage capacity tracking.

On top of the inline feedback, I suggest hyperlinking to https://kubernetes.io/docs/concepts/scheduling-eviction/ from the first mention of “scheduling”.

I also recommend omitting:

[Further work](https://github.com/kubernetes/enhancements/pull/1703) is needed to handle this automatically.

We actually avoid writing hints about future development in docs like this (one reason: as soon as that PR merges, the statement becomes partially incorrect). For beta and GA features, we try to get the docs reasonably close to our style guide.

sftim · 2022-03-02T14:52:15Z

content/en/docs/concepts/storage/storage-capacity.md

+Storage capacity tracking is a stable feature and always enabled in a
+Kubernetes cluster since Kubernetes 1.24. A CSI driver also has to support
 it. Please refer to the driver's documentation for details.


Suggested change

Storage capacity tracking is a stable feature and always enabled in a

Kubernetes cluster since Kubernetes 1.24. A CSI driver also has to support

it. Please refer to the driver's documentation for details.

Kubernetes v{{< skew currentVersion >}} includes cluster-level API support for storage

capacity tracking. To use this you must also be using a CSI driver that supports capacity

tracking. Consult the documentation for the CSI drivers that you use to find out whether

this support is available and, if so, how to use it.

If you are not running Kubernetes v{{< skew currentVersion >}}, check the documentation

for that version of Kubernetes.

I would however also move this particular section to the start of the page (just before ) and change the heading to read:

## {{% heading "prerequisites" %}}

You can then also reword or remove:

Tracking storage capacity is supported for {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} (CSI) drivers and [needs to be enabled](#enabling-storage-capacity-tracking) when installing a CSI driver.

pohly · 2022-03-03T10:30:56Z

On top of the inline feedback, I suggest hyperlinking to https://kubernetes.io/docs/concepts/scheduling-eviction/ from the first mention of “scheduling”.

Done. There was a link to the scheduler under "further reading" which I removed because now it already gets introduced early on.

I also recommend omitting Further work is needed[...]

Done.

I would however also move this particular section to the start of the page

Done. I hope I understood correctly where the subheading needs to go.

The previous split came about because enabling was more complicated. I agree that we can simplify that now.

An unrelated change is a new link to the CSIStorageCapacity object. That link should become valid once the code PR is merged and the corresponding documentation is public.

sftim · 2022-03-03T13:21:15Z

content/en/docs/concepts/storage/storage-capacity.md

+## {{% heading "prerequisites" %}}
+
+Kubernetes v{{< skew currentVersion >}} includes cluster-level API support for
+storage capacity tracking. To use this you must also be using a CSI driver that
+supports capacity tracking. Consult the documentation for the CSI drivers that
+you use to find out whether this support is available and, if so, how to use
+it. If you are not running Kubernetes v{{< skew currentVersion >}}, check the
+documentation for that version of Kubernetes.


Looks good, thanks.

sftim · 2022-03-03T13:21:51Z

content/en/docs/concepts/storage/storage-capacity.md


 <!-- body -->

 ## API

 There are two API extensions for this feature:
- CSIStorageCapacity objects:
+- [CSIStorageCapacity](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#csistoragecapacity-v1-storage-k8s-io) objects:


This links to the legacy API reference. It'd be nice to link to a page within https://kubernetes.io/docs/reference/kubernetes-api/ instead.

Link should be https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/csi-storage-capacity/

Looking at the other, already valid links there's a -v1 missing. Will add that.

Should the link have the https://kubernetes.io prefix or start with /docs?

In the Markdown, start links to documentation with /docs/

https://kubernetes.io/docs/contribute/style/style-guide/#links has an example.

Done. I also updated the link for CSIDriver (same bullet list).

sftim · 2022-03-03T14:45:11Z

/retitle Mark storage capacity as GA + related updates

mehabhalodiya · 2022-03-19T11:31:11Z

/assign @PI-Victor
enhancement ref: kubernetes/enhancements#1472

pohly · 2022-03-23T16:15:37Z

/hold cancel

The code PR was merged. Feel free to merge this one here.

tengqm · 2022-03-24T00:05:18Z

/lgtm

k8s-ci-robot · 2022-03-24T00:05:37Z

LGTM label has been added.

Git tree hash: 8cf3168dc34a4ee8e8ae33bb6b2d769933965363

mehabhalodiya · 2022-03-24T01:55:46Z

/cc @nate-double-u

mehabhalodiya · 2022-03-25T10:20:03Z

/sig storage

xing-yang · 2022-03-25T13:27:24Z

/lgtm

xing-yang · 2022-03-25T13:27:51Z

/approve

tengqm · 2022-03-25T14:01:56Z

/approve

nate-double-u · 2022-03-25T16:55:54Z

/approve

alvaroaleman · 2022-03-25T17:31:35Z

/approve

k8s-ci-robot · 2022-03-25T17:32:06Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, nate-double-u, tengqm, xing-yang

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [nate-double-u,tengqm]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added this to the 1.24 milestone Mar 2, 2022

k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 2, 2022

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 2, 2022

k8s-ci-robot requested review from kbhawkey and msau42 March 2, 2022 13:40

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Mar 2, 2022

pohly mentioned this pull request Mar 2, 2022

Storage Capacity Tracking kubernetes/enhancements#1472

Closed

4 tasks

sftim reviewed Mar 2, 2022

View reviewed changes

pohly force-pushed the storage-capacity-ga branch from 10ae184 to 950226b Compare March 3, 2022 10:31

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 3, 2022

sftim reviewed Mar 3, 2022

View reviewed changes

k8s-ci-robot changed the title ~~storage capacity GA~~ Mark storage capacity as GA + related updates Mar 3, 2022

storage capacity: graduate to GA

e86725d

pohly force-pushed the storage-capacity-ga branch from 950226b to e86725d Compare March 3, 2022 19:28

k8s-ci-robot assigned PI-Victor Mar 19, 2022

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 23, 2022

k8s-ci-robot assigned tengqm Mar 24, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 24, 2022

k8s-ci-robot requested a review from nate-double-u March 24, 2022 01:55

k8s-ci-robot added the sig/storage Categorizes an issue or PR as relevant to SIG Storage. label Mar 25, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 25, 2022

k8s-ci-robot merged commit 900c849 into kubernetes:dev-1.24 Mar 25, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mark storage capacity as GA + related updates #32008

Mark storage capacity as GA + related updates #32008

pohly commented Mar 2, 2022

netlify bot commented Mar 2, 2022 •

edited

Loading

sftim left a comment

sftim Mar 2, 2022

pohly commented Mar 3, 2022

sftim Mar 3, 2022

sftim Mar 3, 2022

sftim Mar 3, 2022

pohly Mar 3, 2022

sftim Mar 3, 2022

pohly Mar 3, 2022

sftim commented Mar 3, 2022

mehabhalodiya commented Mar 19, 2022 •

edited

Loading

pohly commented Mar 23, 2022

tengqm commented Mar 24, 2022

k8s-ci-robot commented Mar 24, 2022

mehabhalodiya commented Mar 24, 2022

mehabhalodiya commented Mar 25, 2022

xing-yang commented Mar 25, 2022

xing-yang commented Mar 25, 2022

tengqm commented Mar 25, 2022

nate-double-u commented Mar 25, 2022

alvaroaleman commented Mar 25, 2022

k8s-ci-robot commented Mar 25, 2022

-Storage capacity tracking is a stable feature and always enabled in a
-Kubernetes cluster since Kubernetes 1.24. A CSI driver also has to support
-it. Please refer to the driver's documentation for details.
+Kubernetes v{{< skew currentVersion >}} includes cluster-level API support for storage
+capacity tracking. To use this you must also be using a CSI driver that supports capacity
+tracking. Consult the documentation for the CSI drivers that you use to find out whether
+this support is available and, if so, how to use it.
+If you are not running Kubernetes v{{< skew currentVersion >}}, check the documentation
+for that version of Kubernetes.

Mark storage capacity as GA + related updates #32008

Mark storage capacity as GA + related updates #32008

Conversation

pohly commented Mar 2, 2022

netlify bot commented Mar 2, 2022 • edited Loading

sftim left a comment

Choose a reason for hiding this comment

sftim Mar 2, 2022

Choose a reason for hiding this comment

pohly commented Mar 3, 2022

sftim Mar 3, 2022

Choose a reason for hiding this comment

sftim Mar 3, 2022

Choose a reason for hiding this comment

sftim Mar 3, 2022

Choose a reason for hiding this comment

pohly Mar 3, 2022

Choose a reason for hiding this comment

sftim Mar 3, 2022

Choose a reason for hiding this comment

pohly Mar 3, 2022

Choose a reason for hiding this comment

sftim commented Mar 3, 2022

mehabhalodiya commented Mar 19, 2022 • edited Loading

pohly commented Mar 23, 2022

tengqm commented Mar 24, 2022

k8s-ci-robot commented Mar 24, 2022

mehabhalodiya commented Mar 24, 2022

mehabhalodiya commented Mar 25, 2022

xing-yang commented Mar 25, 2022

xing-yang commented Mar 25, 2022

tengqm commented Mar 25, 2022

nate-double-u commented Mar 25, 2022

alvaroaleman commented Mar 25, 2022

k8s-ci-robot commented Mar 25, 2022

netlify bot commented Mar 2, 2022 •

edited

Loading

mehabhalodiya commented Mar 19, 2022 •

edited

Loading