v1alpha1

Documentation

Index

• Constants
• Variables
• type AnnotationSet
  • func NewAnnotationSet(key string, defaultAnn string) *AnnotationSet
  • func (s AnnotationSet) Add(prefix string) string
  • func (s AnnotationSet) Get(annotations map[string]string) (string, bool)
  • func (s AnnotationSet) List() []string
  • func (s *AnnotationSet) Reset()

Constants

const (
	// DefaultPrefix defines the default prefix for user facing annotations
	DefaultAnnotationPrefix = "replication.schrodit.tech"

	// NamespacesAnnotation is the name of the annotation that defines the namespaces where the annotated resource should be replicated to.
	NamespacesAnnotation = "namespaces"

	// SecretReplicationNamespacesAnnotation is the name of the annotation that defines the namespaces where the annotated resource should be replicated to.
	SecretReplicationNamespacesAnnotation = "replication.schrodit.tech/namespaces"

	// AllNamespacesAnnotation is the name of the annotation that defines that the annotated resource should be replicated to all namespaces.
	AllNamespacesAnnotation = "all"

	// SecretReplicationAllNamespacesAnnotation is the name of the annotation that defines that the annotated resource should be replicated to all namespaces.
	SecretReplicationAllNamespacesAnnotation = "replication.schrodit.tech/all"

	// FromNamespaceAnnotation is the name of the annotation that defines where the defined secret of the ingress should be synced from.
	FromNamespaceAnnotation = "from-namespace"

	// SecretReplicationFromNamespaceAnnotation is the name of the annotation that defines where the defined secret of the ingress should be synced from.
	SecretReplicationFromNamespaceAnnotation = "replication.schrodit.tech/from-namespace"
)

User facing annotations

const SecretReplicationLastObservedHashAnnotation = "replication.schrodit.tech/lastObservedHash"

SecretReplicationLastHashAnnotation is the name of the annotation that defines the last observed hash of the replicating secret.

const SecretReplicationReplicaOfAnnotation = "replication.schrodit.tech/replicaOf"

SecretReplicationReplicaOfAnnotation is the name of the annotation that defines the source resource of the current resource.

const Separator = "/"

Variables

var (
	// SecretReplicationNamespacesAnnotations are the names of the annotation that defines the namespaces where the annotated resource should be replicated to.
	SecretReplicationNamespacesAnnotations = NewAnnotationSet(NamespacesAnnotation, DefaultAnnotationPrefix)

	// SecretReplicationAllNamespacesAnnotations are the names of the annotation that defines that the annotated resource should be replicated to all namespaces.
	SecretReplicationAllNamespacesAnnotations = NewAnnotationSet(AllNamespacesAnnotation, DefaultAnnotationPrefix)

	// SecretReplicationFromNamespaceAnnotations are the names of the annotation that defines where the defined secret of the ingress should be synced from.
	SecretReplicationFromNamespaceAnnotations = NewAnnotationSet(FromNamespaceAnnotation, DefaultAnnotationPrefix)
)

Types

type AnnotationSet

type AnnotationSet struct {
	Default string
	Key     string
	// contains filtered or unexported fields
}

func NewAnnotationSet

func NewAnnotationSet(key string, defaultAnn string) *AnnotationSet

NewAnnotationSet creates a new annotation set.

func (AnnotationSet) Add

func (s AnnotationSet) Add(prefix string) string

Add adds multiple annotation prefixes.

func (AnnotationSet) Get

func (s AnnotationSet) Get(annotations map[string]string) (string, bool)

Get returns the value of one of the matching annotations. Returns false if no annotations matches.

func (AnnotationSet) List

func (s AnnotationSet) List() []string

List returns all annotations as list.

func (*AnnotationSet) Reset

func (s *AnnotationSet) Reset()

Reset resets to the default annotation