WIP: Define schema with cue #32
Conversation
Closes: OpenSLO#20 Signed-off-by: Michael Gasch <mgasch@vmware.com>
|
@ian-bartholomew first proposal for discussion. There's couple of areas where the spec is a bit fuzzy/unclear to me (and I made some minor adjustments based on some other comments). On
Why do we need to spread the different metrics over various spec parts, e.g. one in
and
|
| @@ -0,0 +1,198 @@ | |||
| { | |||
There was a problem hiding this comment.
Generated with cue export --out=openapi meta.cue spec.cue > openapi.json
| @@ -0,0 +1,6 @@ | |||
| package v1alpha1 | |||
|
|
|||
| apiVersion: "openslo/v1alpha1" & #apiVersion | |||
| package v1alpha1 | ||
|
|
||
| apiVersion: "openslo/v1alpha1" & #apiVersion | ||
| kind: "SLO" & #kind |
There was a problem hiding this comment.
For Service the spec is rather brief on what goes into it (besides spec.Description) so I did not include Service type yet.
| import "time" | ||
|
|
||
| #spec: { | ||
| // list? |
There was a problem hiding this comment.
In the spec it looks like a list []?
| service: string | ||
| // optional | ||
| // TODO: 1050 exceeds go regex limit (1000) | ||
| description?: string |
There was a problem hiding this comment.
Can't use regex to validate 1050 char limit here due to go regex package limit (1000).
| service: string | ||
| // optional | ||
| // TODO: 1050 exceeds go regex limit (1000) | ||
| description?: string |
There was a problem hiding this comment.
Can't use regex to validate 1050 char limit here due to go regex package limit (1000).
| // TODO: 1050 exceeds go regex limit (1000) | ||
| description?: string | ||
| // object oneOf | ||
| timeWindow: #timeWindowSecond | #timeWindowCalendar |
There was a problem hiding this comment.
Note: made this oneOf instead of list
| // indicator: | ||
| } | ||
|
|
||
| #indicator: { |
| } | ||
| calendar: { | ||
| // note: leap-seconds not supported | ||
| startTime: time.Format(time.RFC3339) |
There was a problem hiding this comment.
Enforcing RFC3339 and avoiding additional timezone field.
Agreed as I mentioned this here: #29 Whats the best mechanism for suggesting the recommended change to the spec? |
@embano1 this has come up a few times, and I agree, it leads to some issues, and should get addressed. This is an artifact of us open sourcing our internal spec @its02003 I think a good way of doing is it is a PR here with changes in the spec, and then pinging the OpenSLO Slack channel where we can discuss it. Thanks both! |
TODO:
indicatorobjectivesCloses: #20
Signed-off-by: Michael Gasch mgasch@vmware.com