workload

Documentation

Index

• Variables
• func CalculateWorkloadRuntimeObjectName[T string | k8sconsts.WorkloadKind | k8sconsts.WorkloadKindLowerCase](workloadName string, workloadKind T) string
• func ClientListObjectFromWorkloadKind(kind k8sconsts.WorkloadKind) client.ObjectList
• func ClientObjectFromWorkloadKind(kind k8sconsts.WorkloadKind) client.Object
• func ExtractWorkloadInfoFromRuntimeObjectName(runtimeObjectName string) (workloadName string, workloadKind k8sconsts.WorkloadKind, err error)
• func GetWorkloadFromOwnerReference(ownerReference metav1.OwnerReference) (workloadName string, workloadKind k8sconsts.WorkloadKind, err error)
• func GetWorkloadNameAndKind(ownerName, ownerKind string) (string, k8sconsts.WorkloadKind, error)
• func IgnoreErrorKindNotSupported(err error) error
• func IsErrorKindNotSupported(err error) bool
• func IsInstrumentationDisabledExplicitly(obj client.Object) bool
• func IsObjectLabeledForInstrumentation(obj client.Object) bool
• func IsValidWorkloadKind(kind k8sconsts.WorkloadKind) bool
• func IsWorkloadInstrumentationEffectiveEnabled(ctx context.Context, kubeClient client.Client, obj client.Object) (bool, error)
• func PodWorkloadObject(ctx context.Context, pod *corev1.Pod) (*k8sconsts.PodWorkload, error)
• func PodWorkloadObjectOrError(ctx context.Context, pod *corev1.Pod) (*k8sconsts.PodWorkload, error)
• func WorkloadKindFromClientObject(w client.Object) k8sconsts.WorkloadKind
• func WorkloadKindFromLowerCase(lowerCase k8sconsts.WorkloadKindLowerCase) k8sconsts.WorkloadKind
• func WorkloadKindFromString(kind string) k8sconsts.WorkloadKind
• func WorkloadKindLowerCaseFromKind(pascalCase k8sconsts.WorkloadKind) k8sconsts.WorkloadKindLowerCase
• type DaemonSetWorkload
  • func (d *DaemonSetWorkload) AvailableReplicas() int32
• type DeploymentWorkload
  • func (d *DeploymentWorkload) AvailableReplicas() int32
• type StatefulSetWorkload
  • func (s *StatefulSetWorkload) AvailableReplicas() int32
• type Workload
  • func ObjectToWorkload(obj client.Object) (Workload, error)

Variables

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

Functions

func CalculateWorkloadRuntimeObjectName

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

func ClientListObjectFromWorkloadKind

func ClientListObjectFromWorkloadKind(kind k8sconsts.WorkloadKind) client.ObjectList

func ClientObjectFromWorkloadKind

func ClientObjectFromWorkloadKind(kind k8sconsts.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 ExtractWorkloadInfoFromRuntimeObjectName

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

func GetWorkloadFromOwnerReference

func GetWorkloadFromOwnerReference(ownerReference metav1.OwnerReference) (workloadName string, workloadKind k8sconsts.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, k8sconsts.WorkloadKind, error)

func IgnoreErrorKindNotSupported

func IgnoreErrorKindNotSupported(err error) error

func IsErrorKindNotSupported

func IsErrorKindNotSupported(err error) bool

func IsInstrumentationDisabledExplicitly

func IsInstrumentationDisabledExplicitly(obj client.Object) bool

Deprecated: this should only be used for backward compatibility migration.

func IsObjectLabeledForInstrumentation

func IsObjectLabeledForInstrumentation(obj client.Object) bool

Deprecated: this should only be used for backward compatibility migration.

func IsValidWorkloadKind

func IsValidWorkloadKind(kind k8sconsts.WorkloadKind) bool

func IsWorkloadInstrumentationEffectiveEnabled

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

Deprecated: this should only be used for backward compatibility migration.

func PodWorkloadObject

func PodWorkloadObject(ctx context.Context, pod *corev1.Pod) (*k8sconsts.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) (*k8sconsts.PodWorkload, error)

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

func WorkloadKindFromClientObject

func WorkloadKindFromClientObject(w client.Object) k8sconsts.WorkloadKind

func WorkloadKindFromLowerCase

func WorkloadKindFromLowerCase(lowerCase k8sconsts.WorkloadKindLowerCase) k8sconsts.WorkloadKind

func WorkloadKindFromString

func WorkloadKindFromString(kind string) k8sconsts.WorkloadKind

func WorkloadKindLowerCaseFromKind

func WorkloadKindLowerCaseFromKind(pascalCase k8sconsts.WorkloadKind) k8sconsts.WorkloadKindLowerCase

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 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)