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

Update Quobyte StorageClass reference #27645

Closed
wants to merge 1 commit into from

Conversation

venkatsc
Copy link
Contributor

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

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.
@k8s-ci-robot k8s-ci-robot added this to the 1.22 milestone Apr 21, 2021
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 21, 2021
@k8sio-netlify-preview-bot
Copy link
Collaborator

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit d65735a

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/607ff0231ec6d00007d12320

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 21, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign zacharysarah after the PR has been reviewed.
You can assign the PR to them by writing /assign @zacharysarah in a comment when ready.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Apr 21, 2021
@k8s-ci-robot k8s-ci-robot requested review from msau42 and thockin April 21, 2021 09:28
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Apr 21, 2021
@venkatsc
Copy link
Contributor Author

/assign @sftim

@kbhawkey
Copy link
Contributor

/cc @PI-Victor

@k8s-ci-robot k8s-ci-robot requested a review from PI-Victor April 22, 2021 01:13
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.

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.

@k8s-ci-robot 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 Apr 22, 2021
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 21, 2021
@reylejano
Copy link
Member

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 22, 2021
@reylejano
Copy link
Member

@kubernetes/sig-storage-pr-reviews , ptal at @sftim's comment:

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.
...
because we should not remove documentation for features that remain present.

@jsafrane
Copy link
Member

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.

@PI-Victor
Copy link
Member

@venkatsc can you please address the above comments?

@sftim
Copy link
Contributor

sftim commented Jul 26, 2021

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?

@xing-yang
Copy link
Contributor

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?

@xing-yang
Copy link
Contributor

xing-yang commented Jul 28, 2021

@venkatsc shouldn't this be removed? https://github.com/kubernetes/kubernetes/blob/v1.23.0-alpha.0/pkg/apis/core/types.go#L107
Are there any deprecation messages in the release notes before the in-tree plugin becomes unsupported?

@sftim
Copy link
Contributor

sftim commented Jul 28, 2021

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

Copy link
Contributor

Choose a reason for hiding this comment

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

If deprecating this, try:

Suggested change
{{< 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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good.

@xing-yang
Copy link
Contributor

Okay, I see that deprecation message is already added in this PR for v1.22:
kubernetes/kubernetes#101773

@xing-yang
Copy link
Contributor

We also need to add a note for "quobyte" volume type under the following section that the in-tree driver is deprecated:
https://kubernetes.io/docs/concepts/storage/persistent-volumes/#types-of-persistent-volumes

* `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)
Copy link
Contributor

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.

@PI-Victor
Copy link
Member

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?

@PI-Victor
Copy link
Member

/close
in favor of #29144

@k8s-ci-robot
Copy link
Contributor

@PI-Victor: Closed this PR.

In response to this:

/close
in favor of #29144

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/storage Categorizes an issue or PR as relevant to SIG Storage. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants