kubernetes

Documentation

Overview

Package kubernetes provides several helpers to interact with a Kubernetes cluster.

Index

• Constants
• Variables
• func GetBearerToken(authTokenPath string) (string, error)
• func GetCertificateAuthority(certPath string) (*x509.CertPool, error)
• func GetCertificates(certFilePath, keyFilePath string) ([]tls.Certificate, error)
• func GetKubeAPIServerHostname(context.Context) (string, error)
• func ParseCronJobForJob(name string) (string, int)
• func ParseDeploymentForReplicaSet(name string) string
• func TimeWithoutWall(t time.Time) time.Time

Constants

const (
	DefaultServiceAccountPath      = "/var/run/secrets/kubernetes.io/serviceaccount"
	DefaultServiceAccountTokenPath = DefaultServiceAccountPath + "/token"
	DefaultServiceAccountCAPath    = DefaultServiceAccountPath + "/ca.crt"
)

Kubernetes constants

const (
	// EnvTagLabelKey is the label key of the env standard tag
	EnvTagLabelKey = "tags.datadoghq.com/env"
	// ServiceTagLabelKey is the label key of the service standard tag
	ServiceTagLabelKey = "tags.datadoghq.com/service"
	// VersionTagLabelKey is the label key of the version standard tag
	VersionTagLabelKey = "tags.datadoghq.com/version"

	// KubeAppNameLabelKey is the label key of the name of the application
	KubeAppNameLabelKey = "app.kubernetes.io/name"
	// KubeAppInstanceLabelKey is the label key of unique name identifying the instance of an application
	KubeAppInstanceLabelKey = "app.kubernetes.io/instance"
	// KubeAppVersionLabelKey is the label key of the current version of the application
	KubeAppVersionLabelKey = "app.kubernetes.io/version"
	// KubeAppComponentLabelKey is the label key of the component within the architecture
	KubeAppComponentLabelKey = "app.kubernetes.io/component"
	// KubeAppPartOfLabelKey is the label key of the name of a higher level application one's part of
	KubeAppPartOfLabelKey = "app.kubernetes.io/part-of"
	// KubeAppManagedByLabelKey is the label key of the tool being used to manage the operation of an application
	KubeAppManagedByLabelKey = "app.kubernetes.io/managed-by"

	// RcIDAnnotKey is the key of the RC ID annotation
	RcIDAnnotKey = "admission.datadoghq.com/rc.id"

	// RcIDTagName is the key of the RC ID tag
	RcIDTagName = "dd_remote_config_id"

	// RcRevisionAnnotKey is the key of the RC revision annotation
	RcRevisionAnnotKey = "admission.datadoghq.com/rc.rev"

	// RcRevisionTagName is the key of the RC revision tag
	RcRevisionTagName = "dd_remote_config_rev"

	// EnvTagEnvVar is the environment variable of the env standard tag
	EnvTagEnvVar = "DD_ENV"
	// ServiceTagEnvVar is the environment variable of the service standard tag
	ServiceTagEnvVar = "DD_SERVICE"
	// VersionTagEnvVar is the environment variable of the version standard tag
	VersionTagEnvVar = "DD_VERSION"

	// KubeNodeRoleTagName is the role label tag name
	KubeNodeRoleTagName = "kube_node_role"

	// PodKind represents the Pod object kind
	PodKind = "Pod"
	// DeploymentKind represents the Deployment object kind
	DeploymentKind = "Deployment"
	// ReplicaSetKind represents the ReplicaSet object kind
	ReplicaSetKind = "ReplicaSet"
	// ReplicationControllerKind represents the ReplicaSetController object kind
	ReplicationControllerKind = "ReplicationController"
	// StatefulSetKind represents the StatefulSet object kind
	StatefulSetKind = "StatefulSet"
	// DaemonSetKind represents the DaemonSet object kind
	DaemonSetKind = "DaemonSet"
	// JobKind represents the Job object kind
	JobKind = "Job"
	// CronJobKind represents the CronJob object kind
	CronJobKind = "CronJob"
	// ServiceKind represents the ServiceKind object kind
	ServiceKind = "Service"
	// NamespaceKind represents the NamespaceKind object kind
	NamespaceKind = "Namespace"

	// PodTagName represents the pods tag name
	PodTagName = "pod_name"
	// DeploymentTagName represents the Deployment tag name
	DeploymentTagName = "kube_deployment"
	// ReplicaSetTagName represents the ReplicaSet tag name
	ReplicaSetTagName = "kube_replica_set"
	// ReplicationControllerTagName represents the ReplicationController tag name
	ReplicationControllerTagName = "kube_replication_controller"
	// StatefulSetTagName represents the StatefulSet tag name
	StatefulSetTagName = "kube_stateful_set"
	// DaemonSetTagName represents the DaemonSet tag name
	DaemonSetTagName = "kube_daemon_set"
	// JobTagName represents the Job tag name
	JobTagName = "kube_job"
	// CronJobTagName represents the CronJob tag name
	CronJobTagName = "kube_cronjob"
	// ServiceTagName represents the ServiceTagName tag name
	ServiceTagName = "kube_service"
	// NamespaceTagName represents the Namespace tag name
	NamespaceTagName = "kube_namespace"
	// PersistentVolumeClaimTagName represents the PersistentVolumeClaim tag name
	PersistentVolumeClaimTagName = "persistentvolumeclaim"

	// ResourceNameTagName represents any resource tag name
	ResourceNameTagName = "kube_resource_name"
	// ResourceKindTagName represents any resource kind
	ResourceKindTagName = "kube_resource_kind"

	// OwnerRefNameTagName represents any owner ref tag name
	OwnerRefNameTagName = "kube_ownerref_name"
	// OwnerRefKindTagName represents any owner ref kind
	OwnerRefKindTagName = "kube_ownerref_kind"

	// CriContainerNamespaceLabel is the label set on containers by runtimes with Pod Namespace
	CriContainerNamespaceLabel = "io.kubernetes.pod.namespace"
)

