[cf-dev] Proposal: Metadata for API resources

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

[cf-dev] Proposal: Metadata for API resources

Zach Robinson
Hey all,

The CAPI team would like to share a proposal to apply metadata to API resources.  Please have a look and add comments for any questions or concerns.

https://docs.google.com/document/d/1Ebko_wNu4wWLnAdHg6wmydEMTx_IdwYnb4Ys0mxVmM4/edit?usp=sharing

Thanks!
-Zach, CAPI Project Lead
_._,_._,_

Links:

You receive all messages sent to this group.

View/Reply Online (#8050) | [hidden email] | [hidden email] | Mute This Topic | New Topic

Your Subscription | Group Home | [hidden email] | Terms | Unsubscribe

_._,_._,_
Reply | Threaded
Open this post in threaded view
|

Re: [cf-dev] Proposal: Metadata for API resources

David McClure
I read through this yesterday and didn't have any specific comments to leave in-line, but I am happy to see this surface now as I know it's come up in a number of settings in the past.  I also thought it was interesting to see the open, implicit acknowledgement of seeking inspiration of convergence with the analogous feature set in Kubernetes. This feels like a healthy thing to see continuing to happen in this community, but I'm also curious to know whether there's any more to it that is worth sharing in this particular case.

Aside from meeting user expectations because they may end up using similar features on either CF or Kubernetes, is there any reason or background in the thinking around aiming to have these APIs or experiences  be more or less similar to each other?



On Thu, Jun 7, 2018 at 10:46 AM Zach Robinson <[hidden email]> wrote:
Hey all,

The CAPI team would like to share a proposal to apply metadata to API resources.  Please have a look and add comments for any questions or concerns.

https://docs.google.com/document/d/1Ebko_wNu4wWLnAdHg6wmydEMTx_IdwYnb4Ys0mxVmM4/edit?usp=sharing

Thanks!
-Zach, CAPI Project Lead

_._,_._,_

Links:

You receive all messages sent to this group.

View/Reply Online (#8051) | [hidden email] | [hidden email] | Mute This Topic | New Topic

Your Subscription | [hidden email] | Leave [[hidden email]]

_._,_._,_
Reply | Threaded
Open this post in threaded view
|

Re: [cf-dev] Proposal: Metadata for API resources

Zach Robinson
Thanks for taking the time to read through it.

There was no specific consideration around API similarity in general.  It just seemed to make sense for this specific use case. Kube has a nice partitioning of different types of data -- labels vs annotations -- that matched up well with what we have heard regarding what folks would use metadata for. It also made sense to consider for these specific APIs since a large reason for metadata is third party system integration.  I've spoken with several folks that are building systems that manipulate objects in both systems, so having low cognitive overhead for cross-platform integration felt like a good path to pursue.

On Fri, Jun 8, 2018 at 2:15 AM David McClure <[hidden email]> wrote:
I read through this yesterday and didn't have any specific comments to leave in-line, but I am happy to see this surface now as I know it's come up in a number of settings in the past.  I also thought it was interesting to see the open, implicit acknowledgement of seeking inspiration of convergence with the analogous feature set in Kubernetes. This feels like a healthy thing to see continuing to happen in this community, but I'm also curious to know whether there's any more to it that is worth sharing in this particular case.

Aside from meeting user expectations because they may end up using similar features on either CF or Kubernetes, is there any reason or background in the thinking around aiming to have these APIs or experiences  be more or less similar to each other?



On Thu, Jun 7, 2018 at 10:46 AM Zach Robinson <[hidden email]> wrote:
Hey all,

The CAPI team would like to share a proposal to apply metadata to API resources.  Please have a look and add comments for any questions or concerns.

https://docs.google.com/document/d/1Ebko_wNu4wWLnAdHg6wmydEMTx_IdwYnb4Ys0mxVmM4/edit?usp=sharing

Thanks!
-Zach, CAPI Project Lead

_._,_._,_

Links:

You receive all messages sent to this group.

View/Reply Online (#8053) | [hidden email] | [hidden email] | Mute This Topic | New Topic

Your Subscription | [hidden email] | Leave [[hidden email]]

_._,_._,_
Reply | Threaded
Open this post in threaded view
|

Re: [cf-dev] Proposal: Metadata for API resources

David McClure
Cool, that makes a lot of sense. Thanks for filling in that gap in my understanding.

On Fri, Jun 8, 2018 at 11:25 AM Zach Robinson <[hidden email]> wrote:
Thanks for taking the time to read through it.

There was no specific consideration around API similarity in general.  It just seemed to make sense for this specific use case. Kube has a nice partitioning of different types of data -- labels vs annotations -- that matched up well with what we have heard regarding what folks would use metadata for. It also made sense to consider for these specific APIs since a large reason for metadata is third party system integration.  I've spoken with several folks that are building systems that manipulate objects in both systems, so having low cognitive overhead for cross-platform integration felt like a good path to pursue.

On Fri, Jun 8, 2018 at 2:15 AM David McClure <[hidden email]> wrote:
I read through this yesterday and didn't have any specific comments to leave in-line, but I am happy to see this surface now as I know it's come up in a number of settings in the past.  I also thought it was interesting to see the open, implicit acknowledgement of seeking inspiration of convergence with the analogous feature set in Kubernetes. This feels like a healthy thing to see continuing to happen in this community, but I'm also curious to know whether there's any more to it that is worth sharing in this particular case.

Aside from meeting user expectations because they may end up using similar features on either CF or Kubernetes, is there any reason or background in the thinking around aiming to have these APIs or experiences  be more or less similar to each other?



On Thu, Jun 7, 2018 at 10:46 AM Zach Robinson <[hidden email]> wrote:
Hey all,

The CAPI team would like to share a proposal to apply metadata to API resources.  Please have a look and add comments for any questions or concerns.

https://docs.google.com/document/d/1Ebko_wNu4wWLnAdHg6wmydEMTx_IdwYnb4Ys0mxVmM4/edit?usp=sharing

Thanks!
-Zach, CAPI Project Lead

_._,_._,_

Links:

You receive all messages sent to this group.

View/Reply Online (#8054) | [hidden email] | [hidden email] | Mute This Topic | New Topic

Your Subscription | [hidden email] | Leave [[hidden email]]

_._,_._,_
Reply | Threaded
Open this post in threaded view
|

Re: [cf-dev] Proposal: Metadata for API resources

Stephan Merker
In reply to this post by Zach Robinson

+1

 

We had to introduce a number of workarounds / extra book keeping to keep track for e.g. ‘system applications’, orgs belonging to the installation and not to customers, orgs requiring exceptions from quota handling etc.

Annotations are the natural place to store such information.

 

Best regards,

Stephan

 

From: [hidden email] [mailto:[hidden email]] On Behalf Of Zach Robinson
Sent: Donnerstag, 7. Juni 2018 19:46
To: [hidden email]
Subject: [cf-dev] Proposal: Metadata for API resources

 

Hey all,

The CAPI team would like to share a proposal to apply metadata to API resources.  Please have a look and add comments for any questions or concerns.

https://docs.google.com/document/d/1Ebko_wNu4wWLnAdHg6wmydEMTx_IdwYnb4Ys0mxVmM4/edit?usp=sharing

Thanks!
-Zach, CAPI Project Lead

_._,_._,_

Links:

You receive all messages sent to this group.

View/Reply Online (#8055) | [hidden email] | [hidden email] | Mute This Topic | New Topic

Your Subscription | [hidden email] | Leave [[hidden email]]

_._,_._,_