meta

Documentation

Overview

Package meta provides definition of core metadata resources.

Index

• Constants
• type Namespace
  • func NewNamespace(id resource.ID, spec NamespaceSpec) *Namespace
• type NamespaceExtension
  • func (NamespaceExtension) ResourceDefinition() ResourceDefinitionSpec
• type NamespaceSpec
  • func (n NamespaceSpec) DeepCopy() NamespaceSpec
  • func (n NamespaceSpec) MarshalProto() ([]byte, error)
  • func (n *NamespaceSpec) UnmarshalProto(protoBytes []byte) error
• type PrintColumn
• type ResourceDefinition
  • func NewResourceDefinition(spec ResourceDefinitionSpec) (*ResourceDefinition, error)
• type ResourceDefinitionExtension
  • func (ResourceDefinitionExtension) ResourceDefinition() ResourceDefinitionSpec
• type ResourceDefinitionProvider
• type ResourceDefinitionSpec
• type ResourceWithRD

Constants

const (
	NonSensitive = spec.NonSensitive
	Sensitive    = spec.Sensitive
)

Sensitivity values.

const NamespaceName resource.Namespace = "meta"

NamespaceName is the name of 'meta' namespace.

const NamespaceType = resource.Type("Namespaces.meta.cosi.dev")

NamespaceType is the type of Namespace.

const Owner resource.Owner = "meta"

Owner is the owner for the 'meta' objects.

const ResourceDefinitionType = resource.Type("ResourceDefinitions.meta.cosi.dev")

ResourceDefinitionType is the type of ResourceDefinition.

Types

type Namespace

type Namespace = typed.Resource[NamespaceSpec, NamespaceExtension]

Namespace provides metadata about namespaces.

func NewNamespace

func NewNamespace(id resource.ID, spec NamespaceSpec) *Namespace

NewNamespace initializes a Namespace resource.

type NamespaceExtension

type NamespaceExtension struct{}

NamespaceExtension provides auxiliary methods for Namespace.

func (NamespaceExtension) ResourceDefinition

func (NamespaceExtension) ResourceDefinition() ResourceDefinitionSpec

ResourceDefinition implements core.ResourceDefinitionProvider interface.

type NamespaceSpec

type NamespaceSpec struct {
	Description string `yaml:"description"`
}

NamespaceSpec provides Namespace definition.

func (NamespaceSpec) DeepCopy

func (n NamespaceSpec) DeepCopy() NamespaceSpec

DeepCopy generates a deep copy of NamespaceSpec.

func (NamespaceSpec) MarshalProto

func (n NamespaceSpec) MarshalProto() ([]byte, error)

MarshalProto implements ProtoMarshaler.

func (*NamespaceSpec) UnmarshalProto

func (n *NamespaceSpec) UnmarshalProto(protoBytes []byte) error

UnmarshalProto implements protobuf.ResourceUnmarshaler.

type PrintColumn

type PrintColumn = spec.PrintColumn

PrintColumn describes extra columns to print for the resources.

type ResourceDefinition

type ResourceDefinition = typed.Resource[ResourceDefinitionSpec, ResourceDefinitionExtension]

ResourceDefinition provides metadata about namespaces.

func NewResourceDefinition

func NewResourceDefinition(spec ResourceDefinitionSpec) (*ResourceDefinition, error)

NewResourceDefinition initializes a ResourceDefinition resource.

type ResourceDefinitionExtension

type ResourceDefinitionExtension struct{}

ResourceDefinitionExtension provides auxiliary methods for ResourceDefinition.

func (ResourceDefinitionExtension) ResourceDefinition

func (ResourceDefinitionExtension) ResourceDefinition() ResourceDefinitionSpec

ResourceDefinition implements core.ResourceDefinitionProvider interface.

type ResourceDefinitionProvider

type ResourceDefinitionProvider interface {
	ResourceDefinition() ResourceDefinitionSpec
}

ResourceDefinitionProvider is implemented by resources which can be registered automatically.

type ResourceDefinitionSpec

type ResourceDefinitionSpec = spec.ResourceDefinitionSpec

ResourceDefinitionSpec provides ResourceDefinition definition.

type ResourceWithRD

type ResourceWithRD interface {
	ResourceDefinitionProvider
	resource.Resource
}

ResourceWithRD is a resource providing resource definition.

ResourceWithRD allows to pull resource namespace and type from the RD.