manifest

Documentation

Overview

Copyright © 2021 OpenSLO Team

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Package manifest provides foundational structs

Index

• type Metadata
• type MetadataHolder
• type ObjectGeneric
• type ObjectHeader

Types

type Metadata

type Metadata struct {
	Name        string `yaml:"name" validate:"required" example:"name"`
	DisplayName string `yaml:"displayName,omitempty" validate:"omitempty,min=0,max=63" example:"Prometheus Source"`
}

Metadata represents part of object which is is common for all available Objects, for internal usage.

type MetadataHolder

type MetadataHolder struct {
	Metadata Metadata `yaml:"metadata"`
}

MetadataHolder is an intermediate structure that can provides metadata related field to other structures.

type ObjectGeneric

type ObjectGeneric struct {
	ObjectHeader `yaml:",inline"`
}

ObjectGeneric represents struct to which every Objects is parsable Specific types of Object have different structures as Spec.

type ObjectHeader

type ObjectHeader struct {
	APIVersion     string `yaml:"apiVersion" validate:"required" example:"openslo/v1alpha"`
	Kind           string `yaml:"kind" validate:"required,oneof=Service SLO" example:"kind"`
	MetadataHolder `yaml:",inline"`
}

ObjectHeader represents Header which is common for all available Objects.