const Digits = "1234567890"

Digits holds the digits used for naming replicasets in kubenetes < 1.8

const KubeAllowedEncodeStringAlphaNums = "bcdfghjklmnpqrstvwxz2456789"

KubeAllowedEncodeStringAlphaNums holds the charactes allowed in replicaset names from as parent deployment Taken from https://github.com/kow3ns/kubernetes/blob/96067e6d7b24a05a6a68a0d94db622957448b5ab/staging/src/k8s.io/apimachinery/pkg/util/rand/rand.go#L76

Variables

var KindToTagName = map[string]string{
	PodKind:                   PodTagName,
	DeploymentKind:            DeploymentTagName,
	ReplicaSetKind:            ReplicaSetTagName,
	ReplicationControllerKind: ReplicationControllerTagName,
	StatefulSetKind:           StatefulSetTagName,
	DaemonSetKind:             DaemonSetTagName,
	JobKind:                   JobTagName,
	CronJobKind:               CronJobTagName,
	ServiceKind:               ServiceTagName,
	NamespaceKind:             NamespaceTagName,
}

KindToTagName returns the tag name for a given kubernetes object name

Functions

func GetBearerToken

func GetBearerToken(authTokenPath string) (string, error)

GetBearerToken reads the serviceaccount token

func GetCertificateAuthority

func GetCertificateAuthority(certPath string) (*x509.CertPool, error)

GetCertificateAuthority loads the issuing certificate authority

func GetCertificates

func GetCertificates(certFilePath, keyFilePath string) ([]tls.Certificate, error)

GetCertificates loads the certificate and the private key

func GetKubeAPIServerHostname

func GetKubeAPIServerHostname(context.Context) (string, error)

GetKubeAPIServerHostname returns the hostname from kubeapiserver

func ParseCronJobForJob

func ParseCronJobForJob(name string) (string, int)

ParseCronJobForJob gets the cronjob name from a job, or returns an empty string if no parent cronjob is found. https://github.com/kubernetes/kubernetes/blob/b4e3bd381bd4d7c0db1959341b39558b45187345/pkg/controller/cronjob/utils.go#L156

func ParseDeploymentForReplicaSet

func ParseDeploymentForReplicaSet(name string) string

ParseDeploymentForReplicaSet gets the deployment name from a replicaset, or returns an empty string if no parent deployment is found.

func TimeWithoutWall

func TimeWithoutWall(t time.Time) time.Time

TimeWithoutWall fixes the `wall` issue in unit tests. THIS FUNCTION SHOULD NOT BE USED OUTSIDE OF TESTS. Unstructured serializes time to string in RFC3339 without Nano seconds. when it's parsed back, the Go time.Time does not have the `wall` field as it's used for nanosecs.