api

Dec 21, 2016

Changes in this version

+ const TaskDriverMessage

type TaskEvent

+ DriverMessage string

Nov 16, 2016

Changes in this version

+ const TaskRestartSignal

+ const TaskSetupFailure

+ const TaskSiblingFailed

+ const TaskSignaling

+ const TaskVaultRenewalFailed

+ var NodeDownErr = fmt.Errorf("node down")

type Agent

+ func (a *Agent) InstallKey(key string) (*KeyringResponse, error)

+ func (a *Agent) ListKeys() (*KeyringResponse, error)

+ func (a *Agent) RemoveKey(key string) (*KeyringResponse, error)

+ func (a *Agent) UseKey(key string) (*KeyringResponse, error)

type Allocation

+ PreviousAllocation string

type Config

+ TLSConfig *TLSConfig

+ func (c *Config) ConfigureTLS() error

+ func (c *Config) CopyConfig(address string, tlsEnabled bool) *Config

+ type EphemeralDisk struct

+ Migrate bool

+ SizeMB int

+ Sticky bool

type Job

+ ParentID string

+ VaultToken string

+ type KeyringRequest struct

+ Key string

+ type KeyringResponse struct

+ Keys map[string]int

+ Messages map[string]string

+ NumNodes int

type Node

+ TLSEnabled bool

type Raw

+ func (raw *Raw) Response(endpoint string, q *QueryOptions) (io.ReadCloser, error)

+ type ServerMembers struct

+ DC string

+ Members []*AgentMember

+ Region string

+ ServerName string

type ServiceCheck

+ InitialStatus string

+ type TLSConfig struct

+ CACert string

+ CAPath string

+ ClientCert string

+ ClientKey string

+ Insecure bool

+ TLSServerName string

type Task

+ Templates []*Template

+ Vault *Vault

type TaskEvent

+ DiskLimit int64

+ DiskSize int64

+ FailedSibling string

+ FailsTask bool

+ KillReason string

+ SetupError string

+ TaskSignal string

+ TaskSignalReason string

+ VaultError string

type TaskGroup

+ EphemeralDisk *EphemeralDisk

+ func (g *TaskGroup) RequireDisk(disk *EphemeralDisk) *TaskGroup

type TaskState

+ Failed bool

+ type Template struct

+ ChangeMode string

+ ChangeSignal string

+ DestPath string

+ EmbeddedTmpl string

+ SourcePath string

+ Splay time.Duration

+ type Vault struct

+ ChangeMode string

+ ChangeSignal string

+ Env bool

+ Policies []string

Aug 17, 2016

Changes in this version

+ const OriginEnd

+ const OriginStart

+ const TaskKilling

type AllocFS

+ func (a *AllocFS) Logs(alloc *Allocation, follow bool, task, logType, origin string, offset int64, ...) (<-chan *StreamFrame, error)

+ func (a *AllocFS) Stream(alloc *Allocation, path, origin string, offset int64, cancel <-chan struct{}, ...) (<-chan *StreamFrame, error)

type Config

+ HttpAuth *HttpBasicAuth

+ type FrameReader struct

+ func NewFrameReader(frames <-chan *StreamFrame, cancelCh chan struct{}) *FrameReader

+ func (f *FrameReader) Close() error

+ func (f *FrameReader) Offset() int

+ func (f *FrameReader) Read(p []byte) (n int, err error)

+ func (f *FrameReader) SetUnblockTime(d time.Duration)

+ type HttpBasicAuth struct

+ Password string

+ Username string

type JobListStub

+ JobSummary *JobSummary

+ type JobSummary struct

+ CreateIndex uint64

+ JobID string

+ ModifyIndex uint64

+ Summary map[string]TaskGroupSummary

type Jobs

+ func (j *Jobs) Summary(jobID string, q *QueryOptions) (*JobSummary, *QueryMeta, error)

type Node

+ StatusUpdatedAt int64

type QueryOptions

+ Params map[string]string

