jobqueue

Dec 4, 2024

Changes in this version

type JobDefaults

+ SchedulerQueuesAvoid string

type JobViaJSON

+ SchedulerQueuesAvoid string

Jul 28, 2022

Changes in this version

type Client

+ func (c *Client) DestroyCloudHost(hostName string) ([]*BadServer, []*Job, error)

Nov 30, 2021

Changes in this version

type JStatus

+ ContainerMounts string

+ WithDocker string

+ WithSingularity string

type Job

+ ContainerMounts string

+ WithDocker string

+ WithSingularity string

+ func (j *Job) CmdLine(ctx context.Context) (string, func(), error)

type JobDefaults

+ ContainerMounts string

+ WithDocker string

+ WithSingularity string

type JobModifier

+ ContainerMounts string

+ ContainerMountsSet bool

+ WithDocker string

+ WithDockerSet bool

+ WithSingularity string

+ WithSingularitySet bool

+ func (j *JobModifier) SetContainerMounts(new string)

+ func (j *JobModifier) SetWithDocker(new string)

+ func (j *JobModifier) SetWithSingularity(new string)

type JobViaJSON

+ ContainerMounts string

+ WithDocker string

+ WithSingularity string

Aug 31, 2021

Changes in this version

+ var ClientReleaseDelayMax = 3600 * time.Second

+ var ClientReleaseDelayMin = 30 * time.Second

+ var ClientReleaseDelayStepFactor float64 = 2

type Job

+ DelayTime time.Duration

+ NoRetriesOverWalltime time.Duration

type JobDefaults

+ NoRetriesOverWalltime time.Duration

type JobModifier

+ NoRetriesOverWalltime time.Duration

+ NoRetriesOverWalltimeSet bool

+ func (j *JobModifier) SetNoRetriesOverWalltime(new time.Duration)

type JobViaJSON

+ NoRetriesOverWalltime string

Jul 30, 2021

Changes in this version

+ const ErrS3DBBackupPath

+ var ServerLostJobCheckRetryTime = 30 * time.Minute

+ var ServerLostJobCheckTimeout = 15 * time.Second

Jun 30, 2021

Changes in this version

type Client

+ func ConnectUsingConfig(deployment string, timeout time.Duration, logger log15.Logger) (*Client, error)

May 31, 2021

Changes in this version

type BehaviourAction

+ const Remove

type BehaviourViaJSON

+ Remove bool

type Behaviours

+ func (bs Behaviours) RemovalRequested() bool

type Job

+ func (j *Job) RemovalRequested() bool

Apr 30, 2021

Changes in this version

type Client

+ func (c *Client) GetLimitGroups() (map[string]int, error)

Oct 5, 2020

Changes in this version

+ const ErrClosedCert

Mar 20, 2020

Changes in this version

+ var ClientShutdownTestInterval = 100 * time.Millisecond

+ var ClientShutdownTimeout = 120 * time.Second

+ var ClientSuggestedPingTimeout = 10 * time.Millisecond

+ var ServerMaximumRunForResourceRecommendation = 100

+ var ServerMinimumScheduledForResourceRecommendation = 10

+ var ServerShutdownWaitTime = 5 * time.Second

type Client

+ func (c *Client) AddAndReturnIDs(jobs []*Job, envVars []string, ignoreComplete bool) ([]string, error)

Nov 7, 2019

Changes in this version

type JobDefaults

+ SchedulerMisc string

+ SchedulerQueue string

type JobViaJSON

+ SchedulerMisc string

+ SchedulerQueue string

Aug 1, 2019

Changes in this version

type ServerConfig

+ AutoConfirmDead time.Duration

Apr 8, 2019

Changes in this version

+ const ErrBadLimitGroup

type BehaviourAction

+ const Nothing

type BehaviourViaJSON

+ Nothing bool

type Client

+ func (c *Client) GetOrSetLimitGroup(group string) (int, error)

+ func (c *Client) Modify(jes []*JobEssence, modifier *JobModifier) (modified map[string]string, err error)

type JStatus

+ LimitGroups []string

type Job

+ LimitGroups []string

type JobDefaults

+ LimitGroups []string

+ type JobModifier struct

+ Behaviours Behaviours

+ BehavioursSet bool

+ BsubMode string

+ BsubModeSet bool

+ ChangeHome bool

+ ChangeHomeSet bool

+ Cmd string

+ Cwd string

+ CwdMatters bool

+ CwdMattersSet bool

