workload

Documentation

Index

• Variables
• func CalculateWorkloadRuntimeObjectName[T string | WorkloadKind | WorkloadKindLowerCase](workloadName string, workloadKind T) string
• func ClientObjectFromWorkloadKind(kind WorkloadKind) client.Object
• func ExtractServiceNameFromAnnotations(annotations map[string]string, defaultName string) string
• func GetInstrumentationLabelTexts(workloadLabels map[string]string, workloadKind string, ...) (workloadText, nsText, decisionText string, sourceInstrumented bool)
• func GetInstrumentationLabelValue(labels map[string]string) *bool
• func GetWorkloadObject(ctx context.Context, objectKey client.ObjectKey, kind WorkloadKind, ...) (metav1.Object, error)
• func IgnoreErrorKindNotSupported(err error) error
• func IsErrorKindNotSupported(err error) bool
• func IsInstrumentationDisabledExplicitly(obj client.Object) bool
• func IsObjectLabeledForInstrumentation(obj client.Object) bool
• func IsWorkloadInstrumentationEffectiveEnabled(ctx context.Context, kubeClient client.Client, obj client.Object) (bool, error)
• type DaemonSetWorkload
  • func (d *DaemonSetWorkload) AvailableReplicas() int32
• type DeploymentWorkload
  • func (d *DeploymentWorkload) AvailableReplicas() int32
• type PodWorkload
  • func PodWorkloadObject(ctx context.Context, pod *corev1.Pod) (*PodWorkload, error)
  • func PodWorkloadObjectOrError(ctx context.Context, pod *corev1.Pod) (*PodWorkload, error)
• type StatefulSetWorkload
  • func (s *StatefulSetWorkload) AvailableReplicas() int32
• type Workload
  • func ObjectToWorkload(obj client.Object) (Workload, error)
• type WorkloadKind
  • func ExtractWorkloadInfoFromRuntimeObjectName(runtimeObjectName string) (workloadName string, workloadKind WorkloadKind, err error)
  • func GetWorkloadFromOwnerReference(ownerReference metav1.OwnerReference) (workloadName string, workloadKind WorkloadKind, err error)
  • func GetWorkloadNameAndKind(ownerName, ownerKind string) (string, WorkloadKind, error)
  • func WorkloadKindFromClientObject(w client.Object) WorkloadKind
  • func WorkloadKindFromLowerCase(lowerCase WorkloadKindLowerCase) WorkloadKind
  • func WorkloadKindFromString(kind string) WorkloadKind
• type WorkloadKindLowerCase
  • func WorkloadKindLowerCaseFromKind(pascalCase WorkloadKind) WorkloadKindLowerCase

Variables

var ErrKindNotSupported = errors.New("workload kind not supported")

Functions

func CalculateWorkloadRuntimeObjectName

func CalculateWorkloadRuntimeObjectName[T string | WorkloadKind | WorkloadKindLowerCase](workloadName string, workloadKind T) string

func ClientObjectFromWorkloadKind

func ClientObjectFromWorkloadKind(kind WorkloadKind) client.Object

ClientObjectFromWorkloadKind returns a new instance of the client object for the given workload kind the returned instance is empty and should be used to fetch the actual object from the k8s api server

func ExtractServiceNameFromAnnotations

func ExtractServiceNameFromAnnotations(annotations map[string]string, defaultName string) string

func GetInstrumentationLabelTexts

func GetInstrumentationLabelTexts(workloadLabels map[string]string, workloadKind string, nsLabels map[string]string) (workloadText, nsText, decisionText string, sourceInstrumented bool)

func GetInstrumentationLabelValue

func GetInstrumentationLabelValue(labels map[string]string) *bool

func GetWorkloadObject

func GetWorkloadObject(ctx context.Context, objectKey client.ObjectKey, kind WorkloadKind, kubeClient client.Client) (metav1.Object, error)

func IgnoreErrorKindNotSupported

func IgnoreErrorKindNotSupported(err error) error

func IsErrorKindNotSupported

func IsErrorKindNotSupported(err error) bool

func IsInstrumentationDisabledExplicitly

func IsInstrumentationDisabledExplicitly(obj client.Object) bool

func IsObjectLabeledForInstrumentation

