OpenSLO v2alpha¶
API version: openslo.com/v2alpha.
Property paths use [*] for each array item, .* for each map value, and .*~
for each map key.
Objects¶
Common metadata¶
metadata¶
struct required
Metadata is the Kubernetes-style identifying metadata used by v2alpha objects.
Validation rules
| Rule |
|---|
| property is required |
metadata.name ¶
string required
Name identifies the object when other OpenSLO objects refer to it.
Validation rules
| Rule | Details | Examples |
|---|---|---|
| property is required | ||
| length must be between 1 and 63 | ||
string must match regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ |
an RFC-1123 compliant label name must consist of lower case alphanumeric characters or -, and must start and end with an alphanumeric character |
my-name123-abc |
metadata.labels ¶
map[string]string
Labels classifies the object with Kubernetes-style, single-valued labels.
Labels maps label keys to one string value each.
Validation rules
| Rule |
|---|
| property is optional |
metadata.labels.*~ ¶
string
Validation rules
| Rule | Details | Examples |
|---|---|---|
| length must be between 1 and 317 | ||
| string must be a Kubernetes Qualified Name | Kubernetes Qualified Name must consist of alphanumeric characters, -, _ or ., and must start and end with an alphanumeric character with an optional DNS subdomain prefix and / |
my.domain/MyNameMyNamemy.name123-abc |
metadata.labels.* ¶
string
Validation rules
| Rule | Examples |
|---|---|
string must match regular expression: ^([a-z0-9]([-._a-z0-9]{0,61}[a-z0-9])?)?$ |
my-labelmy.domain_123-label |
metadata.annotations ¶
map[string]string
Annotations attaches non-identifying metadata to the object.
Annotations maps annotation keys to arbitrary string values.
Validation rules
| Rule |
|---|
| property is optional |
metadata.annotations.*~ ¶
string
Validation rules
| Rule | Details | Examples |
|---|---|---|
| length must be between 1 and 317 | ||
| string must be a Kubernetes Qualified Name | Kubernetes Qualified Name must consist of alphanumeric characters, -, _ or ., and must start and end with an alphanumeric character with an optional DNS subdomain prefix and / |
my.domain/MyNameMyNamemy.name123-abc |