+ DepGroups []string

+ DepGroupsSet bool

+ Dependencies Dependencies

+ DependenciesSet bool

+ EnvOverride []byte

+ EnvOverrideSet bool

+ LimitGroups []string

+ LimitGroupsSet bool

+ MonitorDocker string

+ MonitorDockerSet bool

+ MountConfigs MountConfigs

+ MountConfigsSet bool

+ Override uint8

+ OverrideSet bool

+ Priority uint8

+ PrioritySet bool

+ ReqGroup string

+ ReqGroupSet bool

+ Requirements *scheduler.Requirements

+ Retries uint8

+ RetriesSet bool

+ func NewJobModifer() *JobModifier

+ func (j *JobModifier) Modify(jobs []*Job) map[string]string

+ func (j *JobModifier) SetBehaviours(new Behaviours)

+ func (j *JobModifier) SetBsubMode(new string)

+ func (j *JobModifier) SetChangeHome(new bool)

+ func (j *JobModifier) SetCmd(cmd string)

+ func (j *JobModifier) SetCwd(cwd string)

+ func (j *JobModifier) SetCwdMatters(new bool)

+ func (j *JobModifier) SetDepGroups(new []string)

+ func (j *JobModifier) SetDependencies(new Dependencies)

+ func (j *JobModifier) SetEnvOverride(new string) error

+ func (j *JobModifier) SetLimitGroups(new []string)

+ func (j *JobModifier) SetMonitorDocker(new string)

+ func (j *JobModifier) SetMountConfigs(new MountConfigs)

+ func (j *JobModifier) SetOverride(new uint8)

+ func (j *JobModifier) SetPriority(new uint8)

+ func (j *JobModifier) SetReqGroup(new string)

+ func (j *JobModifier) SetRequirements(req *scheduler.Requirements)

+ func (j *JobModifier) SetRetries(new uint8)

type JobViaJSON

+ LimitGrps []string

Jan 14, 2019

Changes in this version

+ const ErrBeingDrained

+ const ServerModePause

type Client

+ func (c *Client) PauseServer() (running int, etc time.Duration, err error)

+ func (c *Client) ResumeServer() error

+ func (c *Client) SetLogger(logger log15.Logger)

type JobDefaults

+ DiskSet bool

type Server

+ func (s *Server) Pause() error

+ func (s *Server) Resume() error

Nov 15, 2018

Changes in this version

+ const ErrStopReserving

+ var ClientRetryTime = 24 * time.Hour

+ var ClientRetryWait = 15 * time.Second

+ var ServerVersion string

+ type BadServer struct

+ Date int64

+ ID string

+ IP string

+ IsBad bool

+ Name string

+ Problem string

type Client

+ func (c *Client) ConfirmCloudServersDead(id string) ([]*BadServer, error)

+ func (c *Client) GetBadCloudServers() ([]*BadServer, error)

type JobDefaults

+ RTimeout int

type JobEndState

+ EndTime time.Time

type JobViaJSON

+ RTimeout *int

type Server

+ ServerVersions *ServerVersions

type ServerConfig

+ DomainMatchesIP bool

+ type ServerVersions struct

+ API string

+ Version string

Aug 7, 2018

Changes in this version

+ const FailReasonDisk

type JStatus

+ PeakDisk int64

type Job

+ PeakDisk int64

+ RequirementsOrig *scheduler.Requirements

type JobEndState

+ PeakDisk int64

May 21, 2018

Changes in this version

+ const FailReasonDocker

+ var BsubID uint64

+ var ClientPercentMemoryKill = 90

+ type JStatus struct

+ Attempts uint32

+ Behaviours string

+ CPUtime float64

+ Cmd string

+ Cores int

+ Cwd string

+ CwdBase string

+ DepGroups []string

+ Dependencies []string

+ Ended int64

+ Env []string

+ Exitcode int

+ Exited bool

+ ExpectedRAM int

+ ExpectedTime float64

+ FailReason string

+ HomeChanged bool

+ Host string

+ HostID string

+ HostIP string

+ Key string

+ MonitorDocker string

+ Mounts string

+ OtherRequests []string

+ PeakRAM int

+ Pid int

+ RepGroup string

+ RequestedDisk int

+ Similar int

+ Started int64

+ State JobState

+ StdErr string

+ StdOut string

+ Walltime float64

type Job

+ BsubID uint64

+ BsubMode string

+ MonitorDocker string

