Giter VIP home page Giter VIP logo

Comments (3)

dja-fr avatar dja-fr commented on August 29, 2024

Hello,

Maybe a little refactor to show in addition of removed API the list of currently deprecated API but without removal announce ?

On rules folder something like that ? :

rules/
  1-16-deprecated.rego
  1-16-removed.rego
  1-20-deprecated.rego
  1-21-deprecated.rego
  1-22-deprecated.rego
  1-22-removed.rego
 

Two file per K8s release seems to be easier to maintain rather than 1 global file with deprecation list.

and for console output

__________________________________________________________________________________________
>>> Deprecated APIs annoucement in 1.20 <<<
------------------------------------------------------------------------------------------
KIND          NAMESPACE     NAME                          API_VERSION                     REPLACE_WITH (SINCE)
VolumeSnapshot <undefined>   test-volume   snapshot.storage.k8s.io/v1beta1   snapshot.storage.k8s.io/v1 (1.20+)
__________________________________________________________________________________________
>>> Deprecated APIs removed in 1.22 <<<
------------------------------------------------------------------------------------------
KIND          NAMESPACE     NAME                          API_VERSION                     REPLACE_WITH (SINCE)
TokenReview   <undefined>   test-deprecated-TokenReview   authentication.k8s.io/v1beta1   authentication.k8s.io/v1 (1.19+)

from kube-no-trouble.

stepanstipl avatar stepanstipl commented on August 29, 2024

Thanks, @dja-fr for the idea, I think it would make sense to have a separate group for announced deprecated APIs, when it's not clear in which version these will be removed.

I'm thinking about two options:

a) As you described, have additional set for each K8s version, then how would the progression over time look like:

  • i) API appears in the announced group (like VolumeSnapshot in 1.20)
  • ii) Once it's clear when removed, API is moved to corresponding deprecated (like VolumeSnapshot to 1.25 - just an example), I guess we don't want to have rules twice ;)
  • iii) the "1.20 - announced" group will eventually disappear

b) Have a generic group for deprecated APIs, without pinning to a specific version

  • i) API appears in the generic "deprecated" group
  • ii) Once clear when removed, it will move to corresponding deprecated

I'm thinking second might be a bit simpler. But at the same time, we're losing some info, as to when the API was announced as deprecated. Not quite sure if that's important, as we already have "since" information, although it's a bit different.

WDYT?

from kube-no-trouble.

dja-fr avatar dja-fr commented on August 29, 2024

Hi,

We can try b) option.
I'll try to send you a PR. (I'll have some boring meeting this afternoon 😄 )

from kube-no-trouble.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.