apiv2

Documentation

Index

• func GetRadixBatchJobStatusFromPhase(job radixv1.RadixBatchJob, phase radixv1.RadixBatchJobPhase) (status common.ProgressStatus)
• func GetRadixBatchStatus(radixBatch *radixv1.RadixBatch) (status common.ProgressStatus)
• type CompletedRadixBatches
• type Handler
  • func New(kube *kube.Kube, env *models.Env) Handler

Functions

func GetRadixBatchJobStatusFromPhase

func GetRadixBatchJobStatusFromPhase(job radixv1.RadixBatchJob, phase radixv1.RadixBatchJobPhase) (status common.ProgressStatus)

GetRadixBatchJobStatusFromPhase Get batch job status by job phase

func GetRadixBatchStatus

func GetRadixBatchStatus(radixBatch *radixv1.RadixBatch) (status common.ProgressStatus)

GetRadixBatchStatus Gets the batch status

Types

type CompletedRadixBatches

type CompletedRadixBatches struct {
	SucceededRadixBatches    []*modelsv2.RadixBatch
	NotSucceededRadixBatches []*modelsv2.RadixBatch
	SucceededSingleJobs      []*modelsv2.RadixBatch
	NotSucceededSingleJobs   []*modelsv2.RadixBatch
}

CompletedRadixBatches Completed RadixBatch lists

type Handler

type Handler interface {
	// GetRadixBatches Get status of all batches
	GetRadixBatches(ctx context.Context) ([]modelsv2.RadixBatch, error)
	// GetRadixBatchSingleJobs Get status of all single jobs
	GetRadixBatchSingleJobs(ctx context.Context) ([]modelsv2.RadixBatch, error)
	// GetRadixBatch Get a batch
	GetRadixBatch(ctx context.Context, batchName string) (*modelsv2.RadixBatch, error)
	// CreateRadixBatch Create a batch with parameters
	CreateRadixBatch(ctx context.Context, batchScheduleDescription *common.BatchScheduleDescription) (*modelsv2.RadixBatch, error)
	// CopyRadixBatch Copy a batch with deployment and optional parameters
	CopyRadixBatch(ctx context.Context, batchName, deploymentName string) (*modelsv2.RadixBatch, error)
	// CreateRadixBatchSingleJob Create a batch with single job parameters
	CreateRadixBatchSingleJob(ctx context.Context, jobScheduleDescription *common.JobScheduleDescription) (*modelsv2.RadixBatch, error)
	// CopyRadixBatchSingleJob Copy a batch with single job parameters
	CopyRadixBatchSingleJob(ctx context.Context, batchName, jobName, deploymentName string) (*modelsv2.RadixBatch, error)
	// MaintainHistoryLimit Delete outdated batches
	MaintainHistoryLimit(ctx context.Context) error
	// GarbageCollectPayloadSecrets Delete orphaned payload secrets
	GarbageCollectPayloadSecrets(ctx context.Context) error
	// DeleteRadixBatch Delete a batch
	DeleteRadixBatch(ctx context.Context, batchName string) error
	// StopRadixBatch Stop a batch
	StopRadixBatch(ctx context.Context, batchName string) error
	// StopRadixBatchJob Stop a batch job
	StopRadixBatchJob(ctx context.Context, batchName string, jobName string) error
}

func New

func New(kube *kube.Kube, env *models.Env) Handler

New Constructor of the batch handler