Add docs about VolumeAttributesClass API (KEP-3751) #43463

sunnylovestiramisu · 2023-10-13T00:30:56Z

netlify · 2023-10-13T00:31:04Z

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

Name	Link
🔨 Latest commit	`058e522`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/65667ce5e299fe0008a29f84

sftim · 2023-10-13T10:28:30Z

/retitle [WIP] Add post-release blog article about VolumeAttributesClass KEP-3751
/sig storage

/hold
If this PR is adding a blog article, it should target main and be held until after the release (reviews and approval should happen in the meantime)

sunnylovestiramisu · 2023-10-16T16:37:32Z

@sftim The instruction link I got says create an PR against dev-1.29, it this not the case anymore? Can you send me the correct documentaion?

sftim · 2023-10-16T18:13:14Z

The instruction link I got says create an PR against dev-1.29, it this not the case anymore? Can you send me the correct documentaion?

You can turn this into a documentation PR, in which case the branch is right but the path is wrong: change content/en/docs/* not content/en/blog/* (and the PR title). Then force-push.

Right now this has a mismatch because it changes a blog path. PRs that add blog articles never go on release branches.

sunnylovestiramisu · 2023-10-16T21:49:19Z

@sftim which folder under docs I should post for a new feature? The structure is not clear to me. Does concepts/storage make sense?

xing-yang · 2023-10-17T14:05:41Z

@sunnylovestiramisu I think you just need to rename the title of this PR. It says "Add post-release blog article about VolumeAttributesClass KEP-3751". Just change that to "Add doc about VolumeAttributesClass KEP-3751".

xing-yang · 2023-10-17T14:39:11Z

It looks like "area/blog" label was added by the bot automatically probably because "blog" is in the PR title.

/area blog cancel

k8s-ci-robot · 2023-10-17T14:39:13Z

@xing-yang: The label(s) area/cancel cannot be applied, because the repository doesn't have them.

In response to this:

It looks like "area/blog" label was added by the bot automatically probably because "blog" is in the PR title.

/area blog cancel

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

xing-yang · 2023-10-17T14:45:50Z

/remove-area blog

sftim · 2023-10-17T14:50:38Z

/retitle [WIP] Add docs about VolumeAttributesClass API (KEP-3751)

drewhagen · 2023-11-28T23:24:18Z

/lgtm

k8s-ci-robot · 2023-11-28T23:24:26Z

LGTM label has been added.

Git tree hash: fd3e6d8eadcff001adcda87c1fd20d30ecd02009

saad-ali

/lgtm
/approve

Thanks @sunnylovestiramisu for the hard work on this!

drewhagen · 2023-11-28T23:43:58Z

/lgtm

k8s-ci-robot · 2023-11-28T23:44:05Z

LGTM label has been added.

Git tree hash: c00480cfffdfba536a910b64a70bb96cc0de4438

sftim

Some more feedback

sftim · 2023-11-28T23:38:54Z

content/en/docs/concepts/storage/volume-attributes-classes.md

+If you want to test the feature whilst it's alpha, you need to enable the relevant feature gate
+in the kube-controller-manager and the kube-apiserver. Use the --feature-gates command line argument:


Suggested change

If you want to test the feature whilst it's alpha, you need to enable the relevant feature gate

in the kube-controller-manager and the kube-apiserver. Use the --feature-gates command line argument:

If you want to test the feature whilst it's alpha, you need to enable the `VolumeAttributesClass`

[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) for the kube-controller-manager and the kube-apiserver. You use the `--feature-gates` command line argument:

sftim · 2023-11-28T23:40:01Z

content/en/docs/concepts/storage/volume-attributes-classes.md

+--feature-gates="...,VolumeAttributesClass=true"
+```
+
+It also requires the CSI driver has implemented the ModifyVolume API.


Suggested change

It also requires the CSI driver has implemented the ModifyVolume API.

You can also only use VolumeAttributesClasses with storage backed by

{{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}}, and only where the

relevant CSI driver implements the `ModifyVolume` API.

sftim · 2023-11-28T23:40:47Z

content/en/docs/reference/command-line-tools-reference/feature-gates.md

@@ -816,6 +817,7 @@ Each feature gate is designed for enabling/disabling a specific feature:
  support for CEL validations be used in Admission Control.
 - `VolumeCapacityPriority`: Enable support for prioritizing nodes in different
  topologies based on available PV capacity.
+- `VolumeAttributesClass`: Enable support for VolumeAttributesClass


(nit)

Suggested change

- `VolumeAttributesClass`: Enable support for VolumeAttributesClass

- `VolumeAttributesClass`: Enable support for VolumeAttributesClasses.

See [Volume Attributes Classes](/docs/concepts/storage/volume-attributes-classes/)

for more information.

content/en/docs/concepts/storage/volume-attributes-classes.md

sftim · 2023-11-28T23:46:15Z

/approve

This PR already exceeds our docs quality expectations for alpha features.

k8s-ci-robot · 2023-11-28T23:47:32Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: saad-ali, sftim

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~~ [sftim]

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

drewhagen · 2023-11-28T23:52:10Z

/lgtm

k8s-ci-robot · 2023-11-28T23:52:17Z

LGTM label has been added.

Git tree hash: 0f3550578724c8ccacc8d0ed8f8a6451b9a951f4

drewhagen · 2023-11-29T00:04:14Z

Great work today!! As a frequent reader of the Kubernetes docs, thank you for your quality contribution 😄

k8s-ci-robot added this to the 1.29 milestone Oct 13, 2023

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 13, 2023

k8s-ci-robot requested review from nate-double-u and onlydole October 13, 2023 00:31

k8s-ci-robot added area/blog Issues or PRs related to the Kubernetes Blog subproject language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 13, 2023

sunnylovestiramisu changed the title ~~Add Placeholder for VolumeAttributesClass KEP-3751~~ [WIP] Add Placeholder for VolumeAttributesClass KEP-3751 Oct 13, 2023

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 13, 2023

sunnylovestiramisu mentioned this pull request Oct 13, 2023

Kubernetes VolumeAttributesClass ModifyVolume kubernetes/enhancements#3751

Open

11 tasks

k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. sig/storage Categorizes an issue or PR as relevant to SIG Storage. labels Oct 13, 2023

k8s-ci-robot changed the title ~~[WIP] Add Placeholder for VolumeAttributesClass KEP-3751~~ [WIP] Add post-release blog article about VolumeAttributesClass KEP-3751 Oct 13, 2023

sunnylovestiramisu force-pushed the dev-1.29 branch from 1a6c401 to 3a16a18 Compare October 16, 2023 21:54

sunnylovestiramisu changed the title ~~[WIP] Add post-release blog article about VolumeAttributesClass KEP-3751~~ Add post-release blog article about VolumeAttributesClass KEP-3751 Oct 16, 2023

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 16, 2023

k8s-ci-robot removed the area/blog Issues or PRs related to the Kubernetes Blog subproject label Oct 17, 2023

k8s-ci-robot changed the title ~~Add post-release blog article about VolumeAttributesClass KEP-3751~~ [WIP] Add docs about VolumeAttributesClass API (KEP-3751) Oct 17, 2023

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 17, 2023

Update Based on Comments - Nov 27

b90698e

sunnylovestiramisu force-pushed the dev-1.29 branch from 2809a5c to 03bc782 Compare November 28, 2023 23:15

k8s-ci-robot assigned drewhagen Nov 28, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2023

saad-ali approved these changes Nov 28, 2023

View reviewed changes

k8s-ci-robot assigned saad-ali Nov 28, 2023

sunnylovestiramisu force-pushed the dev-1.29 branch from 03bc782 to ba6f6c3 Compare November 28, 2023 23:42

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2023

k8s-ci-robot requested review from drewhagen, saad-ali and sftim November 28, 2023 23:42

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2023

sftim reviewed Nov 28, 2023

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 28, 2023

Update Based on Comments - Nov 28

058e522

sunnylovestiramisu force-pushed the dev-1.29 branch from ba6f6c3 to 058e522 Compare November 28, 2023 23:50

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2023

k8s-ci-robot requested a review from sftim November 28, 2023 23:51

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2023

k8s-ci-robot merged commit a3351b5 into kubernetes:dev-1.29 Nov 28, 2023
6 checks passed

sunnylovestiramisu mentioned this pull request Nov 30, 2023

1.29 - website: add volumeattributesclass doc kubernetes-csi/docs#576

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs about VolumeAttributesClass API (KEP-3751) #43463

Add docs about VolumeAttributesClass API (KEP-3751) #43463

sunnylovestiramisu commented Oct 13, 2023 •

edited

netlify bot commented Oct 13, 2023 •

edited

sftim commented Oct 13, 2023

sunnylovestiramisu commented Oct 16, 2023

sftim commented Oct 16, 2023

sunnylovestiramisu commented Oct 16, 2023 •

edited

xing-yang commented Oct 17, 2023

xing-yang commented Oct 17, 2023

k8s-ci-robot commented Oct 17, 2023

xing-yang commented Oct 17, 2023

sftim commented Oct 17, 2023

drewhagen commented Nov 28, 2023

k8s-ci-robot commented Nov 28, 2023

saad-ali left a comment

drewhagen commented Nov 28, 2023

k8s-ci-robot commented Nov 28, 2023

sftim left a comment

sftim Nov 28, 2023

sftim Nov 28, 2023

sftim Nov 28, 2023

sftim commented Nov 28, 2023

k8s-ci-robot commented Nov 28, 2023

drewhagen commented Nov 28, 2023

k8s-ci-robot commented Nov 28, 2023

drewhagen commented Nov 29, 2023

		If you want to test the feature whilst it's alpha, you need to enable the relevant feature gate
		in the kube-controller-manager and the kube-apiserver. Use the --feature-gates command line argument:

-It also requires the CSI driver has implemented the ModifyVolume API.
+You can also only use VolumeAttributesClasses with storage backed by
+{{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}}, and only where the
+relevant CSI driver implements the `ModifyVolume` API.

-- `VolumeAttributesClass`: Enable support for VolumeAttributesClass
+- `VolumeAttributesClass`: Enable support for VolumeAttributesClasses.
+  See [Volume Attributes Classes](/docs/concepts/storage/volume-attributes-classes/)
+  for more information.

Add docs about VolumeAttributesClass API (KEP-3751) #43463

Add docs about VolumeAttributesClass API (KEP-3751) #43463

Conversation

sunnylovestiramisu commented Oct 13, 2023 • edited

netlify bot commented Oct 13, 2023 • edited

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

sftim commented Oct 13, 2023

sunnylovestiramisu commented Oct 16, 2023

sftim commented Oct 16, 2023

sunnylovestiramisu commented Oct 16, 2023 • edited

xing-yang commented Oct 17, 2023

xing-yang commented Oct 17, 2023

k8s-ci-robot commented Oct 17, 2023

xing-yang commented Oct 17, 2023

sftim commented Oct 17, 2023

drewhagen commented Nov 28, 2023

k8s-ci-robot commented Nov 28, 2023

saad-ali left a comment

Choose a reason for hiding this comment

drewhagen commented Nov 28, 2023

k8s-ci-robot commented Nov 28, 2023

sftim left a comment

Choose a reason for hiding this comment

sftim Nov 28, 2023

Choose a reason for hiding this comment

sftim Nov 28, 2023

Choose a reason for hiding this comment

sftim Nov 28, 2023

Choose a reason for hiding this comment

sftim commented Nov 28, 2023

k8s-ci-robot commented Nov 28, 2023

drewhagen commented Nov 28, 2023

k8s-ci-robot commented Nov 28, 2023

drewhagen commented Nov 29, 2023

sunnylovestiramisu commented Oct 13, 2023 •

edited

netlify bot commented Oct 13, 2023 •

edited

sunnylovestiramisu commented Oct 16, 2023 •

edited