Documentation
¶
Overview ¶
Package util provides various helper routines.
Index ¶
- Constants
- func GenGeneralName(jobName, rtype, index string) string
- func GetClientReaderFromClient(c client.Client) (client.Reader, error)
- func GetCondition(status apiv1.JobStatus, condType apiv1.JobConditionType) *apiv1.JobCondition
- func GetControllerOwnerReference(owners []v1.OwnerReference) v1.OwnerReference
- func HasCondition(status apiv1.JobStatus, condType apiv1.JobConditionType) bool
- func IntPtr(i int) *int
- func IsCreated(status apiv1.JobStatus) bool
- func IsEvicted(status apiv1.JobStatus) bool
- func IsFailed(status apiv1.JobStatus) bool
- func IsRestarting(status apiv1.JobStatus) bool
- func IsRunning(status apiv1.JobStatus) bool
- func IsSucceeded(status apiv1.JobStatus) bool
- func LoggerForJob(job metav1.Object) *log.Entry
- func LoggerForKey(key string) *log.Entry
- func LoggerForPod(pod *v1.Pod, kind string) *log.Entry
- func LoggerForReplica(job metav1.Object, rtype string) *log.Entry
- func LoggerForUnstructured(obj *metav1unstructured.Unstructured, kind string) *log.Entry
- func MergeMap(a, b map[string]string) map[string]string
- func Pformat(value interface{}) string
- func RandString(n int) string
- func Time(s *time.Time) time.Time
- func TimePtr(t time.Time) *time.Time
- func ToPodPointerList(list []corev1.Pod) []*corev1.Pod
- func ToServicePointerList(list []corev1.Service) []*corev1.Service
- func UInt32Ptr(i uint32) *uint32
- func UpdateJobConditions(jobStatus *apiv1.JobStatus, conditionType apiv1.JobConditionType, ...) error
Constants ¶
const ( // JobCreatedReason is added in a job when it is created. JobCreatedReason = "JobCreated" // JobSucceededReason is added in a job when it is succeeded. JobSucceededReason = "JobSucceeded" // JobRunningReason is added in a job when it is running. JobRunningReason = "JobRunning" // JobFailedReason is added in a job when it is failed. JobFailedReason = "JobFailed" // JobRestarting is added in a job when it is restarting. JobRestartingReason = "JobRestarting" // JobEvicted is added in a job when it is evicted. JobEvictedReason = "JobEvicted" )
Variables ¶
This section is empty.
Functions ¶
func GenGeneralName ¶ added in v0.2.0
GenGeneralName generate a name from the given jobName rtype and index.
func GetClientReaderFromClient ¶
getClientReaderFromClient try to extract client reader from client, client reader reads cluster info from api client.
func GetCondition ¶
func GetCondition(status apiv1.JobStatus, condType apiv1.JobConditionType) *apiv1.JobCondition
GetCondition returns the condition with the provided type.
func GetControllerOwnerReference ¶
func GetControllerOwnerReference(owners []v1.OwnerReference) v1.OwnerReference
func HasCondition ¶
func HasCondition(status apiv1.JobStatus, condType apiv1.JobConditionType) bool
func IsRestarting ¶
IsRestarting checks if the job is restarting.
func IsSucceeded ¶
IsSucceeded checks if the job is succeeded.
func LoggerForKey ¶
func LoggerForPod ¶
func LoggerForUnstructured ¶
func LoggerForUnstructured(obj *metav1unstructured.Unstructured, kind string) *log.Entry
func Pformat ¶
func Pformat(value interface{}) string
Pformat returns a pretty format output of any value that can be marshaled to JSON.
func RandString ¶
RandString generates a random string of the desired length.
The string is DNS-1035 label compliant; i.e. its only alphanumeric lowercase. From: https://stackoverflow.com/questions/22892120/how-to-generate-a-random-string-of-a-fixed-length-in-golang
func ToPodPointerList ¶
ToPodPointerList convert pod list to pod pointer list
func ToServicePointerList ¶
ToServicePointerList convert service list to service point list
func UpdateJobConditions ¶
func UpdateJobConditions(jobStatus *apiv1.JobStatus, conditionType apiv1.JobConditionType, reason, message string) error
UpdateJobConditions adds to the jobStatus a new condition if needed, with the conditionType, reason, and message.
Types ¶
This section is empty.
Source Files
Directories