func IsObjectLabeledForInstrumentation(obj client.Object) bool

func IsWorkloadInstrumentationEffectiveEnabled

func IsWorkloadInstrumentationEffectiveEnabled(ctx context.Context, kubeClient client.Client, obj client.Object) (bool, error)

Types

type DaemonSetWorkload

type DaemonSetWorkload struct {
	*v1.DaemonSet
}

func (*DaemonSetWorkload) AvailableReplicas

func (d *DaemonSetWorkload) AvailableReplicas() int32

type DeploymentWorkload

type DeploymentWorkload struct {
	*v1.Deployment
}

func (*DeploymentWorkload) AvailableReplicas

func (d *DeploymentWorkload) AvailableReplicas() int32

type PodWorkload

type PodWorkload struct {
	Name      string       `json:"name"`
	Namespace string       `json:"namespace"`
	Kind      WorkloadKind `json:"kind"`
}

PodWorkload represents the higher-level controller managing a specific Pod within a Kubernetes cluster. It contains essential details about the controller such as its Name, Namespace, and Kind. 'Kind' refers to the type of controller, which can be a Deployment, StatefulSet, or DaemonSet. This struct is useful for identifying and interacting with the overarching entity that governs the lifecycle and behavior of a Pod, especially in contexts where understanding the relationship between a Pod and its controlling workload is crucial.

func PodWorkloadObject

func PodWorkloadObject(ctx context.Context, pod *corev1.Pod) (*PodWorkload, error)

PodWorkload returns the workload object that manages the provided pod. If the pod is not owned by a controller, it returns a nil workload with no error.

func PodWorkloadObjectOrError

func PodWorkloadObjectOrError(ctx context.Context, pod *corev1.Pod) (*PodWorkload, error)

PodWorkloadObjectOrError is the same as PodWorkloadObject but returns an error if the workload is not found.

type StatefulSetWorkload

type StatefulSetWorkload struct {
	*v1.StatefulSet
}

func (*StatefulSetWorkload) AvailableReplicas

func (s *StatefulSetWorkload) AvailableReplicas() int32

type Workload

type Workload interface {
	client.Object
	AvailableReplicas() int32
}

func ObjectToWorkload

func ObjectToWorkload(obj client.Object) (Workload, error)

type WorkloadKind

type WorkloadKind string

1. the pascal case representation of the workload kind it is used in k8s api objects as the `Kind` field.

const (
	WorkloadKindDeployment  WorkloadKind = "Deployment"
	WorkloadKindDaemonSet   WorkloadKind = "DaemonSet"
	WorkloadKindStatefulSet WorkloadKind = "StatefulSet"
)

func ExtractWorkloadInfoFromRuntimeObjectName

func ExtractWorkloadInfoFromRuntimeObjectName(runtimeObjectName string) (workloadName string, workloadKind WorkloadKind, err error)

func GetWorkloadFromOwnerReference

func GetWorkloadFromOwnerReference(ownerReference metav1.OwnerReference) (workloadName string, workloadKind WorkloadKind, err error)

GetWorkloadFromOwnerReference retrieves both the workload name and workload kind from the provided owner reference.

func GetWorkloadNameAndKind

func GetWorkloadNameAndKind(ownerName, ownerKind string) (string, WorkloadKind, error)

func WorkloadKindFromClientObject

func WorkloadKindFromClientObject(w client.Object) WorkloadKind

func WorkloadKindFromLowerCase

func WorkloadKindFromLowerCase(lowerCase WorkloadKindLowerCase) WorkloadKind

func WorkloadKindFromString

func WorkloadKindFromString(kind string) WorkloadKind

type WorkloadKindLowerCase

type WorkloadKindLowerCase string

2. the lower case representation of the workload kind is used in odigos with the object name for instrumentation config and runtime details

const (
	WorkloadKindLowerCaseDeployment  WorkloadKindLowerCase = "deployment"
	WorkloadKindLowerCaseDaemonSet   WorkloadKindLowerCase = "daemonset"
	WorkloadKindLowerCaseStatefulSet WorkloadKindLowerCase = "statefulset"
)

func WorkloadKindLowerCaseFromKind

func WorkloadKindLowerCaseFromKind(pascalCase WorkloadKind) WorkloadKindLowerCase