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

1.29 - Add a blog post about VolumeAttributesClass #43777

Merged
merged 3 commits into from Dec 13, 2023

Conversation

sunnylovestiramisu
Copy link
Contributor

@sunnylovestiramisu sunnylovestiramisu commented Nov 1, 2023

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 1, 2023
@k8s-ci-robot k8s-ci-robot added the area/blog Issues or PRs related to the Kubernetes Blog subproject label Nov 1, 2023
@k8s-ci-robot 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 Nov 1, 2023
Copy link

netlify bot commented Nov 1, 2023

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 0daa5df
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/657202c5a273db0008d43ace
😎 Deploy Preview https://deploy-preview-43777--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 13, 2023
@krol3
Copy link
Contributor

krol3 commented Nov 15, 2023

Hi @sunnylovestiramisu! , Here the communications 1.29 Team, the deadline to the feature blog be ready to review is this Friday, Nov 17th, the proposal publish date will be Dec 15th. cc: @a-mccarthy @kcmartin @James-Quigley

@sunnylovestiramisu sunnylovestiramisu changed the title [WIP] Add a blog post about VolumeAttributesClass Add a blog post about VolumeAttributesClass Nov 15, 2023
@k8s-ci-robot 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 Nov 15, 2023
@sunnylovestiramisu
Copy link
Contributor Author

@krol3 We's like to post the blog post in mid Dec ish probably around Dec 15th? What do you think?

@krol3
Copy link
Contributor

krol3 commented Nov 15, 2023

@krol3 We's like to post the blog post in mid Dec ish probably around Dec 15th? What do you think?

Scheduled it! Thanks @sunnylovestiramisu 🙏🏾

@kcmartin
Copy link
Contributor

kcmartin commented Nov 17, 2023

@sunnylovestiramisu 1.29 Comms Team here! The blog format requires that you add the following to the beginning of the file:

layout: blog
title: "Kubernetes 1.29: VolumeAttributesClass for Volume Modification"
date: 2023-11-15
slug: kubernetes-1-29-volume-attributes-class
---

**Author:** Sunny Song (Google)```

@@ -0,0 +1,162 @@
# Kubernetes v1.29: VolumeAttributesClass for Volume Modification
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comment about the correct formatting for the blog post

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated base on comments: 3367a87


**Authors**: Sunny Song(Google)

The v1.29 release of Kubernetes introduced an alpha feature to support modify volume by changing VolumeAttributesClass that was assigned to a PersistentVolumeClaim (PVC). With the feature enabled, Kubernetes can handle updates of volume attributes other than capacity. Allowing volume attributes to be changed without managing it through different provider's APIs directly simplifies the current flow.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The v1.29 release of Kubernetes introduced an alpha feature to support modify volume by changing VolumeAttributesClass that was assigned to a PersistentVolumeClaim (PVC). With the feature enabled, Kubernetes can handle updates of volume attributes other than capacity. Allowing volume attributes to be changed without managing it through different provider's APIs directly simplifies the current flow.
The v1.29 release of Kubernetes introduced an alpha feature to support modify volume
by changing VolumeAttributesClass that was assigned to a PersistentVolumeClaim (PVC).
With the feature enabled, Kubernetes can handle updates of volume attributes other than capacity.
Allowing volume attributes to be changed without managing it through different
provider's APIs directly simplifies the current flow.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in: 3367a87

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

by changing VolumeAttributesClass that was assigned to a PersistentVolumeClaim (PVC).

It maybe misunderstand by users how to change the volume attributes of a PVC. It should be changed the reference of the PVC's volume attributes class by editing the PVC's spec.volumeAttributesClassName field, not the VolumeAttributesClass itself.

cc @Ritikaa96 @sunnylovestiramisu


* See the [VolumeAttributesClass KEP](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/3751-volume-attributes-class) for more information on the design
* You can view or comment on the [project board](https://github.com/orgs/kubernetes-csi/projects/72) for VolumeAttributesClass
* In order to move this feature towards beta, we need feedback from the community, so here's a call to action: add support to the CSI drivers, try out this feature, consider how it can help with problems that your users are having…
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* In order to move this feature towards beta, we need feedback from the community, so here's a call to action: add support to the CSI drivers, try out this feature, consider how it can help with problems that your users are having…
* In order to move this feature towards beta, we need feedback from the community,
so here's a call to action: add support to the CSI drivers, try out this feature,
consider how it can help with problems that your users are having…


## How to use it

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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 relevant feature gate
in the kube-controller-manager and the kube-apiserver. Use the --feature-gates command line argument:

@tengqm
Copy link
Contributor

tengqm commented Nov 20, 2023

Do we have some more formal docs under /content/en/docs for this VolumeAttributesClass thing?

@sunnylovestiramisu
Copy link
Contributor Author

sunnylovestiramisu commented Nov 20, 2023

Docs PR in: #43463


## VolumeAttributesClass

The new resource.k8s.io/v1alpha1 API group provides two new types:
Copy link
Member

@carlory carlory Nov 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

resource.k8s.io/v1alpha1 is not correct.

VolumeAttributesClass API belongs to storage.k8s.io/v1alpha1.

PVC belongs to core/v1.

Copy link
Contributor

@Ritikaa96 Ritikaa96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few nits

```


