search

operator-framework / operator-lifecycle-manager

A management framework for extending Kubernetes with Operators
https://olm.operatorframework.io
Apache License 2.0
1.7k stars 542 forks source link

`spec.name` -> `spec.packageName` #1167

Open gyliu513 opened 4 years ago

gyliu513 commented 4 years ago

For subscription, we are now using name to identify the name of the package https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/api/apis/operators/v1alpha1/subscription_types.go#L34 , an example is as follows:

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: my-operator-subsription
  namespace: marketplace
spec:
  channel: <channel-name>
  name: my-operator <<<<
  source: johndoe-operators
  sourceNamespace: marketplace

But the spec.name is difficult to understand it means the package name, how about rename this to spec.packageName which is more meaningful?

FYI @clyang82

awgreene commented 4 years ago

I'm not opposed to this change, but we will need to do this in a backwards compatible way.

gyliu513 commented 4 years ago

Yes, how about add a new field named as packageName and make it co-exist with name for one or two release, then mark name field as deprecated, and finally delete it. Comments @awgreene

ecordell commented 4 years ago

We have plans for new apis here: https://github.com/openshift/enhancements/blob/master/enhancements/olm/simplify-apis.md

If it seems valuable we can add the packageName field without deprecating name. I'm not sure it's worth the hassle of deprecating when we intend to move to newer apis anyway.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.