search

operator-framework / enhancements

Apache License 2.0
9 stars 40 forks source link

ep: usage of properties to describe that channel or packages will be discontinued #113

Closed camilamacedo86 closed 1 year ago

camilamacedo86 commented 2 years ago

Description ep: usage of properties to describe that channel or packages will be discontinued

cdjohnson commented 2 years ago

Is there a reason why you're using the term "discontinued" vs. "deprecated"? I think the the "deprecate" term is widely understood and is surfaced in lots of APIs already.

joelanford commented 2 years ago

Is there a reason why you're using the term "discontinued" vs. "deprecated"? I think the the "deprecate" term is widely understood and is surfaced in lots of APIs already.

+1, I think "deprecated" is the state where its still in the catalog, but will be removed soon. "Discontinued" is when its actually removed. And if it's removed, it clearly doesn't need a property to convey that it has been removed.

camilamacedo86 commented 2 years ago

Hi @cdjohnson and @joelanford,

I also prefer the term deprecate however the problem is that we have a property olm.deprecate that is set linked to bundles when we use the command opm deprecatetruncate and the bundle cannot be wholly removed from the index. So we probably will need to check further this one as well.

camilamacedo86 commented 1 year ago

Closing this one since this need will be sorted out in another away.

c/c @joelanford

bhavin192 commented 1 year ago

@camilamacedo86 was the new way documented/discussed somewhere? I tried searching for a way to deprecate an operator, but couldn't find anything. Tried looking at the OLM docs as well. As an example I found this commit which adds a note in the description field: https://github.com/k8s-operatorhub/community-operators/commit/1cb47a84275de4ceabb897ed7c9515a1e160c513