Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistencies between ServiceBindingMetadata and ServiceInstanceMetadata #745

Open
WalkerGriggs opened this issue Aug 6, 2021 · 1 comment
Assignees

Comments

@WalkerGriggs
Copy link
Contributor

WalkerGriggs commented Aug 6, 2021

What is the problem?

ServiceInstanceMetadata is fairly general: only two opaque objects.

    ServiceInstanceMetadata:
      type: object
      properties:
        labels:
          type: object
        attributes:
          type: object

but the ServiceBindingMetadata is more specific.

    ServiceBindingMetadata:
      type: object
      properties:
        expires_at:
          type: string
        renew_before:
          type: string

The parallel in names suggests they are functionally equivalent, but this inconsistency changes how brokers use the two objects.

For example, a broker may want to add a general created_at field to both resource's metadata objects, but can't for the service binding.

Or more holistically, it sends mixed messages about OSB as a prescriptive or general specification.

Who does this affect?

Broker authors and platforms.

Do you have any proposed solutions?

Replace the specific ServiceBindingMetadata fields in favor of attributes and labels, or add the two fields in addition to existing, specific ones. The latter is probably better for backwards compatibility.

    ServiceBindingMetadata:
      type: object
      properties:
        labels:
          type: object
        attributes:
          type: object

or

    ServiceBindingMetadata:
      type: object
      properties:
        expires_at:
          type: string
        renew_before:
          type: string
        labels:
          type: object
        attributes:
          type: object
@WalkerGriggs
Copy link
Contributor Author

I'm happy to open an PR, but collecting feedback for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Inbox
Development

No branches or pull requests

2 participants