Skip to content

Service (v1)

Service identifies a high-level group of SLO objects. An SLO associates with the Service by setting SLOSpec.Service to the Service's Metadata.Name. Multiple SLOs can refer to the same Service.

Examples

apiVersion: openslo/v1
kind: Service
metadata:
  name: example-service
  displayName: Example Service
spec:
  description: Example service description

apiVersion: openslo/v1
kind: Service
metadata:
  annotations:
    openslo.com/service-folder: ./my/directory
  labels:
    env:
      - dev
    team:
      - team-a
      - team-b
  name: example-service
  displayName: Example Service
spec:
  description: Example service description

Properties

apiVersion

string required

Version represents a version of the OpenSLO specification.

Allowed values: openslo/v1

Validation rules

Rule
property is required
must be equal to openslo/v1

kind

string required

Kind represents all the object kinds defined by OpenSLO specification. Keep in mind not all specification versions support every Kind.

Allowed values: Service

Validation rules

Rule
property is required
must be equal to Service

metadata

struct required reference

See the metadata definition in the overview.

Validation rules

Rule
property is required

spec

struct

ServiceSpec contains the descriptive properties of a Service.

spec.description

string

Description summarizes the service.

Validation rules

Rule
property is optional
length must be less than or equal to 1050