It also requires the CSI driver has implemented the ModifyVolume API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It also requires the CSI driver has implemented the ModifyVolume API.
It also requires that the CSI driver has implemented the ModifyVolume API.


### User Flow

If you would like to see the feature in action and verify it works fine in your cluster here's what you can try:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you would like to see the feature in action and verify it works fine in your cluster here's what you can try:
If you would like to see the feature in action and verify it works fine in your cluster, here's what you can try:


## Getting involved

We always welcome new contributors so if you would like to get involved you can join our [Kubernetes Storage Special-Interest-Group](https://github.com/kubernetes/community/tree/master/sig-storage) (SIG).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We always welcome new contributors so if you would like to get involved you can join our [Kubernetes Storage Special-Interest-Group](https://github.com/kubernetes/community/tree/master/sig-storage) (SIG).
We always welcome new contributors. So, if you would like to get involved, you can join our [Kubernetes Storage Special-Interest-Group](https://github.com/kubernetes/community/tree/master/sig-storage) (SIG).

provider's APIs directly simplifies the current flow.

You can read VolumeAttributesClass in the Kubernetes documentation for more details
about how to use that, or you can read on to learn about why the Kubernetes project is supporting this feature.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
about how to use that, or you can read on to learn about why the Kubernetes project is supporting this feature.
or you can read on to learn about why the Kubernetes project is supporting this feature.

@sunnylovestiramisu
Copy link
Contributor Author

@sftim Changed date to Dec 15th.

@sftim sftim dismissed their stale review December 5, 2023 17:10

Review was stale

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

I recommend some whitespace changes.

Comment on lines 149 to 150
```yaml
kubectl describe pvc <PVC_NAME>
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please indent all of the non-blank lines by three spaces.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just a command, it should not be yaml actually. Let me correct that.

@sunnylovestiramisu
Copy link
Contributor Author

@sftim updated the PR again.

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Markdown looks right. Thanks for putting the time in on this article @sunnylovestiramisu.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 7, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 60cbd2a3828875173b82d5e24127a0e1c0484820

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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:

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 7, 2023
@sftim
Copy link
Contributor

sftim commented Dec 7, 2023

/label tide/merge-method-squash
Once Now this has an LGTM label, it's helpful if you squash it to 1 commit (it is OK to keep the same tree; in fact, that helps)

We can remove that label (tide/merge-method-squash) once this is only 1 commit. It's also OK to merge this PR just as it is.

🛑 Do not merge until Kubernetes v1.29 is released 🛑

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Dec 7, 2023
@sftim
Copy link
Contributor

sftim commented Dec 13, 2023

/remove-label tide/merge-method-squash
(it's fine)

/hold cancel

@k8s-ci-robot k8s-ci-robot removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. labels Dec 13, 2023
@k8s-ci-robot k8s-ci-robot merged commit e0e08b7 into kubernetes:main Dec 13, 2023
6 checks passed
@sunnylovestiramisu sunnylovestiramisu changed the title Add a blog post about VolumeAttributesClass 1.29 - Add a blog post about VolumeAttributesClass Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/blog Issues or PRs related to the Kubernetes Blog subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Status: Published
Development

Successfully merging this pull request may close these issues.

None yet

8 participants