feat(AIP-111): introducing AIP around planes. #1132
Conversation
The term data plane have been used in the AIPs without a clear definition. Introducing the term "management" and "data" plane, as these are industry-standard terms and are also well defined in the context of Google APIs. These definitions are also helpful in: - providing fine-grained API guidance depending on the plane - help inform new annotations on resources and methods, which can be used for auditing and determining coverage - further help clarify classifications of methods (AIP-130) Also removing the redundant text in AIP-128.
- replacing 0008 front matter with correct example - fixing 111 front matter.
aip/general/0111.md
Outdated
| or perform operations upon. For the context of APIs, the following planes are | ||
| defined: | ||
|
|
||
| - The management plane: a uniform, resource-oriented API that primarily |
There was a problem hiding this comment.
We probably need to at least mention the control plane here, even if it may not be distinct from the management plane, since that term is likely more familiar.
Also, some people may consider the IaC layer the management plane and the resource APIs to be the control plane.
There was a problem hiding this comment.
That begs the question: do we want to introduce a term like the management plane? It's a bit easier to define operations in terms of their impact on the control plane vs data-plane.
Although I guess this wouldn't capture that nuance that sometimes an operation may want to operate on both (e.g. control plane provisions a database and immediately populates it with a table or permissions).
- adding changelog entries and proper links. - emphasizing data-plane's role in reading and writing user data. - accepting suggestion and nits.
|
LGTM except the "Planes are contextual" section. |
| state: reviewing | ||
| created: 2019-05-28 | ||
| id: 8 | ||
| state: reviewing |
There was a problem hiding this comment.
I think this should be approved? The site has it as approved anyways...weird
There was a problem hiding this comment.
This is the template, not the actual site.
this was supposed to be a separate fix, but the frontmatter template was broken.
- removing planes are contextual.
|
@bgrant0607 thanks for the comments, updated and re-requested. I removed the "planes are contextual" section - agreed it's more 1p vs 3p, thinking about it. the only question I have left is whether we want to include control plane among the definitions. Let me know your thoughts - I could also send a follow-up PR as well. |
The term data plane have been used in the AIPs without a clear
definition.
Introducing the term "management" and "data" plane, as these are
industry-standard terms and are also well defined in the context of
Google APIs.
These definitions are also helpful in:
used for auditing and determining coverage
Also removing the redundant text in AIP-128.