constants

const (
	// This is the default version in the Makefile.
	DeveloperVersion = "0.0.0"

	// PrincipalPrefix is a prefix that is applied to labels and annotations
	// that extend availabile identity information.  Resources may have metadata,
	// like organization and project scoping, and this is always set to either the user,
	// that directly created it, or the service that created it acting on the user's
	// behalf. Where an intermediate service is acting on the user's behalf and not
	// and provisoning in a private organization for sercurity or operational reasons,
	// we may also need access to that user's (principal's) metdata such as organization
	// to attribute quota allocations or billing information.
	PrincipalPrefix = "principal."

	// NameLabel is attached to every resource to give it a mutable display
	// name.  While the character set is limited to [0-9A-Za-z_-.] it is at least
	// indexed in etcd which gives us another string to our bow.
	NameLabel = "unikorn-cloud.org/name"

	// DescriptionAnnotation is optionally attached to a resource to allow
	// an unconstriained and verbose description about the resource.
	DescriptionAnnotation = "unikorn-cloud.org/description"

	// CreatorAnnotation is optionally attached to a resource to show who
	// created it.
	CreatorAnnotation          = "unikorn-cloud.org/creator"
	CreatorPrincipalAnnotation = PrincipalPrefix + CreatorAnnotation

	// ModifierAnnotation is optionally attached to a resource to show who
	// last modified it.
	ModifierAnnotation          = "unikorn-cloud.org/modifier"
	ModifierPrincipalAnnotation = PrincipalPrefix + ModifierAnnotation

	// ModifiedTimestampAnnotation augments Kubernetes metadata to provide mtime
	// like functionality.
	ModifiedTimestampAnnotation = "unikorn-cloud.org/modifiedTimestamp"

	// KindLabel is used to match a resource that may be owned by a particular kind.
	// For example, projects and cluster managers are modelled on namespaces.  For CPs
	// you have to select based on project and CP name, because of name reuse, but
	// this raises the problem that selecting a project's namespace will match multiple
	// so this provides a concrete type associated with each resource.
	KindLabel = "unikorn-cloud.org/kind"

	// KindLabelValueOrganization is used to denote a resource belongs to this type.
	KindLabelValueOrganization = "organization"

	// KindLabelValueProject is used to denote a resource belongs to this type.
	KindLabelValueProject = "project"

	// KindLabelValueClusterManager is used to denote a resource belongs to this type.
	KindLabelValueClusterManager = "clustermanager"

	// KindLabelValueKubernetesCluster is used to denote a resource belongs to this type.
	KindLabelValueKubernetesCluster = "kubernetescluster"

	// KindLabelValueVirtualKubernetesCluster is used to denote a resource belongs to this type.
	KindLabelValueVirtualKubernetesCluster = "virtualkubernetescluster"

	// KindLabelValueComputeCluster is used to denote a resource belongs to this type.
	KindLabelValueComputeCluster = "baremetalcluster"

	// KindLabelValueApplicationSet is userd to denote a resource belongs to this type.
	KindLabelValueApplicationSet = "applicationset"

	// OrganizationLabel is a label applied to namespaces to indicate it is under
	// control of this tool.  Useful for label selection.
	OrganizationLabel          = "unikorn-cloud.org/organization"
	OrganizationPrincipalLabel = PrincipalPrefix + OrganizationLabel

	// ProjectLabel is a label applied to namespaces to indicate it is under
	// control of this tool.  Useful for label selection.
	ProjectLabel          = "unikorn-cloud.org/project"
	ProjectPrincipalLabel = PrincipalPrefix + ProjectLabel

	// UserLabel allows resources to link to a user ID.
	UserLabel = "unikorn-cloud.org/user"

	// KubernetesClusterLabel is applied to resources to indicate it belongs
	// to a specific cluster.
	KubernetesClusterLabel = "unikorn-cloud.org/kubernetescluster"

	// ComputeClusterLabel is applied to resources to indicate it belongs
	// to a specific cluster.
	ComputeClusterLabel = "unikorn-cloud.org/computecluster"

	// ApplicationLabel is applied to ArgoCD applications to differentiate
	// between them.
	ApplicationLabel = "unikorn-cloud.org/application"

	// ApplicationSetLabel is applied to applications created by application
	// sets to differentiate between them.
	ApplicationSetLabel = "unikorn-cloud.org/applicationset"

	// ApplicationIDLabel is used to lookup applications based on their ID.
	ApplicationIDLabel = "unikorn-cloud.org/application-id"

	// NetworkLabel is used to lookup resources based on network attachment.
	NetworkLabel = "unikorn-cloud.org/network-id"

	// ConfigurationHashAnnotation is used where application owners refuse to
	// poll configuration updates and we (and all other users) are forced into
	// manually restarting services based on a Deployment/DaemonSet changing.
	ConfigurationHashAnnotation = "unikorn-cloud.org/config-hash"

	// IdentityAnnotation tells you the cloud identity (in the context of
	// the region controller) that a resource owns.
	IdentityAnnotation = "unikorn-cloud.org/identity-id"

	// PhysicalNetworkAnnotation tells you the physical network (in the
	// context of a region controller) that a recource owns.
	// Deprecated: use NetworkLabel instead.
	PhysicalNetworkAnnotation = "unikorn-cloud.org/physical-network-id"

	// AllocationAnnotation is used by resources that consume resources that
	// are subject to quotas and link to an allocation.
	AllocationAnnotation = "unikorn-cloud.org/allocation-id"

	// ReferencedResourceKindLabel is used when a resource refers to another,
	// but not necessarily a Kubernetes resource.  It has the added benefit it
	// can be used as a label selector.
	ReferencedResourceKindLabel = "unikorn-cloud.org/resource-kind"

	// ReferencedResourceIDLabel is used when a resource refers to another,
	// but not necessarily a Kubernetes resource.  It has the added benefit it
	// can be used as a label selector.
	ReferencedResourceIDLabel = "unikorn-cloud.org/resource-id"

	// UndefinedName is when the name label needs to be contractually present
	// but it's irrelevant.
	UndefinedName = "undefined"

	// Finalizer is applied to resources that need to be deleted manually
	// and do other complex logic.
	Finalizer = "unikorn"

	// DefaultYieldTimeout allows N seconds for a provisioner to do its thing
	// and report a healthy status before yielding and giving someone else
	// a go.
	DefaultYieldTimeout = 10 * time.Second
)