-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
Update Quobyte StorageClass reference #27645
Conversation
Quobyte no longer recommends usage of in-tree plugin, instead uses CSI driver. The current StorageClass example is based on the in-tree plugin and out-dated. This patch points to the example StorageClass available at the Quobyte CSI repository.
Deploy preview for kubernetes-io-vnext-staging processing. Building with commit d65735a https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/607ff0231ec6d00007d12320 |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/assign @sftim |
/cc @PI-Victor |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this review repeats comments from #27631 (review)
/sig storage
Even [if / though] the quobyte provider is deprecated, we should still document it as it is one of the in-tree storage providers until it is removed.
It is OK to add a callout to explain there is a recommended alternative.
/hold
because we should not remove documentation for features that remain present.
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-contributor-experience at kubernetes/community. |
/remove-lifecycle stale |
@kubernetes/sig-storage-pr-reviews , ptal at @sftim's comment:
|
I think @sftim's comment is accurate. We should document that in-tree Quobyte API still exists, mention it's deprecated and point users to CSI. |
@venkatsc can you please address the above comments? |
If necessary, could someone from SIG Storage (or, at a pinch, SIG Docs) open a new equivalent PR that takes account of feedback so far? |
@sftim Where should we document that in-tree Quobyte API still exists, mention it's deprecated and point users to CSI? Should that be part of this PR? |
@venkatsc shouldn't this be removed? https://github.com/kubernetes/kubernetes/blob/v1.23.0-alpha.0/pkg/apis/core/types.go#L107 |
If SIG Storage are planning to deprecate the in-tree Quobyte storage mechanism, then some PR for the v1.22 docs should update the documentation to say so. It can be this PR or a different PR. Also that will need a tech review from SIG Storage to confirm the deprecation. (My opinion: if we don't document it as deprecated,we should defer the removal by an extra release for each release where we missed out documenting the deprecation) |
@@ -548,52 +548,8 @@ parameters: | |||
|
|||
### Quobyte | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If deprecating this, try:
{{< feature-state for_k8s_version="v1.22" state="deprecated" >}} | |
The Quobyte storage plugin is deprecated. |
and then leave in the docs about how to use it, unless there's a strong reason to remove them early.
When we remove in-tree Quobyte support, we can delete this section entirely.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good.
Okay, I see that deprecation message is already added in this PR for v1.22: |
We also need to add a note for "quobyte" volume type under the following section that the in-tree driver is deprecated: |
* `quobyteTenant`: use the specified tenant ID to create/delete the volume. | ||
This Quobyte tenant has to be already present in Quobyte. | ||
Default is "DEFAULT". | ||
An [example](https://github.com/quobyte/quobyte-csi/blob/master/example/StorageClass.yaml) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keep the above in-tree example for now. Remove this section when the in-tree driver code is removed. We normally have to wait a year after it is deprecated before removing the code. You can add a link to the CSI driver repo.
without any feedback whatsoever from the original PR owner, and due to the fact that this was opened back in April, i suggest we move this to a new PR. Anyone from sig-storage wanna tackle this or should i open one? |
/close |
@PI-Victor: Closed this PR. In response to this:
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. |
Quobyte no longer recommends usage of in-tree plugin, instead
uses CSI driver. The current StorageClass example is based
on the in-tree plugin and out-dated. This patch points to the
example StorageClass available at the Quobyte CSI repository.
In response to #27631 (comment), posting it on
dev-1.22
branch