type ServiceCheck

+ PortLabel string

+ type StreamFrame struct

+ Data []byte

+ File string

+ FileEvent string

+ Offset int64

+ func (s *StreamFrame) IsHeartbeat() bool

type TaskEvent

+ KillTimeout time.Duration

+ type TaskGroupSummary struct

+ Complete int

+ Failed int

+ Lost int

+ Queued int

+ Running int

+ Starting int

Jun 28, 2016

Changes in this version

+ const RegisterEnforceIndexErrPrefix

+ type AllocResourceUsage struct

+ ResourceUsage *ResourceUsage

+ Tasks map[string]*TaskResourceUsage

+ Timestamp int64

type Allocations

+ func (a *Allocations) Stats(alloc *Allocation, q *QueryOptions) (*AllocResourceUsage, error)

type Client

+ func (c *Client) SetRegion(region string)

+ type CpuStats struct

+ Measured []string

+ Percent float64

+ SystemMode float64

+ ThrottledPeriods uint64

+ ThrottledTime uint64

+ TotalTicks float64

+ UserMode float64

+ type DesiredUpdates struct

+ DestructiveUpdate uint64

+ Ignore uint64

+ InPlaceUpdate uint64

+ Migrate uint64

+ Place uint64

+ Stop uint64

type Evaluation

+ BlockedEval string

+ FailedTGAllocs map[string]*AllocationMetric

+ type FieldDiff struct

+ Annotations []string

+ Name string

+ New string

+ Old string

+ Type string

+ type HostCPUStats struct

+ CPU string

+ Idle float64

+ System float64

+ User float64

+ type HostDiskStats struct

+ Available uint64

+ Device string

+ InodesUsedPercent float64

+ Mountpoint string

+ Size uint64

+ Used uint64

+ UsedPercent float64

+ type HostMemoryStats struct

+ Available uint64

+ Free uint64

+ Total uint64

+ Used uint64

+ type HostStats struct

+ CPU []*HostCPUStats

+ CPUTicksConsumed float64

+ DiskStats []*HostDiskStats

+ Memory *HostMemoryStats

+ Uptime uint64

type Job

+ JobModifyIndex uint64

+ type JobDiff struct

+ Fields []*FieldDiff

+ ID string

+ Objects []*ObjectDiff

+ TaskGroups []*TaskGroupDiff

+ Type string

type JobListStub

+ JobModifyIndex uint64

+ type JobPlanRequest struct

+ Diff bool

+ Job *Job

+ type JobPlanResponse struct

+ Annotations *PlanAnnotations

+ CreatedEvals []*Evaluation

+ Diff *JobDiff

+ FailedTGAllocs map[string]*AllocationMetric

+ JobModifyIndex uint64

+ NextPeriodicLaunch time.Time

type Jobs

+ func (j *Jobs) EnforceRegister(job *Job, modifyIndex uint64, q *WriteOptions) (string, *WriteMeta, error)

+ func (j *Jobs) Plan(job *Job, diff bool, q *WriteOptions) (*JobPlanResponse, *WriteMeta, error)

+ type MemoryStats struct

+ Cache uint64

+ KernelMaxUsage uint64

+ KernelUsage uint64

+ MaxUsage uint64

+ Measured []string

+ RSS uint64

+ Swap uint64

type Nodes

+ func (n *Nodes) Stats(nodeID string, q *QueryOptions) (*HostStats, error)

+ type ObjectDiff struct

+ Fields []*FieldDiff

+ Name string

+ Objects []*ObjectDiff

+ Type string

+ type PlanAnnotations struct

+ DesiredTGUpdates map[string]*DesiredUpdates

type RegisterJobRequest

+ EnforceIndex bool

+ JobModifyIndex uint64

+ type ResourceUsage struct

+ CpuStats *CpuStats

+ MemoryStats *MemoryStats

+ type TaskDiff struct

+ Annotations []string

+ Fields []*FieldDiff

+ Name string

+ Objects []*ObjectDiff

