metadata

Documentation

Index

• Constants
• type Component
• type Provider
  • func NewProvider(name string, version versionExtractor, globalLabels globalLabelsFn) *Provider
  • func (p *Provider) InstanceName(obj client.Object, comp Component) string
  • func (p *Provider) MatchLabels(obj client.Object) map[string]string
  • func (p *Provider) MatchLabelsWithComponent(obj client.Object, comp Component) map[string]string
  • func (p *Provider) StandardLabels(obj client.Object) map[string]string
  • func (p *Provider) StandardLabelsWithComponent(obj client.Object, comp Component, extraLabels map[string]string) map[string]string

Constants

const (
	// ApplicationNameLabelKey indicates the name of the application.
	ApplicationNameLabelKey = "app.kubernetes.io/name"
	// ApplicationInstanceLabelKey indicates a unique name identifying the instance of an application.
	ApplicationInstanceLabelKey = "app.kubernetes.io/instance"
	// ApplicationVersionLabelKey indicates the current version of the application.
	ApplicationVersionLabelKey = "app.kubernetes.io/version"
	// ApplicationComponentLabelKey indicates the component within the architecture of an application.
	ApplicationComponentLabelKey = "app.kubernetes.io/component"
	// ApplicationManagedByLabelKey indicates the tool being used to manage the operation of an application.
	ApplicationManagedByLabelKey = "app.kubernetes.io/managed-by"
	// ApplicationManagedByLabelValue is the specific tool being used to manage applications created by this project.
	ApplicationManagedByLabelValue = "distributed-compute-operator"
	// DescriptionAnnotationKey can be used to add extra information to a Kubernetes object via its annotations.
	DescriptionAnnotationKey = "distributed-compute.dominodatalab.com/description"
)

Types

type Component

type Component string

Component is used to drive Kubernetes object generation for different types.

const ComponentNone Component = "none"

ComponentNone indicates a generic resource.

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

func NewProvider

func NewProvider(name string, version versionExtractor, globalLabels globalLabelsFn) *Provider

func (*Provider) InstanceName

func (p *Provider) InstanceName(obj client.Object, comp Component) string

func (*Provider) MatchLabels

func (p *Provider) MatchLabels(obj client.Object) map[string]string

func (*Provider) MatchLabelsWithComponent

func (p *Provider) MatchLabelsWithComponent(obj client.Object, comp Component) map[string]string

func (*Provider) StandardLabels

func (p *Provider) StandardLabels(obj client.Object) map[string]string

func (*Provider) StandardLabelsWithComponent

func (p *Provider) StandardLabelsWithComponent(obj client.Object, comp Component, extraLabels map[string]string) map[string]string