wr

Documentation

Index

• func SingularityBuildInS3WRInput(s3Path, hash string) (string, error)
• type Error
  • func (e Error) Error() string
• type Runner
  • func New(deployment string) *Runner
  • func (r *Runner) Add(wrInput string) (string, error)
  • func (r *Runner) Status(id string) (WRJobStatus, error)
  • func (r *Runner) Wait(id string) (WRJobStatus, error)
  • func (r *Runner) WaitForRunning(id string) error
• type WRJobStatus

Functions

func SingularityBuildInS3WRInput

func SingularityBuildInS3WRInput(s3Path, hash string) (string, error)

SingularityBuildInS3WRInput returns wr input that could be piped to `wr add` and that would run a singularity build where the working directory is a fuse mount of the given s3Path.

Types

type Error

type Error struct {
	// contains filtered or unexported fields
}

func (Error) Error

func (e Error) Error() string

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

Runner lets you Run() a wr add command.

func New

func New(deployment string) *Runner

New returns a Runner that will use the given wr deployment to wr add jobs during Run().

func (*Runner) Add

func (r *Runner) Add(wrInput string) (string, error)

Run pipes the given wrInput (eg. as produced by SingularityBuildInS3WRInput()) to `wr add`, which adds a job to wr's queue and returns its ID. You should call Wait(ID) to actually wait for the job to finishing running.

The memory defaults to 8GB, time to 8hrs, and if the cmd in the input has previously been run, the cmd will be re-run.

NB: if the cmd is a duplicate of a currently queued job, this will not generate an error, but just return the id of the existing job.

func (*Runner) Status

func (r *Runner) Status(id string) (WRJobStatus, error)

Status returns the status of the wr job with the given internal ID.

Returns WRJobStatusInvalid if the ID wasn't found. Returns WRJobStatusBuried if it failed. Only returns an error if there was a problem getting the status.

func (*Runner) Wait

func (r *Runner) Wait(id string) (WRJobStatus, error)

Wait waits for the given wr job to exit.

func (*Runner) WaitForRunning

func (r *Runner) WaitForRunning(id string) error

WaitForRunning waits until the given wr job either starts running, or exits.

type WRJobStatus

type WRJobStatus int

const (
	WRJobStatusInvalid WRJobStatus = iota
	WRJobStatusDelayed
	WRJobStatusReady
	WRJobStatusReserved
	WRJobStatusRunning
	WRJobStatusLost
	WRJobStatusBuried
	WRJobStatusComplete
)