kubejob

Sep 5, 2023

Changes in this version

type AgentConfig

+ func (c *AgentConfig) SetTimeout(timeout time.Duration)

+ func (c *AgentConfig) Timeout() string

type Job

+ func (j *Job) SetWatchTimeoutSecond(watchTimeoutSecond int64)

+ type JobFinalizer struct

+ Container corev1.Container

+ Handler JobFinalizerHandler

+ type JobFinalizerHandler func(context.Context, *JobExecutor) error

Aug 17, 2023

Changes in this version

type Job

+ func (j *Job) SetDeletePropagationPolicy(propagation metav1.DeletionPropagation)

Dec 7, 2022

Changes in this version

+ type ErrorType int

+ const CleanupErrorType

+ const CommandErrorType

+ const CopyErrorType

+ const FailedJobType

+ const JobCreationErrorType

+ const JobStopContainerErrorType

+ const JobUnexpectedErrorType

+ const JobWatchErrorType

+ const LogStreamErrorType

+ const PendingPhaseTimeoutErrorType

+ const PreInitErrorType

+ const ValidationErrorType

+ type JobMultiError struct

+ Errs []error

+ func (e *JobMultiError) Error() string

+ func (e *JobMultiError) Has(typ ErrorType) bool

+ type JobUnexpectedError struct

+ Pod *corev1.Pod

+ func (e *JobUnexpectedError) Error() string

Jun 27, 2022

Changes in this version

type AgentConfig

+ func (c *AgentConfig) Enabled(containerName string) bool

+ func (c *AgentConfig) InstalledPath(containerName string) string

type JobExecutor

+ func (e *JobExecutor) EnabledAgent() bool

Jun 6, 2022

Changes in this version

+ type AgentClient struct

+ func NewAgentClient(agentServerPod *corev1.Pod, listenPort uint16, workingDir, signedToken string) (*AgentClient, error)

+ func (c *AgentClient) CopyFrom(ctx context.Context, srcPath, dstPath string) error

+ func (c *AgentClient) CopyTo(ctx context.Context, srcPath, dstPath string) error

+ func (c *AgentClient) Exec(ctx context.Context, command []string, env []corev1.EnvVar) (*AgentExecResult, error)

+ func (c *AgentClient) Stop(ctx context.Context) error

+ type AgentConfig struct

+ func NewAgentConfig(path string) (*AgentConfig, error)

+ func (c *AgentConfig) IssueJWT() ([]byte, error)

+ func (c *AgentConfig) NewAllocatedPort() (uint16, error)

+ func (c *AgentConfig) PublicKeyEnv() corev1.EnvVar

+ func (c *AgentConfig) SetAllocationStartPort(port uint16)

+ func (c *AgentConfig) SetExcludePorts(ports ...uint16)

+ type AgentExecResult struct

+ ElapsedTimeSec int64

+ ErrorMessage string

+ ExitCode int32

+ Output string

+ Success bool

+ type AgentServer struct

+ func NewAgentServer(port uint16) *AgentServer

+ func (s *AgentServer) CopyFrom(req *agent.CopyFromRequest, stream agent.Agent_CopyFromServer) error

+ func (s *AgentServer) CopyTo(stream agent.Agent_CopyToServer) error

+ func (s *AgentServer) Exec(ctx context.Context, req *agent.ExecRequest) (*agent.ExecResponse, error)

+ func (s *AgentServer) Finish(ctx context.Context, req *agent.FinishRequest) (*agent.FinishResponse, error)

+ func (s *AgentServer) Run(ctx context.Context) error

type CommandError

+ Message string

type Job

+ func (j *Job) UseAgent(agentCfg *AgentConfig)

Mar 17, 2022

Changes in this version

type JobExecutor

+ func (e *JobExecutor) TerminationLog(log string) error

Oct 6, 2021

Changes in this version

type Job

+ func (j *Job) SetPendingPhaseTimeout(timeout time.Duration)

+ type PendingPhaseTimeoutError struct

+ StartedAt time.Time

+ Timeout time.Duration

+ func (e *PendingPhaseTimeoutError) Error() string

Sep 29, 2021

Changes in this version

+ const DefaultContainerName

+ const DefaultJobName

+ const SelectorLabel

