adds Runtime Conditions whitepaper for TAG review#2241
Conversation
Signed-off-by: Colin Lacy <colacy@cisco.com>
github-actions
Bot
added
the
needs-triage
github-actions
Bot
added
the
needs-kind
github-actions
Bot
added
the
needs-group
Signed-off-by: Kevin Dubois <kevin.dubois@gmail.com>
6d0bcae to
0e3f8b3
Compare
| @@ -0,0 +1,549 @@ | |||
| # Runtime Conditions Profiles: Portable Runtime Requirements for Cloud-Native and AI-Native Workloads | |||
There was a problem hiding this comment.
Unhyphenated usage should be better in the CNCF documents. e.g., "Cloud Native"
There was a problem hiding this comment.
This should be applied to the whole content.
There was a problem hiding this comment.
For reference: https://github.com/cncf/foundation/blob/main/style-guide.md
The guidelines do call this out specifically. Not that it would confuse anyone, but good for us to be consistent. ;)
|
|
||
| A Runtime Conditions Profile is a portable, machine-readable declaration of the external runtime integrations required by one workload. It gives developers, platform teams, policy systems, catalogs, agents, and automation a shared contract for reasoning about runtime requirements before deployment. | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
Is this just an example or actually working?
| name: checkout-service | ||
| workload: | ||
| uri: https://github.com/example-org/checkout-service | ||
| version: v1.2.3 |
There was a problem hiding this comment.
Do we have a specific meaning for this version? How do we maintain the versioning?
danieloh30
left a comment
danieloh30
left a comment
There was a problem hiding this comment.
Looks great to me. Just added a few minor comments.
riaankleinhans
changed the title
stmcginnis
left a comment
stmcginnis
left a comment
There was a problem hiding this comment.
This is looking really good! I have a few trivial things. If you'd prefer I just create a PR to your branch to address those, just let me know. But overall I really like where this is going.
| Catalog["Service catalogs"] --> Supply["Platform supply"] | ||
| Tools["Platform automation tools"] --> Fulfillment["Platform fulfillment"] | ||
| Tickets["Tickets and docs"] --> Hidden | ||
| Hidden --> Risk["Late failures, manual coordination,\nand incomplete automation"] |
There was a problem hiding this comment.
If I remember right, mermaid rendering doesn't support \n, so you end up with those actual characters in the output. I think you need to use <br> to get this to be multi-line.
| @@ -0,0 +1,543 @@ | |||
| # Runtime Conditions Profiles: Portable Runtime Requirements for Cloud-Native and AI-Native Workloads | |||
|
|
|||
| # 1. Executive Summary | |||
There was a problem hiding this comment.
nit: These should be H2 (##) and only the document title should be H1 (#).
4 participants
Leaving in draft to encourage feedback and contributions. Please comment here, or fork and open PRs against my branch. Any and all feedback is welcome 👍
Addresses #1797, third deliverable.