common

Documentation

Index

• Variables
• type ComponentNamespace
• type DoguConfigKey
  • func (k DoguConfigKey) String() string
  • func (k DoguConfigKey) Validate() error
• type DoguConfigValue
• type DoguNamespace
• type EncryptedDoguConfigValue
• type GlobalConfigKey
• type GlobalConfigValue
• type QualifiedComponentName
  • func NewQualifiedComponentName(namespace ComponentNamespace, simpleName SimpleComponentName) (QualifiedComponentName, error)
  • func QualifiedComponentNameFromString(qualifiedName string) (QualifiedComponentName, error)
  • func (componentName QualifiedComponentName) String() string
  • func (componentName QualifiedComponentName) Validate() error
• type QualifiedDoguName
  • func NewQualifiedDoguName(namespace DoguNamespace, simpleName SimpleDoguName) (QualifiedDoguName, error)
  • func QualifiedDoguNameFromString(qualifiedName string) (QualifiedDoguName, error)
  • func (doguName QualifiedDoguName) String() string
  • func (doguName QualifiedDoguName) Validate() error
• type RegistryConfigKey
• type SensitiveDoguConfigKey
• type SensitiveDoguConfigValue
• type SimpleComponentName
• type SimpleDoguName

Variables

var K8sK8sLonghornName = QualifiedComponentName{Namespace: "k8s", SimpleName: "k8s-longhorn"}

Types

type ComponentNamespace

type ComponentNamespace string

type DoguConfigKey

type DoguConfigKey struct {
	DoguName SimpleDoguName
	Key      string
}

func (DoguConfigKey) String

func (k DoguConfigKey) String() string

func (DoguConfigKey) Validate

func (k DoguConfigKey) Validate() error

type DoguConfigValue

type DoguConfigValue string

DoguConfigValue is a single dogu config value, which is no sensitive configuration

type DoguNamespace

type DoguNamespace string

type EncryptedDoguConfigValue

type EncryptedDoguConfigValue string

EncryptedDoguConfigValue is a single encrypted sensitive dogu config value

type GlobalConfigKey

type GlobalConfigKey string

type GlobalConfigValue

type GlobalConfigValue string

GlobalConfigValue is a single global config value

type QualifiedComponentName

type QualifiedComponentName struct {
	Namespace  ComponentNamespace
	SimpleName SimpleComponentName
}

func NewQualifiedComponentName

func NewQualifiedComponentName(namespace ComponentNamespace, simpleName SimpleComponentName) (QualifiedComponentName, error)

func QualifiedComponentNameFromString

func QualifiedComponentNameFromString(qualifiedName string) (QualifiedComponentName, error)

QualifiedComponentNameFromString converts a qualified component as a string, e.g. "k8s/k8s-dogu-operator", to a dedicated QualifiedComponentName or raises an error if this is not possible.

func (QualifiedComponentName) String

func (componentName QualifiedComponentName) String() string

String returns the component name with namespace, e.g. k8s/k8s-dogu-operator

func (QualifiedComponentName) Validate

func (componentName QualifiedComponentName) Validate() error

type QualifiedDoguName

type QualifiedDoguName struct {
	Namespace  DoguNamespace
	SimpleName SimpleDoguName
}

func NewQualifiedDoguName

func NewQualifiedDoguName(namespace DoguNamespace, simpleName SimpleDoguName) (QualifiedDoguName, error)

func QualifiedDoguNameFromString

func QualifiedDoguNameFromString(qualifiedName string) (QualifiedDoguName, error)

QualifiedDoguNameFromString converts a qualified dogu as a string, e.g. "official/nginx", to a dedicated QualifiedDoguName or raises an error if this is not possible.

func (QualifiedDoguName) String

func (doguName QualifiedDoguName) String() string

String returns the dogu name with namespace, e.g. official/postgresql

func (QualifiedDoguName) Validate

func (doguName QualifiedDoguName) Validate() error

type RegistryConfigKey

type RegistryConfigKey interface {
	GlobalConfigKey | DoguConfigKey | SensitiveDoguConfigKey
}

type SensitiveDoguConfigKey

type SensitiveDoguConfigKey struct {
	DoguConfigKey
}

type SensitiveDoguConfigValue

type SensitiveDoguConfigValue string

SensitiveDoguConfigValue is a single unencrypted sensitive dogu config value

type SimpleComponentName

type SimpleComponentName string

type SimpleDoguName

type SimpleDoguName string