manifest

Documentation

Overview

Package manifest defines the basic primitives for Nobl9 objects schema.

Index

• Variables
• func FilterByKind[T Object](objects []Object) []T
• func KindNames() []string
• func ObjectFormatNames() []string
• func Validate(objects []Object) []error
• func VersionNames() []string
• type Kind
  • func ApplicableKinds() []Kind
  • func KindValues() []Kind
  • func ParseKind(name string) (Kind, error)
  • func (k Kind) Applicable() bool
  • func (k Kind) Equals(s string) bool
  • func (x Kind) IsValid() bool
  • func (k Kind) MarshalText() ([]byte, error)
  • func (x Kind) String() string
  • func (k Kind) ToLower() string
  • func (k *Kind) UnmarshalText(text []byte) error
• type Object
  • func SetDefaultProject(objects []Object, project string) []Object
• type ObjectFormat
  • func ParseObjectFormat(name string) (ObjectFormat, error)
  • func (x ObjectFormat) IsValid() bool
  • func (x ObjectFormat) String() string
• type ProjectScopedObject
• type Version
  • func ParseVersion(name string) (Version, error)
  • func VersionValues() []Version
  • func (x Version) IsValid() bool
  • func (x Version) MarshalText() ([]byte, error)
  • func (x Version) String() string
  • func (x *Version) UnmarshalText(text []byte) error
  • func (v Version) VersionString() string

Variables

var ErrInvalidKind = fmt.Errorf("not a valid Kind, try [%s]", strings.Join(_KindNames, ", "))

var ErrInvalidObjectFormat = fmt.Errorf("not a valid ObjectFormat, try [%s]", strings.Join(_ObjectFormatNames, ", "))

var ErrInvalidVersion = fmt.Errorf("not a valid Version, try [%s]", strings.Join(_VersionNames, ", "))

Functions

func FilterByKind

func FilterByKind[T Object](objects []Object) []T

FilterByKind filters Object slice and returns its subset matching the type constraint.

func KindNames

func KindNames() []string

KindNames returns a list of possible string values of Kind.

func ObjectFormatNames

func ObjectFormatNames() []string

ObjectFormatNames returns a list of possible string values of ObjectFormat.

func Validate

func Validate(objects []Object) []error

Validate performs validation of all the provided objects. It aggregates the results into a single error.

func VersionNames

func VersionNames() []string

VersionNames returns a list of possible string values of Version.

Types

type Kind

type Kind int

Kind represents all the object kinds available in the API to perform operations on.

ENUM(

SLO = 1 Service Agent AlertPolicy AlertSilence Alert Project AlertMethod Direct DataExport RoleBinding Annotation UserGroup BudgetAdjustment Report )

const (
	// KindSLO is a Kind of type SLO.
	KindSLO Kind = iota + 1
	// KindService is a Kind of type Service.
	KindService
	// KindAgent is a Kind of type Agent.
	KindAgent
	// KindAlertPolicy is a Kind of type AlertPolicy.
	KindAlertPolicy
	// KindAlertSilence is a Kind of type AlertSilence.
	KindAlertSilence
	// KindAlert is a Kind of type Alert.
	KindAlert
	// KindProject is a Kind of type Project.
	KindProject
	// KindAlertMethod is a Kind of type AlertMethod.
	KindAlertMethod
	// KindDirect is a Kind of type Direct.
	KindDirect
	// KindDataExport is a Kind of type DataExport.
	KindDataExport
	// KindRoleBinding is a Kind of type RoleBinding.
	KindRoleBinding
	// KindAnnotation is a Kind of type Annotation.
	KindAnnotation
	// KindUserGroup is a Kind of type UserGroup.
	KindUserGroup
	// KindBudgetAdjustment is a Kind of type BudgetAdjustment.
	KindBudgetAdjustment
	// KindReport is a Kind of type Report.
	KindReport
)

func ApplicableKinds

func ApplicableKinds() []Kind

ApplicableKinds returns all the Kind instances which can be applied or deleted by the user.

func KindValues

func KindValues() []Kind

KindValues returns a list of the values for Kind

func ParseKind

func ParseKind(name string) (Kind, error)

