translate

Documentation

Index

• Constants
• Variables
• func AnnotationsBidirectionalUpdate[T client.Object](event *synccontext.SyncEvent[T], excludedAnnotations ...string) (map[string]string, map[string]string)
• func AnnotationsBidirectionalUpdateFunction[T client.Object](event *synccontext.SyncEvent[T], ...) (map[string]string, map[string]string)
• func ApplyMetadata(fromAnnotations map[string]string, toAnnotations map[string]string, ...) (labels map[string]string, annotations map[string]string)
• func ConvertKindToResource(config *rest.Config, groupVersionKind schema.GroupVersionKind) (schema.GroupVersionResource, error)
• func CopyObjectWithName[T client.Object](obj T, name types.NamespacedName, setOwner bool, excludedAnnotations ...string) T
• func EnsureCRDFromPhysicalCluster(ctx context.Context, pConfig *rest.Config, vConfig *rest.Config, ...) (bool, bool, error)
• func GetOwnerReference(object client.Object) []metav1.OwnerReference
• func HostAnnotations(vObj, pObj client.Object, excluded ...string) map[string]string
• func HostLabel(vLabel string) string
• func HostLabelNamespace(key string) string
• func HostLabelSelector(labelSelector *metav1.LabelSelector) *metav1.LabelSelector
• func HostLabelSelectorNamespace(labelSelector *metav1.LabelSelector) *metav1.LabelSelector
• func HostLabels(vObj, pObj client.Object) map[string]string
• func HostLabelsMap(vLabels, pLabels map[string]string, vNamespace string, isMetadata bool) map[string]string
• func HostMetadata[T client.Object](vObj T, name types.NamespacedName, excludedAnnotations ...string) T
• func IsTranslatedLabel(label string) (string, bool)
• func KindExists(config *rest.Config, groupVersionKind schema.GroupVersionKind) (metav1.APIResource, error)
• func LabelsBidirectionalUpdate[T client.Object](event *synccontext.SyncEvent[T], excludedLabels ...string) (map[string]string, map[string]string)
• func LabelsBidirectionalUpdateFunction[T client.Object](event *synccontext.SyncEvent[T], ...) (map[string]string, map[string]string)
• func LabelsBidirectionalUpdateFunctionMaps(virtualOld, virtual, hostOld, host map[string]string, ...) (map[string]string, map[string]string)
• func LabelsBidirectionalUpdateMaps(virtualOld, virtual, hostOld, host map[string]string, excludedLabels ...string) (map[string]string, map[string]string)
• func MergeLabelSelectors(elems ...*metav1.LabelSelector) *metav1.LabelSelector
• func ResetObjectMetadata(obj metav1.Object)
• func SafeConcatName(name ...string) string
• func SingleNamespaceHostName(name, namespace, suffix string) string
• func Split(s, sep string) (string, string)
• func VirtualAnnotations(pObj, vObj client.Object, excluded ...string) map[string]string
• func VirtualLabel(pLabel string) (string, bool)
• func VirtualLabelSelector(labelSelector *metav1.LabelSelector) *metav1.LabelSelector
• func VirtualLabels(pObj, vObj client.Object) map[string]string
• func VirtualLabelsMap(pLabels, vLabels map[string]string, excluded ...string) map[string]string
• func VirtualMetadata[T client.Object](pObj T, name types.NamespacedName, excludedAnnotations ...string) T
• type ApplyMapsOptions
• type Translator
  • func NewMultiNamespaceTranslator(currentNamespace string) Translator
  • func NewSingleNamespaceTranslator(targetNamespace string) Translator

Constants

const (
	SkipBackSyncInMultiNamespaceMode = "vcluster.loft.sh/skip-backsync"
)

Variables

var (
	NamespaceAnnotation     = "vcluster.loft.sh/object-namespace"
	NameAnnotation          = "vcluster.loft.sh/object-name"
	UIDAnnotation           = "vcluster.loft.sh/object-uid"
	KindAnnotation          = "vcluster.loft.sh/object-kind"
	HostNameAnnotation      = "vcluster.loft.sh/object-host-name"
	HostNamespaceAnnotation = "vcluster.loft.sh/object-host-namespace"
)

var (
	VClusterReleaseLabel = "release"
	NamespaceLabel       = "vcluster.loft.sh/namespace"
	MarkerLabel          = "vcluster.loft.sh/managed-by"
	ControllerLabel      = "vcluster.loft.sh/controlled-by"

	LabelPrefix          = "vcluster.loft.sh/label"
	NamespaceLabelPrefix = "vcluster.loft.sh/ns-label"

	// VClusterName is the vcluster name, usually set at start time
	VClusterName = "suffix"

	ManagedAnnotationsAnnotation = "vcluster.loft.sh/managed-annotations"
	ManagedLabelsAnnotation      = "vcluster.loft.sh/managed-labels"
)

var Owner client.Object

Functions

func AnnotationsBidirectionalUpdate

func AnnotationsBidirectionalUpdate[T client.Object](event *synccontext.SyncEvent[T], excludedAnnotations ...string) (map[string]string, map[string]string)

func AnnotationsBidirectionalUpdateFunction

func AnnotationsBidirectionalUpdateFunction[T client.Object](event *synccontext.SyncEvent[T], transformFromHost, transformToHost func(key string, value interface{}) (string, interface{})) (map[string]string, map[string]string)

func ApplyMetadata

func ApplyMetadata(fromAnnotations map[string]string, toAnnotations map[string]string, fromLabels map[string]string, toLabels map[string]string, excludeAnnotations ...string) (labels map[string]string, annotations map[string]string)