+ func (j *Job) Getenv(key string) string

+ func (j *Job) Key() string

+ func (j *Job) ToStatus() JStatus

type JobDefaults

+ BsubMode string

+ CloudShared bool

+ MonitorDocker string

type JobViaJSON

+ BsubMode string

+ CloudShared bool

+ MonitorDocker string

Apr 27, 2018

Changes in this version

+ const ErrPermissionDenied

type Client

+ func (c *Client) UploadFile(local, remote string) (string, error)

type Job

+ EnvCRetrieved bool

+ func (j *Job) ToEssense() *JobEssence

type JobDefaults

+ CloudConfigFiles string

+ CloudFlavor string

type JobState

+ const JobStateDeletable

type JobViaJSON

+ CloudConfigFiles string

+ CloudFlavor string

type ServerConfig

+ CAFile string

+ CertDomain string

+ CertFile string

+ KeyFile string

+ TokenFile string

+ UploadDir string

Mar 19, 2018

Changes in this version

type Client

+ ServerInfo *ServerInfo

type Job

+ func (j *Job) EnvAddOverride(env []string) error

+ type JobEndState struct

+ CPUtime time.Duration

+ Cwd string

+ Exitcode int

+ Exited bool

+ PeakRAM int

+ Stderr []byte

+ Stdout []byte

type ServerConfig

+ Logger log15.Logger

Oct 27, 2017

Changes in this version

+ const FailReasonKilled

+ const FailReasonLost

type Client

+ func (c *Client) BackupDB(path string) (err error)

+ func (c *Client) Kill(jes []*JobEssence) (killable int, err error)

type Job

+ HostID string

+ HostIP string

+ Lost bool

+ type JobDefaults struct

+ CPUs int

+ ChangeHome bool

+ CloudOS string

+ CloudOSRam int

+ CloudScript string

+ CloudUser string

+ Cwd string

+ CwdMatters bool

+ DepGroups []string

+ Deps Dependencies

+ Disk int

+ Env string

+ Memory int

+ MountConfigs MountConfigs

+ OnExit Behaviours

+ OnFailure Behaviours

+ OnSuccess Behaviours

+ Override int

+ Priority int

+ RepGrp string

+ ReqGrp string

+ Retries int

+ Time time.Duration

+ func (jd *JobDefaults) DefaultCPUs() int

+ func (jd *JobDefaults) DefaultCloudOSRam() string

+ func (jd *JobDefaults) DefaultCwd() string

+ func (jd *JobDefaults) DefaultEnv() []byte

+ func (jd *JobDefaults) DefaultMemory() int

+ func (jd *JobDefaults) DefaultTime() time.Duration

type JobState

+ const JobStateLost

+ type JobViaJSON struct

+ CPUs *int

+ ChangeHome bool

+ CloudOS string

+ CloudOSRam *int

+ CloudScript string

+ CloudUser string

+ Cmd string

+ CmdDeps Dependencies

+ Cwd string

+ CwdMatters bool

+ DepGrps []string

+ Deps []string

+ Disk *int

+ Env []string

+ Memory string

+ MountConfigs MountConfigs

+ OnExit BehavioursViaJSON

+ OnFailure BehavioursViaJSON

+ OnSuccess BehavioursViaJSON

+ Override *int

+ Priority *int

+ RepGrp string

+ ReqGrp string

+ Retries *int

+ Time string

+ func (jvj *JobViaJSON) Convert(jd *JobDefaults) (job *Job, err error)

type Server

+ func (s *Server) BackupDB(w io.Writer) error

Jul 20, 2017

Changes in this version

+ const ErrWrongUser

+ const FailReasonRelease

+ var ServerCheckRunnerTime = 1 * time.Minute

type JobEssence

+ MountConfigs MountConfigs

+ type JobState string

+ const JobStateBuried

+ const JobStateComplete

+ const JobStateDelayed

+ const JobStateDeleted

+ const JobStateDependent

+ const JobStateNew

+ const JobStateReady

+ const JobStateReserved

+ const JobStateRunning

+ const JobStateUnknown

type MountConfigs

+ func (mcs MountConfigs) Key() string

type ServerConfig

+ AllowedUsers []string

type ServerInfo

+ AllowedUsers []string

Jun 7, 2017

Changes in this version

+ const FailReasonMount

+ const FailReasonUpload

+ var AppName = "jobqueue"

+ type Behaviour struct

+ Arg interface{}

+ Do BehaviourAction

