Annotation `storage.alpha.kubernetes.io/migrated-plugins` not registered / documented

kubernetes / website

Kubernetes website and documentation repo:

https://kubernetes.io

Creative Commons Attribution 4.0 International

4.44k stars 14.28k forks source link

Annotation `storage.alpha.kubernetes.io/migrated-plugins` not registered / documented #36194

Closed sftim closed 1 month ago

sftim commented 2 years ago

This is a Bug Report

Problem: Kubernetes can set an annotation, storage.alpha.kubernetes.io/migrated-plugins, but this is not registered or documented.

Proposed Solution: Document the annotation in Well-Known Labels, Annotations and Taints.

Page to Update: https://kubernetes.io/docs/reference/labels-annotations-taints/

Additional Information: /sig storage /language en

afzal442 commented 2 years ago

/assign

afzal442 commented 2 years ago

/triage accepted

k8s-ci-robot commented 2 years ago

@afzal442: The label triage/accepted cannot be applied. Only GitHub organization members can add the label.

In response to [this](https://github.com/kubernetes/website/issues/36194#issuecomment-1226092945): >/triage accepted Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

afzal442 commented 2 years ago

Hi @sftim! Let me know how I can get the details of that and other annotations usage. Thanks.

mk46 commented 2 years ago

/triage accepted

k8s-triage-robot commented 1 year ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

sftim commented 1 year ago

Hi @sftim! Let me know how I can get the details of that and other annotations usage. Thanks.

Although I was able to spot that the annotation was not documented, I do not know how Kubernetes uses this annotation. If someone wants to work on this issue, it'll be a good idea to either:

have a chat with SIG Storage folks about how Kubernetes uses this annotation
read the Kubernetes source code to find out.

It's also OK to use a mix of those approaches.

vaibhav2107 commented 1 year ago

/remove-lifecycle stale

mehabhalodiya commented 1 year ago

@afzal442 any updates here?

sftim commented 1 year ago

(anyone is welcome to work on this - we have a “no cookie licking” policy in SIG Docs)

If someone has said they plan to work on an issue, and you're also considering that work, it's polite - but not mandatory - to try to co-ordinate.

mehabhalodiya commented 1 year ago

/unassign @afzal442

Ritikaa96 commented 6 months ago

I found usage of this plugin in OpenStack Cloud provider repo :here

root@small-k8s-1:~# kubectl get csinode small-k8s-2 -o yaml
apiVersion: storage.k8s.io/v1
kind: CSINode
metadata:
annotations:
storage.alpha.kubernetes.io/migrated-plugins: kubernetes.io/cinder
...

in #657, the CSI migration specific field shows: `For CSINode object that maps to a node which installs CSIDriver, if CSI Migration is turned on, a new annotation will be added storage.alpha.kubernetes.io/migrated-plugins
this blog describes the utility someway.

Ritikaa96 commented 6 months ago

/assign I'd like to work on this .

Ritikaa96 commented 6 months ago

Just for cross check: The documentation will be as follows:

Type: Annotation

Example:`storage.alpha.kubernetes.io/migrated-plugins:" kubernetes.io/cinder"`
 `storage.alpha.kubernetes.io/migrated-plugins: "kubernetes.io/vsphere-volume"`

Used on: CSINode

This annotation is automatically added when CSIMigration is enabled/turned on for the CSINode object that maps to a node that installs CSIDriver. This annotation shows the in-tree plugin name of the migrated plugin. the value depends upon the in-tree cloud provider storage type that is used in your cluster. 

For example, if we enable the migration where the in-tree cloud provider storage type is CSIMigrationvSphere, the csinodes instance for the node should be updated with: `storage.alpha.kubernetes.io/migrated-plugins:  `kubernetes.io/vsphere-volume`

How does this look?

Ritikaa96 commented 6 months ago

I have raised a PR: https://github.com/kubernetes/website/pull/45118, Will wait for the reviews. Thank you!

Ritikaa96 commented 1 month ago

Hi, JFYI I just made the new changes to remove CSImigration reference in the PR. I'll wait for more suggestions if there are any. Thanks!

Ritikaa96 commented 1 month ago

As the PR has been merged , this issue is resolved. thus closing it. /close

k8s-ci-robot commented 1 month ago

@Ritikaa96: Closing this issue.

In response to [this](https://github.com/kubernetes/website/issues/36194#issuecomment-2244721225): >As the PR has been merged , this issue is resolved. >thus closing it. >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.