ParseKind attempts to convert a string to a Kind.

func (Kind) Applicable

func (k Kind) Applicable() bool

Applicable returns true if the Kind can be applied or deleted by the user. In other words, it informs whether the Kind's lifecycle is managed by the user.

func (Kind) Equals

func (k Kind) Equals(s string) bool

Equals returns true if the Kind is equal to the given string. The comparison is case-insensitive.

func (Kind) IsValid

func (x Kind) IsValid() bool

IsValid provides a quick way to determine if the typed value is part of the allowed enumerated values

func (Kind) MarshalText

func (k Kind) MarshalText() ([]byte, error)

MarshalText implements the text encoding.TextMarshaler interface.

func (Kind) String

func (x Kind) String() string

String implements the Stringer interface.

func (Kind) ToLower

func (k Kind) ToLower() string

ToLower converts the Kind to a lower case string.

func (*Kind) UnmarshalText

func (k *Kind) UnmarshalText(text []byte) error

UnmarshalText implements the text encoding.TextUnmarshaler interface.

type Object

type Object interface {
	// GetVersion returns the API version of the Object.
	GetVersion() Version
	// GetKind returns the Kind of the Object.
	GetKind() Kind
	// GetName returns the name of the Object (RFC 1123 compliant DNS).
	GetName() string
	// Validate performs static validation of the Object.
	Validate() error
	// GetManifestSource returns the source of the Object's manifest.
	GetManifestSource() string
	// SetManifestSource sets the source of the Object's manifest.
	SetManifestSource(src string) Object
}

Object represents a generic Nobl9 object definition. All Nobl9 objects implement this interface.

func SetDefaultProject

func SetDefaultProject(objects []Object, project string) []Object

SetDefaultProject sets the default project for each object only if the object is ProjectScopedObject, and it does not yet have project assigned to it.

type ObjectFormat

type ObjectFormat int

ObjectFormat represents the format of Object data representation. ENUM(JSON = 1, YAML)

const (
	// ObjectFormatJSON is a ObjectFormat of type JSON.
	ObjectFormatJSON ObjectFormat = iota + 1
	// ObjectFormatYAML is a ObjectFormat of type YAML.
	ObjectFormatYAML
)

func ParseObjectFormat

func ParseObjectFormat(name string) (ObjectFormat, error)

ParseObjectFormat attempts to convert a string to a ObjectFormat.

func (ObjectFormat) IsValid

func (x ObjectFormat) IsValid() bool

IsValid provides a quick way to determine if the typed value is part of the allowed enumerated values

func (ObjectFormat) String

func (x ObjectFormat) String() string

String implements the Stringer interface.

type ProjectScopedObject

type ProjectScopedObject interface {
	Object
	// GetProject returns the name of the project which the ProjectScopedObject belongs to.
	GetProject() string
	// SetProject sets the name of the project which the ProjectScopedObject should belong to.
	// It returns the copy of the Object with the updated Project.
	SetProject(project string) Object
}

ProjectScopedObject an Object which is tied to a specific KindProject. Example of such an object is v1alpha.SLO. On the other hand v1alpha.RoleBinding is an example of organization scoped Object which is not tied to any KindProject.

type Version

type Version string

Version represents the specific version of the manifest. ENUM(v1alpha = n9/v1alpha)

const (
	// VersionV1alpha is a Version of type v1alpha.
	VersionV1alpha Version = "n9/v1alpha"
)

func ParseVersion

func ParseVersion(name string) (Version, error)

ParseVersion attempts to convert a string to a Version.

func VersionValues

func VersionValues() []Version

VersionValues returns a list of the values for Version

func (Version) IsValid

func (x Version) IsValid() bool

IsValid provides a quick way to determine if the typed value is part of the allowed enumerated values

func (Version) MarshalText

func (x Version) MarshalText() ([]byte, error)

MarshalText implements the text marshaller method.

func (Version) String

func (x Version) String() string

String implements the Stringer interface.

func (*Version) UnmarshalText

func (x *Version) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller method.

func (Version) VersionString

func (v Version) VersionString() string

VersionString returns the second element of the Version. For example, given "n9/v1alpha", it returns "v1alpha".