common

Documentation

Index

• Constants
• Variables
• func IsValidLabelKey(s string) bool

Constants

const (
	// TeleportNamespace is used as the namespace prefix for labels defined by Teleport which can
	// carry metadata such as cloud AWS account or instance. Those labels can be used for RBAC.
	//
	// If a label with this prefix is used in a config file, the associated feature must take into
	// account that the label might be removed, modified or could have been set by the user.
	//
	// See also types.TeleportInternalLabelPrefix and types.TeleportHiddenLabelPrefix.
	TeleportNamespace = "teleport.dev"

	// OriginLabel is a resource metadata label name used to identify a source
	// that the resource originates from.
	OriginLabel = TeleportNamespace + "/origin"

	// OriginDefaults is an origin value indicating that the resource was
	// constructed as a default value.
	OriginDefaults = "defaults"

	// OriginConfigFile is an origin value indicating that the resource is
	// derived from static configuration.
	OriginConfigFile = "config-file"

	// OriginDynamic is an origin value indicating that the resource was
	// committed as dynamic configuration.
	OriginDynamic = "dynamic"

	// OriginCloud is an origin value indicating that the resource was
	// imported from a cloud provider.
	OriginCloud = "cloud"

	// OriginKubernetes is an origin value indicating that the resource was
	// created from the Kubernetes Operator.
	OriginKubernetes = "kubernetes"

	// OriginOkta is an origin value indicating that the resource was
	// created from the Okta service.
	OriginOkta = "okta"

	// OriginSCIM is an Origin value indicating that a resource was provisioned
	// via a SCIM service
	OriginSCIM = "scim"

	// OriginIntegrationAWSOIDC is an origin value indicating that the resource was
	// created from the AWS OIDC Integration.
	OriginIntegrationAWSOIDC = "integration_awsoidc"

	// OriginDiscoveryKubernetes indicates that the resource was imported
	// from kubernetes cluster by discovery service.
	OriginDiscoveryKubernetes = "discovery-kubernetes"

	// OriginEntraID indicates that the resource was imported
	// from the Entra ID directory.
	OriginEntraID = "entra-id"
)

const LabelPattern = `^[a-zA-Z/.0-9_:*-]+$`

LabelPattern is a regexp that describes a valid label key. In this case, valid label keys can consist of alphanumeric characters, forward slashes, periods, underscores, colons, stars, and dashes. Some valid label examples:

label teleport.dev/fine-grained-access teleport.dev/managed:internal_access all-objects*

Variables

var OriginValues = []string{
	OriginDefaults,
	OriginConfigFile,
	OriginDynamic,
	OriginCloud,
	OriginKubernetes,
	OriginOkta,
	OriginSCIM,
	OriginDiscoveryKubernetes,
	OriginEntraID,
}

OriginValues lists all possible origin values.

Functions

func IsValidLabelKey

func IsValidLabelKey(s string) bool

IsValidLabelKey checks if the supplied string matches the label key regexp.