spec

Documentation

Index

• func ToYAML(sp *JobSpec) ([]byte, error)
• type ArtifactConfig
• type CreateJobArgs
• type CronSpec
• type JobSpec
  • func FromYAML(yamlBytes []byte) (*JobSpec, error)
• type PrepareConfig

Functions

func ToYAML

func ToYAML(sp *JobSpec) ([]byte, error)

Types

type ArtifactConfig

type ArtifactConfig struct {
	Url string `json:"url"`
	// Local is the file name need to upload in client machine(local machine)
	// this field is only used by client
	Local string `json:"local"`
}

type CreateJobArgs

type CreateJobArgs struct {
	Name        string `json:"name,omitempty"`
	Shell       bool   `json:"shell,omitempty"`
	Image       string `json:"image,omitempty"`
	Command     string `json:"command,omitempty"`
	GPU         int    `json:"gpu,omitempty"`
	AutoRestart bool   `json:"auto_restart,omitempty"`
	Comment     string `json:"comment,omitempty"`
	Spec        string `json:"spec,omitempty"`
	Cluster     string `json:"cluster"`
}

type CronSpec

type CronSpec struct {
	// The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
	Schedule string `json:"schedule"`

	// Optional deadline in seconds for starting the job if it misses scheduled
	// time for any reason.  Missed jobs executions will be counted as failed ones.
	// +optional
	StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty"`

	// Specifies how to treat concurrent executions of a Job.
	// Valid values are:
	// - "Allow" (default): allows CronJobs to run concurrently;
	// - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet;
	// - "Replace": cancels currently running job and replaces it with a new one
	// +optional
	ConcurrencyPolicy string `json:"concurrencyPolicy,omitempty"`

	// This flag tells the controller to suspend subsequent executions, it does
	// not apply to already started executions.  Defaults to false.
	// +optional
	Suspend *bool `json:"suspend,omitempty"`

	// The number of successful finished jobs to retain.
	// This is a pointer to distinguish between explicit zero and not specified.
	// Defaults to 3.
	// +optional
	SuccessfulJobsHistoryLimit *int32 `json:"successfulJobsHistoryLimit,omitempty"`

	// The number of failed finished jobs to retain.
	// This is a pointer to distinguish between explicit zero and not specified.
	// Defaults to 1.
	// +optional
	FailedJobsHistoryLimit *int32 `json:"failedJobsHistoryLimit,omitempty"`
}

type JobSpec

type JobSpec struct {
	Name        string            `json:"name"`
	Containers  []apiv1.Container `json:"containers"`
	Cron        *CronSpec         `json:"cron,omitempty"`
	Prepare     *PrepareConfig    `json:"prepare,omitempty"`
	AutoRestart bool              `json:"auto_restart,omitempty"`

	// Specifies the maximum desired number of pods the job should
	// run at any given time. The actual number of pods running in steady state will
	// be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),
	// i.e. when the work left to do is less than max parallelism.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	// +optional
	Parallelism *int32 `json:"parallelism,omitempty"`

	// Specifies the desired number of successfully finished pods the
	// job should be run with.  Setting to nil means that the success of any
	// pod signals the success of all pods, and allows parallelism to have any positive
	// value.  Setting to 1 means that parallelism is limited to 1 and the success of that
	// pod signals the success of the job.
	// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
	// +optional
	Completions *int32 `json:"completions,omitempty"`

	// Specifies the duration in seconds relative to the startTime that the job may be active
	// before the system tries to terminate it; value must be positive integer
	// +optional
	ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty"`

	// Specifies the number of retries before marking this job failed.
	// Defaults to 6
	// +optional
	BackoffLimit *int32 `json:"backoffLimit,omitempty" protobuf:"varint,7,opt,name=backoffLimit"`

	// ttlSecondsAfterFinished limits the lifetime of a Job that has finished
	// execution (either Complete or Failed). If this field is set,
	// ttlSecondsAfterFinished after the Job finishes, it is eligible to be
	// automatically deleted. When the Job is being deleted, its lifecycle
	// guarantees (e.g. finalizers) will be honored. If this field is unset,
	// the Job won't be automatically deleted. If this field is set to zero,
	// the Job becomes eligible to be deleted immediately after it finishes.
	// This field is alpha-level and is only honored by servers that enable the
	// TTLAfterFinished feature.
	// +optional
	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty"`
}

func FromYAML

func FromYAML(yamlBytes []byte) (*JobSpec, error)

type PrepareConfig

type PrepareConfig struct {
	Artifacts []ArtifactConfig `json:"artifacts"`
	Image     string           `json:"image"`
	Command   string           `json:"command"`
	Shell     bool             `json:"shell"`
}