+ When BehaviourTrigger

+ func (b *Behaviour) String() string

+ func (b *Behaviour) Trigger(status BehaviourTrigger, j *Job) error

+ type BehaviourAction uint8

+ const Cleanup

+ const CleanupAll

+ const CopyToManager

+ const Run

+ type BehaviourTrigger uint8

+ const OnExit

+ const OnFailure

+ const OnSuccess

+ type BehaviourViaJSON struct

+ Cleanup bool

+ CleanupAll bool

+ CopyToManager []string

+ Run string

+ func (bj BehaviourViaJSON) Behaviour(when BehaviourTrigger) *Behaviour

+ type Behaviours []*Behaviour

+ func (bs Behaviours) String() string

+ func (bs Behaviours) Trigger(success bool, j *Job) error

+ type BehavioursViaJSON []BehaviourViaJSON

+ func (bjs BehavioursViaJSON) Behaviours(when BehaviourTrigger) (bs Behaviours)

type Client

+ func (c *Client) GetByEssence(je *JobEssence, getstd bool, getenv bool) (j *Job, err error)

+ func (c *Client) GetByEssences(jes []*JobEssence) (out []*Job, err error)

type Dependency

+ Essence *JobEssence

+ func NewEssenceDependency(cmd string, cwd string) *Dependency

type Job

+ ActualCwd string

+ Behaviours Behaviours

+ ChangeHome bool

+ CwdMatters bool

+ EndTime time.Time

+ MountConfigs MountConfigs

+ StartTime time.Time

+ func (j *Job) Mount() error

+ func (j *Job) TriggerBehaviours(success bool) error

+ func (j *Job) Unmount(stopUploads ...bool) (logs string, err error)

+ func (j *Job) WallTime() (d time.Duration)

+ type JobEssence struct

+ Cmd string

+ Cwd string

+ JobKey string

+ func (j *JobEssence) Key() string

+ func (j *JobEssence) Stringify() string

+ type MountConfig struct

+ CacheBase string

+ Mount string

+ Retries int

+ Targets []MountTarget

+ Verbose bool

+ type MountConfigs []MountConfig

+ func (mcs MountConfigs) String() string

+ type MountTarget struct

+ Cache bool

+ CacheDir string

+ Path string

+ Profile string

+ Write bool

Jan 26, 2017

Changes in this version

type Client

+ func (c *Client) CompressEnv(envars []string) []byte

type Job

+ EnvOverride []byte

type ServerConfig

+ CIDR string

Jan 19, 2017

Changes in this version

type Job

+ Requirements *scheduler.Requirements

Dec 12, 2016

Changes in this version

type Dependencies

+ func (d *Dependencies) DepGroups() (depGroups []string)

+ func (d *Dependencies) Stringify() (strings []string)

type Dependency

+ DepGroup string

+ func NewCmdDependency(cmd string, cwd string) *Dependency

+ func NewDepGroupDependency(depgroup string) *Dependency

type Job

+ DepGroups []string

Dec 6, 2016

Changes in this version

+ const ErrBadDependency

+ type Dependencies struct

+ Deps []*Dependency

+ func NewDependencies(deps ...*Dependency) *Dependencies

+ func (d *Dependencies) JobKeys() (jobKeys []string)

+ type Dependency struct

+ Cmd string

+ Cwd string

+ func NewDependency(cmd string, cwd string) *Dependency

type Job

+ Dependencies *Dependencies

Oct 21, 2016

Changes in this version

type Job

+ Retries uint8

Oct 14, 2016

Changes in this version

+ const ErrBadJob

+ const ErrBadRequest

+ const ErrClosedInt

+ const ErrClosedStop

+ const ErrClosedTerm

+ const ErrDBError

+ const ErrInternalError

+ const ErrMissingJob

+ const ErrMustReserve

+ const ErrNoHost

+ const ErrNoServer

+ const ErrQueueClosed

+ const ErrUnknown

+ const ErrUnknownCommand

+ const FailReasonAbnormal

+ const FailReasonCExit

+ const FailReasonCFound

+ const FailReasonCPerm

+ const FailReasonCwd

+ const FailReasonEnv

+ const FailReasonExit

+ const FailReasonRAM

+ const FailReasonResource

+ const FailReasonSignal

+ const FailReasonStart

+ const FailReasonTime

+ const ServerModeDrain

+ const ServerModeNormal

+ var ClientReleaseDelay = 30 * time.Second

