api icon indicating copy to clipboard operation
api copied to clipboard

Add annotation feature status "RETIRED"

Open nmittler opened this issue 4 years ago • 3 comments

This feature status would indicate that the annotation is beyond simply deprecated, but is no longer used.

We would likely not want to document RETIRED values (on istio.io), but retain them for our tooling.

[ ] Configuration Infrastructure [x] Docs [ ] Installation [ ] Networking [ ] Performance and Scalability [ ] Policies and Telemetry [ ] Security [ ] Test and Release [ ] User Experience

Expected behavior

Steps to reproduce the bug

Version (include the output of istioctl version --remote and kubectl version)

How was Istio installed?

Environment where bug was observed (cloud vendor, OS, etc)

nmittler avatar Nov 11 '20 20:11 nmittler

Can you define what’s the semantic difference between RETIRED and DEPRECATED and I’m assuming there’s a progression here from one to the other. Here’s my interpretation:

Devs should mark alpha or beta annotations as DEPRECATED and provide the newer alternative. In the DEPRECATED phase both options need to be supported. Once we are ready to remove the implementation for the DEPRECATED annotation, it’s marked RETIRED and hidden from users completely. Also annotations can go from alpha to RETIRED directly if we don’t plan to support it long term.

nrjpoddar avatar Nov 12 '20 04:11 nrjpoddar

@nrjpoddar that sounds right to me.

@louiscryan can you confirm?

nmittler avatar Nov 12 '20 18:11 nmittler

reassigning to @brian-avery who is taking over this work.

nmittler avatar Dec 01 '20 01:12 nmittler

🚧 This issue or pull request has been closed due to not having had activity from an Istio team member since 2020-12-01. If you feel this issue or pull request deserves attention, please reopen the issue. Please see this wiki page for more information. Thank you for your contributions.

Created by the issue and PR lifecycle manager.

istio-policy-bot avatar May 14 '24 22:05 istio-policy-bot