+ type CleanupError struct

+ Errs []error

+ JobName string

+ func (e *CleanupError) Error() string

+ type CommandError struct

+ ReaderErr error

+ WriterErr error

+ func (e *CommandError) Error() string

+ func (e *CommandError) IsExitError() bool

+ type CopyError struct

+ DstPath string

+ Err error

+ SrcPath string

+ func (e *CopyError) Error() string

type FailedJob

+ Reason error

type Job

+ func (j *Job) PreInit(c corev1.Container, cb func(exec *JobExecutor) error)

+ func (j *Job) SetInitContainerExecutionHandler(handler JobInitContainerExecutionHandler) error

+ func (j *Job) SetLogLevel(level LogLevel)

+ type JobCreationError struct

+ Err error

+ JobGenerateName string

+ JobName string

+ func (e *JobCreationError) Error() string

type JobExecutor

+ ContainerIdx int

+ func (e *JobExecutor) CopyFromPod(srcPath, dstPath string) error

+ func (e *JobExecutor) CopyToPod(srcPath, dstPath string) error

+ type JobInitContainerExecutionHandler func(*JobExecutor) error

+ type JobStopContainerError struct

+ Reason error

+ func (e *JobStopContainerError) Error() string

+ type JobWatchError struct

+ Err error

+ JobName string

+ func (e *JobWatchError) Error() string

+ type LogLevel int

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelNone

+ const LogLevelWarn

+ func (l LogLevel) String() string

+ type LogStreamError struct

+ Container corev1.Container

+ Err error

+ InitContainer bool

+ JobName string

+ Pod *corev1.Pod

+ func (e *LogStreamError) Error() string

+ type PreInitError struct

+ Err error

+ func (e *PreInitError) Error() string

+ type ValidationError struct

+ Err error

+ Required string

+ func (e *ValidationError) Error() string

Jul 8, 2021

Changes in this version

type JobExecutor

+ func (e *JobExecutor) ExecPrepareCommand(cmd []string) ([]byte, error)

Feb 25, 2021

Changes in this version

type JobExecutor

+ func (e *JobExecutor) IsRunning() bool

Feb 25, 2021

Changes in this version

type JobExecutor

+ func (e *JobExecutor) ExecOnly() ([]byte, error)

Dec 18, 2020

Changes in this version

+ const ExecRetryCount

+ const KubejobLabel

+ type ContainerLog struct

+ Container core.Container

+ IsFinished bool

+ Log string

+ Pod *core.Pod

+ type ContainerLogger func(*ContainerLog)

+ type FailedJob struct

+ Pod *core.Pod

+ func (j *FailedJob) Error() string

+ func (j *FailedJob) FailedContainerNames() []string

+ func (j *FailedJob) FailedContainers() []core.Container

+ type Job struct

+ func (j *Job) DisableCommandLog()

+ func (j *Job) DisableContainerLog()

+ func (j *Job) DisableInitCommandLog()

+ func (j *Job) DisableInitContainerLog()

+ func (j *Job) Run(ctx context.Context) (e error)

+ func (j *Job) RunWithExecutionHandler(ctx context.Context, handler JobExecutionHandler) error

+ func (j *Job) SetContainerLogger(logger ContainerLogger)

+ func (j *Job) SetLogger(logger Logger)

+ func (j *Job) SetVerboseLog(verboseLog bool)

+ type JobBuilder struct

+ func NewJobBuilder(config *rest.Config, namespace string) *JobBuilder

+ func (b *JobBuilder) Build() (*Job, error)

+ func (b *JobBuilder) BuildWithJob(jobSpec *batch.Job) (*Job, error)

+ func (b *JobBuilder) BuildWithReader(r io.Reader) (*Job, error)

+ func (b *JobBuilder) SetCommand(cmd []string) *JobBuilder

+ func (b *JobBuilder) SetImage(image string) *JobBuilder

+ type JobExecutionHandler func([]*JobExecutor) error

+ type JobExecutor struct

+ Container core.Container

+ Pod *core.Pod

+ func (e *JobExecutor) Exec() ([]byte, error)

+ func (e *JobExecutor) ExecAsync() error

+ func (e *JobExecutor) Stop() error

+ type Logger func(string)