k8sutil

Documentation

Index

• Constants
• func CascadeDeleteOptions(gracePeriodSeconds int64) *metav1.DeleteOptions
• func CommonLabelInKFStyle(kind string, commonLabel string) string
• func FilterActivePods(pods []*v1.Pod) []*v1.Pod
• func FilterPodCount(pods []*v1.Pod, phase v1.PodPhase) int32
• func GetClusterConfig() (*rest.Config, error)
• func GetReplicaType(pod *v1.Pod, ownerKind string) (rtype string, ok bool)
• func GetTotalAvtiveReplicas(replicas map[apiv1.ReplicaType]*apiv1.ReplicaStatus) int32
• func GetTotalFailedReplicas(replicas map[apiv1.ReplicaType]*apiv1.ReplicaStatus) int32
• func GetTotalReplicas(replicas map[apiv1.ReplicaType]*apiv1.ReplicaSpec) int32
• func IsKubernetesResourceAlreadyExistError(err error) bool
• func IsKubernetesResourceNotFoundError(err error) bool
• func IsPodActive(p *v1.Pod) bool
• func MustNewKubeClient() kubernetes.Interface
• func ResolveDependentOwner(metaObj metav1.Object) *metav1.OwnerReference
• type CRDClient
• type CRDRestClient
  • func NewCRDRestClient(version *schema.GroupVersion) (*CRDRestClient, error)
  • func (c *CRDRestClient) Client() *http.Client
  • func (c *CRDRestClient) Update(obj *metav1unstructured.Unstructured, plural string) error
  • func (c *CRDRestClient) UpdateStatus(obj *metav1unstructured.Unstructured, plural string) error

Constants

const RecommendedConfigPathEnvVar = "KUBECONFIG"

RecommendedConfigPathEnvVar is a environment variable for path configuration

Functions

func CascadeDeleteOptions

func CascadeDeleteOptions(gracePeriodSeconds int64) *metav1.DeleteOptions

TODO(jlewi): CascadeDeletOptions are part of garbage collection policy. CascadeDeleteOptions deletes the workload after the grace period Do we want to use this? See https://kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/

func CommonLabelInKFStyle

func CommonLabelInKFStyle(kind string, commonLabel string) string

CommonLabelInKFStyle convert a common formatted label to kubeflow style, e.g: TFJob => tf-replica-type, PyTorchJob => pytorch-replica-type

func FilterActivePods

func FilterActivePods(pods []*v1.Pod) []*v1.Pod

FilterActivePods returns pods that have not terminated.

func FilterPodCount

func FilterPodCount(pods []*v1.Pod, phase v1.PodPhase) int32

filterPodCount returns pods based on their phase.

func GetClusterConfig

func GetClusterConfig() (*rest.Config, error)

GetClusterConfig obtain the config from the Kube configuration used by kubeconfig, or from k8s cluster.

func GetReplicaType

func GetReplicaType(pod *v1.Pod, ownerKind string) (rtype string, ok bool)

func GetTotalAvtiveReplicas

func GetTotalAvtiveReplicas(replicas map[apiv1.ReplicaType]*apiv1.ReplicaStatus) int32

func GetTotalFailedReplicas

func GetTotalFailedReplicas(replicas map[apiv1.ReplicaType]*apiv1.ReplicaStatus) int32

func GetTotalReplicas

func GetTotalReplicas(replicas map[apiv1.ReplicaType]*apiv1.ReplicaSpec) int32

func IsKubernetesResourceAlreadyExistError

func IsKubernetesResourceAlreadyExistError(err error) bool

IsKubernetesResourceAlreadyExistError throws error when kubernetes resources already exist.

func IsKubernetesResourceNotFoundError

func IsKubernetesResourceNotFoundError(err error) bool

IsKubernetesResourceNotFoundError throws error when there is no kubernetes resource found.

func IsPodActive

func IsPodActive(p *v1.Pod) bool

func MustNewKubeClient

func MustNewKubeClient() kubernetes.Interface

MustNewKubeClient returns new kubernetes client for cluster configuration

func ResolveDependentOwner

func ResolveDependentOwner(metaObj metav1.Object) *metav1.OwnerReference

Types

type CRDClient

type CRDClient interface {
	// Update a Job.
	Update(obj *metav1unstructured.Unstructured) error
}

CRDRestClient defines an interface for working with CRDs using the REST client. In most cases we want to use the auto-generated clientset for specific CRDs. The only exception is when the CRD spec is invalid and we can't parse the type into the corresponding go struct.

type CRDRestClient

type CRDRestClient struct {
	// contains filtered or unexported fields
}

CRDRestClient uses the Kubernetes rest interface to talk to the CRD.

func NewCRDRestClient

func NewCRDRestClient(version *schema.GroupVersion) (*CRDRestClient, error)

func (*CRDRestClient) Client

func (c *CRDRestClient) Client() *http.Client

HttpClient returns the http client used.

func (*CRDRestClient) Update

func (c *CRDRestClient) Update(obj *metav1unstructured.Unstructured, plural string) error

func (*CRDRestClient) UpdateStatus

func (c *CRDRestClient) UpdateStatus(obj *metav1unstructured.Unstructured, plural string) error