+ var ClientTouchInterval = 15 * time.Second

+ var RAMIncreaseMin float64 = 1000

+ var RAMIncreaseMultBreakpoint float64 = 8192

+ var RAMIncreaseMultHigh = 1.3

+ var RAMIncreaseMultLow = 2.0

+ var RecMBRound = 100

+ var RecSecRound = 1800

+ var ServerInterruptTime = 1 * time.Second

+ var ServerItemTTR = 60 * time.Second

+ var ServerLogClientErrors = true

+ var ServerReserveTicker = 1 * time.Second

+ func CurrentIP() (ip string)

+ type Client struct

+ func Connect(addr string, queue string, timeout time.Duration) (c *Client, err error)

+ func (c *Client) Add(jobs []*Job) (added int, existed int, err error)

+ func (c *Client) Archive(job *Job) (err error)

+ func (c *Client) Bury(job *Job, failreason string) (err error)

+ func (c *Client) Delete(ccs [][2]string) (deleted int, err error)

+ func (c *Client) Disconnect()

+ func (c *Client) DrainServer() (running int, etc time.Duration, err error)

+ func (c *Client) Ended(job *Job, exitcode int, peakram int, cputime time.Duration, stdout []byte, ...) (err error)

+ func (c *Client) Execute(job *Job, shell string) error

+ func (c *Client) GetByCmd(cmd string, cwd string, getstd bool, getenv bool) (j *Job, err error)

+ func (c *Client) GetByCmds(ccs [][2]string) (out []*Job, err error)

+ func (c *Client) GetByRepGroup(repgroup string, limit int, state string, getStd bool, getEnv bool) (jobs []*Job, err error)

+ func (c *Client) GetIncomplete(limit int, state string, getStd bool, getEnv bool) (jobs []*Job, err error)

+ func (c *Client) Kick(ccs [][2]string) (kicked int, err error)

+ func (c *Client) Ping(timeout time.Duration) bool

+ func (c *Client) Release(job *Job, failreason string, delay time.Duration) (err error)

+ func (c *Client) Reserve(timeout time.Duration) (j *Job, err error)

+ func (c *Client) ReserveScheduled(timeout time.Duration, schedulerGroup string) (j *Job, err error)

+ func (c *Client) ServerStats() (s *ServerStats, err error)

+ func (c *Client) ShutdownServer() bool

+ func (c *Client) Started(job *Job, pid int, host string) (err error)

+ func (c *Client) Touch(job *Job) (err error)

+ type Error struct

+ Err string

+ Item string

+ Op string

+ Queue string

+ func (e Error) Error() string

+ type Job struct

+ Attempts uint32

+ CPUtime time.Duration

+ Cmd string

+ Cores int

+ Cwd string

+ EnvC []byte

+ EnvKey string

+ Exitcode int

+ Exited bool

+ FailReason string

+ Host string

+ Override uint8

+ PeakRAM int

+ Pid int

+ Priority uint8

+ Queue string

+ RAM int

+ RepGroup string

+ ReqGroup string

+ ReservedBy uuid.UUID

+ Similar int

+ State string

+ StdErrC []byte

+ StdOutC []byte

+ Time time.Duration

+ UntilBuried uint8

+ Walltime time.Duration

+ func NewJob(cmd string, cwd string, group string, ram int, time time.Duration, cores int, ...) *Job

+ func (j *Job) Env() (env []string, err error)

+ func (j *Job) StdErr() (stderr string, err error)

+ func (j *Job) StdOut() (stdout string, err error)

+ type Server struct

+ ServerInfo *ServerInfo

+ func Serve(config ServerConfig) (s *Server, msg string, err error)

+ func (s *Server) Block() (err error)

+ func (s *Server) Drain() (err error)

+ func (s *Server) GetServerStats() *ServerStats

+ func (s *Server) HasRunners() bool

+ func (s *Server) Stop() (err error)

+ type ServerConfig struct

+ DBFile string

+ DBFileBackup string

+ Deployment string

+ Port string

+ RunnerCmd string

+ SchedulerConfig interface{}

+ SchedulerName string

+ WebPort string

+ type ServerInfo struct

+ Addr string

+ Deployment string

+ Host string

+ Mode string

+ PID int

+ Port string

+ Scheduler string

+ WebPort string

+ type ServerStats struct

+ Buried int

+ Delayed int

+ ETC time.Duration

+ Ready int

+ Running int

+ ServerInfo *ServerInfo