+ Type string

+ type TaskGroupDiff struct

+ Fields []*FieldDiff

+ Name string

+ Objects []*ObjectDiff

+ Tasks []*TaskDiff

+ Type string

+ Updates map[string]uint64

+ type TaskResourceUsage struct

+ Pids map[string]*ResourceUsage

+ ResourceUsage *ResourceUsage

+ Timestamp int64

Apr 22, 2016

Changes in this version

+ const TaskFailedValidation

type AllocFS

+ func (a *AllocFS) Cat(alloc *Allocation, path string, q *QueryOptions) (io.Reader, *QueryMeta, error)

+ type RegisterJobRequest struct

+ Job *Job

type ServiceCheck

+ Args []string

+ Command string

type Status

+ func (s *Status) RegionLeader(region string) (string, error)

type Task

+ User string

type TaskArtifact

+ RelativeDest string

type TaskEvent

+ RestartReason string

+ ValidationError string

Mar 16, 2016

Changes in this version

+ const TaskArtifactDownloadFailed

+ const TaskDownloadingArtifacts

+ const TaskNotRestarting

+ const TaskReceived

+ const TaskRestarting

type NetworkResource

+ IP string

type Task

+ Artifacts []*TaskArtifact

+ type TaskArtifact struct

+ GetterOptions map[string]string

+ GetterSource string

type TaskEvent

+ DownloadError string

+ StartDelay int64

Feb 25, 2016

Changes in this version

+ type AllocFS struct

+ func (a *AllocFS) List(alloc *Allocation, path string, q *QueryOptions) ([]*AllocFileInfo, *QueryMeta, error)

+ func (a *AllocFS) ReadAt(alloc *Allocation, path string, offset int64, limit int64, q *QueryOptions) (io.Reader, *QueryMeta, error)

+ func (a *AllocFS) Stat(alloc *Allocation, path string, q *QueryOptions) (*AllocFileInfo, *QueryMeta, error)

+ type AllocFileInfo struct

+ FileMode string

+ IsDir bool

+ ModTime time.Time

+ Name string

+ Size int64

type Allocation

+ CreateTime int64

type AllocationListStub

+ CreateTime int64

type AllocationMetric

+ NodesAvailable map[string]int

type Allocations

+ func (a *Allocations) PrefixList(prefix string) ([]*AllocationListStub, *QueryMeta, error)

type Client

+ func (c *Client) AllocFS() *AllocFS

+ func (c *Client) System() *System

type Evaluations

+ func (e *Evaluations) PrefixList(prefix string) ([]*Evaluation, *QueryMeta, error)

type Job

+ Periodic *PeriodicConfig

+ func (j *Job) AddPeriodicConfig(cfg *PeriodicConfig) *Job

type JobListStub

+ ParentID string

type Jobs

+ func (j *Jobs) PeriodicForce(jobID string, q *WriteOptions) (string, *WriteMeta, error)

+ func (j *Jobs) PrefixList(prefix string) ([]*JobListStub, *QueryMeta, error)

+ type LogConfig struct

+ MaxFileSizeMB int

+ MaxFiles int

type Node

+ HTTPAddr string

type Nodes

+ func (n *Nodes) PrefixList(prefix string) ([]*NodeListStub, *QueryMeta, error)

+ type PeriodicConfig struct

+ Enabled bool

+ ProhibitOverlap bool

+ Spec string

+ SpecType string

type QueryOptions

+ Prefix string

type RestartPolicy

+ Mode string

+ type System struct

+ func (s *System) GarbageCollect() error

type Task

+ KillTimeout time.Duration

+ LogConfig *LogConfig

+ func (t *Task) SetLogConfig(l *LogConfig) *Task

Dec 18, 2015

Changes in this version

type Allocation

+ Services map[string]string

Dec 11, 2015

Changes in this version

type Node

+ Meta map[string]string

Nov 28, 2015

Changes in this version

type Client

+ func (c *Client) Regions() *Regions

