annotations

Documentation

Index

• type Annotation
  • func New(as map[string]string) Annotation
  • func (a Annotation) Add(key, value string) Annotation
  • func (a Annotation) CheckKeysNonEmpty(keys ...string) error
  • func (a Annotation) Copy() Annotation
  • func (a Annotation) Has(key, expectedValue string) bool
  • func (a Annotation) HasAll(expected map[string]string) bool
  • func (a Annotation) HasAny(expected map[string]string) bool
  • func (a Annotation) Merge(as Annotation) Annotation
  • func (a Annotation) Remove(key string) Annotation
  • func (a Annotation) ToMap() map[string]string
• type ID
  • func ConvertTagToID(n names.Tag) (ID, error)
  • func (i ID) String() string
  • func (i ID) Validate() error
• type Kind

Types

type Annotation

type Annotation map[string]string

Annotation extends k8s annotation map.

func New

func New(as map[string]string) Annotation

New contructs an annotation.

func (Annotation) Add

func (a Annotation) Add(key, value string) Annotation

Add inserts a new key value pair.

func (Annotation) CheckKeysNonEmpty

func (a Annotation) CheckKeysNonEmpty(keys ...string) error

CheckKeysNonEmpty checks if the provided keys are all set to non empty value.

func (Annotation) Copy

func (a Annotation) Copy() Annotation

Copy returns a copy of current annotation.

func (Annotation) Has

func (a Annotation) Has(key, expectedValue string) bool

Has checks if the provided key value pair exists in this annotation or not.

func (Annotation) HasAll

func (a Annotation) HasAll(expected map[string]string) bool

HasAll checks if all the provided key value pairs exist in this annotation or not.

func (Annotation) HasAny

func (a Annotation) HasAny(expected map[string]string) bool

HasAny checks if any provided key value pairs exists in this annotation or not.

func (Annotation) Merge

func (a Annotation) Merge(as Annotation) Annotation

Merge merges an annotation with current one.

func (Annotation) Remove

func (a Annotation) Remove(key string) Annotation

Remove deletes the key and its value from the annotation.

func (Annotation) ToMap

func (a Annotation) ToMap() map[string]string

ToMap returns the map format of the annotation.

type ID

type ID struct {
	Kind Kind
	Name string
}

ID reifies annotatable GlobalEntities into an internal representation using annotations.Kind.

func ConvertTagToID

func ConvertTagToID(n names.Tag) (ID, error)

ConvertTagToID converts the names.Tag into an ID for different names.Kinds of entities, registering them as annotations.Kinds of entities.

func (ID) String

func (i ID) String() string

func (ID) Validate

func (i ID) Validate() error

Validate checks if the ID is valid or not.

type Kind

type Kind int

Kind identifies different kinds of entities that'll get associated with annotations.

const (
	KindApplication Kind = 1
	KindMachine     Kind = 2
	KindUnit        Kind = 3
	KindModel       Kind = 4
	KindStorage     Kind = 5
)