add initial one-pager for stack ui metadata#605
Conversation
| .registry/ | ||
| ├── icon.png | ||
| ├── app.yaml # Application metadata. | ||
| ├── ui-schema.yaml # Optional UI spec for configuration metadata |
There was a problem hiding this comment.
what does a ui-schema.yaml file at the root mean vs. one that is scoped to a single CRD? How would one at the root be processed and consumed?
There was a problem hiding this comment.
I've wondered if there is may be reasons to annotate the Extension itself in addition to the extension created CRD, for visual package-configuration aids (like debconf).
@rathpc, what did you have in mind here?
There was a problem hiding this comment.
This is a valid question. The inclusion of these different specs was originally added by @lukeweber and I believe the intention was to have a fallback during the consumption/overlay process that creates the annotation. If a specific CRD version does not contain the ui-schema.yaml file it would look for a root fallback to consume instead. This is really only necessary if a CRD has a mandatory requirement for a ui field, version agnostic. That is why it is also listed as optional.
Let me know if you need further clarification on this or if you guys have other thoughts. Thanks!
There was a problem hiding this comment.
I added this reasoning in 13b4da9 .. I'm still wondering if Extensions themselves (and not the CRDs they provide/manage) may be able to take advantage of UI markup. (Configuring your Provider's credentials in an Infra Stack, for example).
|
|
|
|
|
|
|
|
jbw976
left a comment
jbw976
left a comment
There was a problem hiding this comment.
Cool @displague, this looks good to me now, let's get this merged and then we can focus and converge on #604.
Can you please squash into logical commits before merging?
displague
force-pushed
the
design-ui-metadata
branch
from
6b00a4d to
f56f91a
Compare
|
Let me know if you want the others squashed (or feel free to use the Github Squash+Merge). There's no past like the present. |
Add an initial one-pager draft for how Stacks should bundle UI annotations. This document was initially drafted by @rathpc out of tree. Signed-off-by: Marques Johansson <marques@upbound.io>
displague
force-pushed
the
design-ui-metadata
branch
from
f56f91a to
2edc99e
Compare
6 participants
Add an initial one-pager draft for how Stacks should bundle UI
annotations.
This document was initially drafted by @rathpc out of tree.
Closes #544
[skip ci]