+ type Regions struct

+ func (r *Regions) List() ([]string, error)

Nov 19, 2015

Changes in this version

+ const TaskDriverFailure

+ const TaskKilled

+ const TaskStarted

+ const TaskTerminated

+ type AgentMembersNameSort []*AgentMember

+ func (a AgentMembersNameSort) Len() int

+ func (a AgentMembersNameSort) Less(i, j int) bool

+ func (a AgentMembersNameSort) Swap(i, j int)

type Allocation

+ TaskStates map[string]*TaskState

type AllocationListStub

+ TaskStates map[string]*TaskState

+ type AllocationSort []*Allocation

+ func (a AllocationSort) Len() int

+ func (a AllocationSort) Less(i, j int) bool

+ func (a AllocationSort) Swap(i, j int)

type Constraint

+ func NewConstraint(left, operand, right string) *Constraint

type Job

+ Update *UpdateStrategy

+ type Port struct

+ Label string

+ Value int

+ type RestartPolicy struct

+ Attempts int

+ Delay time.Duration

+ Interval time.Duration

+ func NewRestartPolicy() *RestartPolicy

+ type Service struct

+ Checks []ServiceCheck

+ Id string

+ Name string

+ PortLabel string

+ Tags []string

+ type ServiceCheck struct

+ Id string

+ Interval time.Duration

+ Name string

+ Path string

+ Protocol string

+ Script string

+ Timeout time.Duration

+ Type string

type Task

+ Services []Service

+ type TaskEvent struct

+ DriverError string

+ ExitCode int

+ KillError string

+ Message string

+ Signal int

+ Time int64

+ Type string

type TaskGroup

+ RestartPolicy *RestartPolicy

+ type TaskState struct

+ Events []*TaskEvent

+ State string

+ type UpdateStrategy struct

+ MaxParallel int

+ Stagger time.Duration

Oct 5, 2015

Changes in this version

type Task

+ Env map[string]string

Sep 28, 2015

Changes in this version

+ const JobTypeBatch

+ const JobTypeService

+ type Agent struct

+ func (a *Agent) Datacenter() (string, error)

+ func (a *Agent) ForceLeave(node string) error

+ func (a *Agent) Join(addrs ...string) (int, error)

+ func (a *Agent) Members() ([]*AgentMember, error)

+ func (a *Agent) NodeName() (string, error)

+ func (a *Agent) Region() (string, error)

+ func (a *Agent) Self() (map[string]map[string]interface{}, error)

+ func (a *Agent) Servers() ([]string, error)

+ func (a *Agent) SetServers(addrs []string) error

+ type AgentMember struct

+ Addr string

+ DelegateCur uint8

+ DelegateMax uint8

+ DelegateMin uint8

+ Name string

+ Port uint16

+ ProtocolCur uint8

+ ProtocolMax uint8

+ ProtocolMin uint8

+ Status string

+ Tags map[string]string

+ type AllocIndexSort []*AllocationListStub

+ func (a AllocIndexSort) Len() int

+ func (a AllocIndexSort) Less(i, j int) bool

+ func (a AllocIndexSort) Swap(i, j int)

+ type Allocation struct

+ ClientDescription string

+ ClientStatus string

+ CreateIndex uint64

+ DesiredDescription string

+ DesiredStatus string

+ EvalID string

+ ID string

+ Job *Job

+ JobID string

+ Metrics *AllocationMetric

+ ModifyIndex uint64

+ Name string

+ NodeID string

+ Resources *Resources

+ TaskGroup string

+ TaskResources map[string]*Resources

+ type AllocationListStub struct

+ ClientDescription string

+ ClientStatus string

+ CreateIndex uint64

+ DesiredDescription string

+ DesiredStatus string

+ EvalID string

+ ID string

+ JobID string

+ ModifyIndex uint64

+ Name string

+ NodeID string

+ TaskGroup string

+ type AllocationMetric struct

+ AllocationTime time.Duration

