Documentation
¶
Overview ¶
Package util provides various helper routines.
Index ¶
- Constants
- func IsFailed(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 LoggerForService(svc *v1.Service, kind string) *log.Entry
- func LoggerForUnstructured(obj *metav1unstructured.Unstructured, kind string) *log.Entry
- func Pformat(value interface{}) string
- func RandString(n int) string
- func UpdateJobConditions(jobStatus *apiv1.JobStatus, conditionType apiv1.JobConditionType, ...) error
- type Counter
Constants ¶
View Source
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" // JobRestartingReason is added in a job when it is restarting. JobRestartingReason = "JobRestarting" // JobFailedValidationReason is added in a job when it failed validation JobFailedValidationReason = "JobFailedValidation" )
View Source
const (
// EnvKubeflowNamespace is a environment variable for namespace when deployed on kubernetes
EnvKubeflowNamespace = "KUBEFLOW_NAMESPACE"
)
Variables ¶
This section is empty.
Functions ¶
func IsSucceeded ¶
IsSucceeded checks if the job is succeeded
func LoggerForKey ¶
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 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 ¶
type Counter ¶
type Counter struct {
// contains filtered or unexported fields
}
func NewCounter ¶
func NewCounter() *Counter
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.