func ConvertKindToResource

func ConvertKindToResource(config *rest.Config, groupVersionKind schema.GroupVersionKind) (schema.GroupVersionResource, error)

func CopyObjectWithName

func CopyObjectWithName[T client.Object](obj T, name types.NamespacedName, setOwner bool, excludedAnnotations ...string) T

func EnsureCRDFromPhysicalCluster

func EnsureCRDFromPhysicalCluster(ctx context.Context, pConfig *rest.Config, vConfig *rest.Config, groupVersionKind schema.GroupVersionKind) (bool, bool, error)

func GetOwnerReference

func GetOwnerReference(object client.Object) []metav1.OwnerReference

func HostAnnotations

func HostAnnotations(vObj, pObj client.Object, excluded ...string) map[string]string

func HostLabel

func HostLabel(vLabel string) string

func HostLabelNamespace

func HostLabelNamespace(key string) string

func HostLabelSelector

func HostLabelSelector(labelSelector *metav1.LabelSelector) *metav1.LabelSelector

func HostLabelSelectorNamespace

func HostLabelSelectorNamespace(labelSelector *metav1.LabelSelector) *metav1.LabelSelector

func HostLabels

func HostLabels(vObj, pObj client.Object) map[string]string

func HostLabelsMap

func HostLabelsMap(vLabels, pLabels map[string]string, vNamespace string, isMetadata bool) map[string]string

func HostMetadata

func HostMetadata[T client.Object](vObj T, name types.NamespacedName, excludedAnnotations ...string) T

func IsTranslatedLabel

func IsTranslatedLabel(label string) (string, bool)

func KindExists

func KindExists(config *rest.Config, groupVersionKind schema.GroupVersionKind) (metav1.APIResource, error)

KindExists returns the api resource for a given CRD. If the kind does not exist, it returns an error.

func LabelsBidirectionalUpdate

func LabelsBidirectionalUpdate[T client.Object](event *synccontext.SyncEvent[T], excludedLabels ...string) (map[string]string, map[string]string)

func LabelsBidirectionalUpdateFunction

func LabelsBidirectionalUpdateFunction[T client.Object](event *synccontext.SyncEvent[T], transformFromHost, transformToHost func(key string, value interface{}) (string, interface{})) (map[string]string, map[string]string)

func LabelsBidirectionalUpdateFunctionMaps

func LabelsBidirectionalUpdateFunctionMaps(virtualOld, virtual, hostOld, host map[string]string, transformFromHost, transformToHost func(key string, value interface{}) (string, interface{})) (map[string]string, map[string]string)

func LabelsBidirectionalUpdateMaps

func LabelsBidirectionalUpdateMaps(virtualOld, virtual, hostOld, host map[string]string, excludedLabels ...string) (map[string]string, map[string]string)

func MergeLabelSelectors

func MergeLabelSelectors(elems ...*metav1.LabelSelector) *metav1.LabelSelector

func ResetObjectMetadata

func ResetObjectMetadata(obj metav1.Object)

ResetObjectMetadata resets the objects metadata except name, namespace and annotations

func SafeConcatName

func SafeConcatName(name ...string) string

func SingleNamespaceHostName

func SingleNamespaceHostName(name, namespace, suffix string) string

func Split

func Split(s, sep string) (string, string)

func VirtualAnnotations

func VirtualAnnotations(pObj, vObj client.Object, excluded ...string) map[string]string

func VirtualLabel

func VirtualLabel(pLabel string) (string, bool)

func VirtualLabelSelector

func VirtualLabelSelector(labelSelector *metav1.LabelSelector) *metav1.LabelSelector

func VirtualLabels

func VirtualLabels(pObj, vObj client.Object) map[string]string

func VirtualLabelsMap

func VirtualLabelsMap(pLabels, vLabels map[string]string, excluded ...string) map[string]string

func VirtualMetadata

func VirtualMetadata[T client.Object](pObj T, name types.NamespacedName, excludedAnnotations ...string) T

Types

type ApplyMapsOptions

type ApplyMapsOptions struct {
	ManagedKeys []string
	ExcludeKeys []string
}

type Translator

type Translator interface {
	// SingleNamespaceTarget signals if we sync all objects into a single namespace
	SingleNamespaceTarget() bool

	// IsManaged checks if the host object is managed by vCluster
	IsManaged(ctx *synccontext.SyncContext, pObj client.Object) bool

	// IsTargetedNamespace checks if the provided namespace is a sync target for vcluster
	IsTargetedNamespace(ctx *synccontext.SyncContext, namespace string) bool

	// MarkerLabelCluster returns the marker label for the cluster scoped object
	MarkerLabelCluster() string

	// HostName returns the host name for a virtual cluster object
	HostName(ctx *synccontext.SyncContext, vName, vNamespace string) types.NamespacedName

	// HostNameShort returns the short host name for a virtual cluster object
	HostNameShort(ctx *synccontext.SyncContext, vName, vNamespace string) types.NamespacedName

	// HostNameCluster returns the host name for a cluster scoped
	// virtual cluster object
	HostNameCluster(vName string) string

	// HostNamespace returns the host namespace for a virtual cluster object
	HostNamespace(ctx *synccontext.SyncContext, vNamespace string) string

	// LabelsToTranslate are the labels that should be translated
	LabelsToTranslate() map[string]bool
}

var Default Translator = &singleNamespace{}

func NewMultiNamespaceTranslator

func NewMultiNamespaceTranslator(currentNamespace string) Translator

func NewSingleNamespaceTranslator

func NewSingleNamespaceTranslator(targetNamespace string) Translator