+ ClassExhausted map[string]int

+ ClassFiltered map[string]int

+ CoalescedFailures int

+ ConstraintFiltered map[string]int

+ DimensionExhausted map[string]int

+ NodesEvaluated int

+ NodesExhausted int

+ NodesFiltered int

+ Scores map[string]float64

+ type Allocations struct

+ func (a *Allocations) Info(allocID string, q *QueryOptions) (*Allocation, *QueryMeta, error)

+ func (a *Allocations) List(q *QueryOptions) ([]*AllocationListStub, *QueryMeta, error)

+ type Client struct

+ func NewClient(config *Config) (*Client, error)

+ func (c *Client) Agent() *Agent

+ func (c *Client) Allocations() *Allocations

+ func (c *Client) Evaluations() *Evaluations

+ func (c *Client) Jobs() *Jobs

+ func (c *Client) Nodes() *Nodes

+ func (c *Client) Raw() *Raw

+ func (c *Client) Status() *Status

+ type Config struct

+ Address string

+ HttpClient *http.Client

+ Region string

+ WaitTime time.Duration

+ func DefaultConfig() *Config

+ type Constraint struct

+ Hard bool

+ LTarget string

+ Operand string

+ RTarget string

+ Weight int

+ func HardConstraint(left, operand, right string) *Constraint

+ func SoftConstraint(left, operand, right string, weight int) *Constraint

+ type EvalIndexSort []*Evaluation

+ func (e EvalIndexSort) Len() int

+ func (e EvalIndexSort) Less(i, j int) bool

+ func (e EvalIndexSort) Swap(i, j int)

+ type Evaluation struct

+ CreateIndex uint64

+ ID string

+ JobID string

+ JobModifyIndex uint64

+ ModifyIndex uint64

+ NextEval string

+ NodeID string

+ NodeModifyIndex uint64

+ PreviousEval string

+ Priority int

+ Status string

+ StatusDescription string

+ TriggeredBy string

+ Type string

+ Wait time.Duration

+ type Evaluations struct

+ func (e *Evaluations) Allocations(evalID string, q *QueryOptions) ([]*AllocationListStub, *QueryMeta, error)

+ func (e *Evaluations) Info(evalID string, q *QueryOptions) (*Evaluation, *QueryMeta, error)

+ func (e *Evaluations) List(q *QueryOptions) ([]*Evaluation, *QueryMeta, error)

+ type Job struct

+ AllAtOnce bool

+ Constraints []*Constraint

+ CreateIndex uint64

+ Datacenters []string

+ ID string

+ Meta map[string]string

+ ModifyIndex uint64

+ Name string

+ Priority int

+ Region string

+ Status string

+ StatusDescription string

+ TaskGroups []*TaskGroup

+ Type string

+ func NewBatchJob(id, name, region string, pri int) *Job

+ func NewServiceJob(id, name, region string, pri int) *Job

+ func (j *Job) AddDatacenter(dc string) *Job

+ func (j *Job) AddTaskGroup(grp *TaskGroup) *Job

+ func (j *Job) Constrain(c *Constraint) *Job

+ func (j *Job) SetMeta(key, val string) *Job

+ type JobIDSort []*JobListStub

+ func (j JobIDSort) Len() int

+ func (j JobIDSort) Less(a, b int) bool

+ func (j JobIDSort) Swap(a, b int)

+ type JobListStub struct

+ CreateIndex uint64

+ ID string

+ ModifyIndex uint64

+ Name string

+ Priority int

+ Status string

+ StatusDescription string

+ Type string

+ type Jobs struct

+ func (j *Jobs) Allocations(jobID string, q *QueryOptions) ([]*AllocationListStub, *QueryMeta, error)

+ func (j *Jobs) Deregister(jobID string, q *WriteOptions) (string, *WriteMeta, error)

+ func (j *Jobs) Evaluations(jobID string, q *QueryOptions) ([]*Evaluation, *QueryMeta, error)

+ func (j *Jobs) ForceEvaluate(jobID string, q *WriteOptions) (string, *WriteMeta, error)

+ func (j *Jobs) Info(jobID string, q *QueryOptions) (*Job, *QueryMeta, error)

+ func (j *Jobs) List(q *QueryOptions) ([]*JobListStub, *QueryMeta, error)

+ func (j *Jobs) Register(job *Job, q *WriteOptions) (string, *WriteMeta, error)

+ type NetworkResource struct

+ CIDR string

+ DynamicPorts []string

+ MBits int

+ Public bool

+ ReservedPorts []int

+ type Node struct

+ Attributes map[string]string

+ CreateIndex uint64

+ Datacenter string

+ Drain bool

+ ID string

+ Links map[string]string

+ ModifyIndex uint64

+ Name string

+ NodeClass string

+ Reserved *Resources

+ Resources *Resources

+ Status string

+ StatusDescription string

+ type NodeIndexSort []*NodeListStub

+ func (n NodeIndexSort) Len() int

+ func (n NodeIndexSort) Less(i, j int) bool

+ func (n NodeIndexSort) Swap(i, j int)

+ type NodeListStub struct

+ CreateIndex uint64

+ Datacenter string

+ Drain bool

+ ID string

+ ModifyIndex uint64

+ Name string

+ NodeClass string

+ Status string

+ StatusDescription string

+ type Nodes struct

+ func (n *Nodes) Allocations(nodeID string, q *QueryOptions) ([]*AllocationListStub, *QueryMeta, error)

+ func (n *Nodes) ForceEvaluate(nodeID string, q *WriteOptions) (string, *WriteMeta, error)

+ func (n *Nodes) Info(nodeID string, q *QueryOptions) (*Node, *QueryMeta, error)

+ func (n *Nodes) List(q *QueryOptions) ([]*NodeListStub, *QueryMeta, error)

+ func (n *Nodes) ToggleDrain(nodeID string, drain bool, q *WriteOptions) (*WriteMeta, error)

+ type QueryMeta struct

+ KnownLeader bool

+ LastContact time.Duration

+ LastIndex uint64

+ RequestTime time.Duration

+ type QueryOptions struct

+ AllowStale bool

+ Region string

+ WaitIndex uint64

+ WaitTime time.Duration

+ type Raw struct

+ func (raw *Raw) Delete(endpoint string, out interface{}, q *WriteOptions) (*WriteMeta, error)

+ func (raw *Raw) Query(endpoint string, out interface{}, q *QueryOptions) (*QueryMeta, error)

+ func (raw *Raw) Write(endpoint string, in, out interface{}, q *WriteOptions) (*WriteMeta, error)

+ type Resources struct

+ CPU int

+ DiskMB int

+ IOPS int

+ MemoryMB int

+ Networks []*NetworkResource

+ type Status struct

+ func (s *Status) Leader() (string, error)

+ func (s *Status) Peers() ([]string, error)

+ type Task struct

+ Config map[string]string

+ Constraints []*Constraint

+ Driver string

+ Meta map[string]string

+ Name string

+ Resources *Resources

+ func NewTask(name, driver string) *Task

+ func (t *Task) Constrain(c *Constraint) *Task

+ func (t *Task) Require(r *Resources) *Task

+ func (t *Task) SetConfig(key, val string) *Task

+ func (t *Task) SetMeta(key, val string) *Task

+ type TaskGroup struct

+ Constraints []*Constraint

+ Count int

+ Meta map[string]string

+ Name string

+ Tasks []*Task

+ func NewTaskGroup(name string, count int) *TaskGroup

+ func (g *TaskGroup) AddTask(t *Task) *TaskGroup

+ func (g *TaskGroup) Constrain(c *Constraint) *TaskGroup

+ func (g *TaskGroup) SetMeta(key, val string) *TaskGroup

+ type WriteMeta struct

+ LastIndex uint64

+ RequestTime time.Duration

+ type WriteOptions struct

+ Region string