api

package

Go to main page

Versions in this module

v0

v0.8.4-rc1

Jun 1, 2018

v0.7.0

Nov 1, 2017

Changes in this version

+ const DefaultNamespace

+ const TaskBuildingTaskDir

+ const TaskGenericMessage

+ type ACLPolicies struct

+ func (a *ACLPolicies) Delete(policyName string, q *WriteOptions) (*WriteMeta, error)

+ func (a *ACLPolicies) Info(policyName string, q *QueryOptions) (*ACLPolicy, *QueryMeta, error)

+ func (a *ACLPolicies) List(q *QueryOptions) ([]*ACLPolicyListStub, *QueryMeta, error)

+ func (a *ACLPolicies) Upsert(policy *ACLPolicy, q *WriteOptions) (*WriteMeta, error)

+ type ACLPolicy struct

+ CreateIndex uint64

+ Description string

+ ModifyIndex uint64

+ Name string

+ Rules string

+ type ACLPolicyListStub struct

+ CreateIndex uint64

+ Description string

+ ModifyIndex uint64

+ Name string

+ type ACLToken struct

+ AccessorID string

+ CreateIndex uint64

+ CreateTime time.Time

+ Global bool

+ ModifyIndex uint64

+ Name string

+ Policies []string

+ SecretID string

+ Type string

+ type ACLTokenListStub struct

+ AccessorID string

+ CreateIndex uint64

+ CreateTime time.Time

+ Global bool

+ ModifyIndex uint64

+ Name string

+ Policies []string

+ Type string

+ type ACLTokens struct

+ func (a *ACLTokens) Bootstrap(q *WriteOptions) (*ACLToken, *WriteMeta, error)

+ func (a *ACLTokens) Create(token *ACLToken, q *WriteOptions) (*ACLToken, *WriteMeta, error)

+ func (a *ACLTokens) Delete(accessorID string, q *WriteOptions) (*WriteMeta, error)

+ func (a *ACLTokens) Info(accessorID string, q *QueryOptions) (*ACLToken, *QueryMeta, error)

+ func (a *ACLTokens) List(q *QueryOptions) ([]*ACLTokenListStub, *QueryMeta, error)

+ func (a *ACLTokens) Self(q *QueryOptions) (*ACLToken, *QueryMeta, error)

+ func (a *ACLTokens) Update(token *ACLToken, q *WriteOptions) (*ACLToken, *WriteMeta, error)

type Agent

+ func (a *Agent) Health() (*AgentHealthResponse, error)

+ type AgentHealth struct

+ Message string

+ Ok bool

+ type AgentHealthResponse struct

+ Client *AgentHealth

+ Server *AgentHealth

+ type AllocDeploymentStatus struct

+ Healthy *bool

+ ModifyIndex uint64

type Allocation

+ DeploymentID string

+ DeploymentStatus *AllocDeploymentStatus

+ Namespace string

type AllocationListStub

+ DeploymentStatus *AllocDeploymentStatus

+ JobVersion uint64

type AllocationMetric

+ QuotaExhausted []string

+ type CheckRestart struct

+ Grace *time.Duration

+ IgnoreWarnings bool

+ Limit int

+ func (c *CheckRestart) Canonicalize()

+ func (c *CheckRestart) Copy() *CheckRestart

+ func (c *CheckRestart) Merge(o *CheckRestart) *CheckRestart

type Client

+ func (c *Client) ACLPolicies() *ACLPolicies

+ func (c *Client) ACLTokens() *ACLTokens

+ func (c *Client) Address() string

+ func (c *Client) Deployments() *Deployments

+ func (c *Client) GetNodeClient(nodeID string, q *QueryOptions) (*Client, error)

+ func (c *Client) Namespaces() *Namespaces

+ func (c *Client) Quotas() *Quotas

+ func (c *Client) Search() *Search

+ func (c *Client) SentinelPolicies() *SentinelPolicies

+ func (c *Client) SetNamespace(namespace string)

+ func (c *Client) SetSecretID(secretID string)

type Config

+ Namespace string

+ SecretID string

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

+ type Deployment struct

+ CreateIndex uint64

+ ID string

+ JobCreateIndex uint64

+ JobID string

+ JobModifyIndex uint64

+ JobVersion uint64

+ ModifyIndex uint64

+ Namespace string

+ Status string

+ StatusDescription string

+ TaskGroups map[string]*DeploymentState

+ type DeploymentAllocHealthRequest struct

+ DeploymentID string

+ HealthyAllocationIDs []string

+ UnhealthyAllocationIDs []string

+ type DeploymentFailRequest struct

+ DeploymentID string

+ type DeploymentIndexSort []*Deployment

+ func (d DeploymentIndexSort) Len() int

+ func (d DeploymentIndexSort) Less(i, j int) bool

+ func (d DeploymentIndexSort) Swap(i, j int)

+ type DeploymentPauseRequest struct

+ DeploymentID string

+ Pause bool

+ type DeploymentPromoteRequest struct

+ All bool

+ DeploymentID string

+ Groups []string

+ type DeploymentSpecificRequest struct

+ DeploymentID string

+ type DeploymentState struct

+ AutoRevert bool

+ DesiredCanaries int

+ DesiredTotal int

+ HealthyAllocs int

+ PlacedAllocs int

+ PlacedCanaries []string

+ Promoted bool

+ UnhealthyAllocs int

+ type DeploymentUpdateResponse struct

+ DeploymentModifyIndex uint64

+ EvalCreateIndex uint64

+ EvalID string

+ RevertedJobVersion *uint64

+ type Deployments struct

+ func (d *Deployments) Allocations(deploymentID string, q *QueryOptions) ([]*AllocationListStub, *QueryMeta, error)

+ func (d *Deployments) Fail(deploymentID string, q *WriteOptions) (*DeploymentUpdateResponse, *WriteMeta, error)

+ func (d *Deployments) Info(deploymentID string, q *QueryOptions) (*Deployment, *QueryMeta, error)

+ func (d *Deployments) List(q *QueryOptions) ([]*Deployment, *QueryMeta, error)

+ func (d *Deployments) Pause(deploymentID string, pause bool, q *WriteOptions) (*DeploymentUpdateResponse, *WriteMeta, error)

+ func (d *Deployments) PrefixList(prefix string) ([]*Deployment, *QueryMeta, error)

+ func (d *Deployments) PromoteAll(deploymentID string, q *WriteOptions) (*DeploymentUpdateResponse, *WriteMeta, error)

+ func (d *Deployments) PromoteGroups(deploymentID string, groups []string, q *WriteOptions) (*DeploymentUpdateResponse, *WriteMeta, error)

+ func (d *Deployments) SetAllocHealth(deploymentID string, healthy, unhealthy []string, q *WriteOptions) (*DeploymentUpdateResponse, *WriteMeta, error)

type DesiredUpdates

+ Canary uint64

type Evaluation

+ DeploymentID string

+ Namespace string

+ QuotaLimitReached string

type Job

+ Namespace *string

+ Stable *bool

+ Stop *bool

+ SubmitTime *int64

+ Version *uint64

+ type JobDeregisterResponse struct

+ EvalCreateIndex uint64

+ EvalID string

+ JobModifyIndex uint64

type JobListStub

+ ParameterizedJob bool

+ Periodic bool

+ Stop bool

+ SubmitTime int64

type JobPlanRequest

+ PolicyOverride bool

type JobPlanResponse

+ Warnings string

type JobRegisterRequest

+ PolicyOverride bool

+ type JobRegisterResponse struct

+ EvalCreateIndex uint64

+ EvalID string

+ JobModifyIndex uint64

+ Warnings string

+ type JobRevertRequest struct

+ EnforcePriorVersion *uint64

+ JobID string

+ JobVersion uint64

+ type JobStabilityRequest struct

+ JobID string

+ JobVersion uint64

+ Stable bool

+ type JobStabilityResponse struct

+ JobModifyIndex uint64

type JobSummary

+ Namespace string

type JobValidateResponse

+ Warnings string

+ type JobVersionsResponse struct

+ Diffs []*JobDiff

+ Versions []*Job

type Jobs

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

+ func (j *Jobs) LatestDeployment(jobID string, q *QueryOptions) (*Deployment, *QueryMeta, error)

+ func (j *Jobs) PlanOpts(job *Job, opts *PlanOptions, q *WriteOptions) (*JobPlanResponse, *WriteMeta, error)

+ func (j *Jobs) RegisterOpts(job *Job, opts *RegisterOptions, q *WriteOptions) (*JobRegisterResponse, *WriteMeta, error)

+ func (j *Jobs) Revert(jobID string, version uint64, enforcePriorVersion *uint64, q *WriteOptions) (*JobRegisterResponse, *WriteMeta, error)

+ func (j *Jobs) Stable(jobID string, version uint64, stable bool, q *WriteOptions) (*JobStabilityResponse, *WriteMeta, error)

+ func (j *Jobs) Versions(jobID string, diffs bool, q *QueryOptions) ([]*Job, []*JobDiff, *QueryMeta, error)

+ type Namespace struct

+ CreateIndex uint64

+ Description string

+ ModifyIndex uint64

+ Name string

+ Quota string

+ type NamespaceIndexSort []*Namespace

+ func (n NamespaceIndexSort) Len() int

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

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

+ type Namespaces struct

+ func (n *Namespaces) Delete(namespace string, q *WriteOptions) (*WriteMeta, error)

+ func (n *Namespaces) Info(name string, q *QueryOptions) (*Namespace, *QueryMeta, error)

+ func (n *Namespaces) List(q *QueryOptions) ([]*Namespace, *QueryMeta, error)

+ func (n *Namespaces) PrefixList(prefix string, q *QueryOptions) ([]*Namespace, *QueryMeta, error)

+ func (n *Namespaces) Register(namespace *Namespace, q *WriteOptions) (*WriteMeta, error)

type NetworkResource

+ Device string

type NodeListStub

+ Version string

+ type PlanOptions struct

+ Diff bool

+ PolicyOverride bool

type QueryOptions

+ AuthToken string

+ Namespace string

+ type QuotaLimit struct

+ Hash []byte

+ Region string

+ RegionLimit *Resources

+ type QuotaLimitSort []*QuotaLimit

+ func (q QuotaLimitSort) Len() int

+ func (q QuotaLimitSort) Less(i, j int) bool

+ func (q QuotaLimitSort) Swap(i, j int)

+ type QuotaSpec struct

+ CreateIndex uint64

+ Description string

+ Limits []*QuotaLimit

+ ModifyIndex uint64

+ Name string

+ type QuotaSpecIndexSort []*QuotaSpec

+ func (q QuotaSpecIndexSort) Len() int

+ func (q QuotaSpecIndexSort) Less(i, j int) bool

+ func (q QuotaSpecIndexSort) Swap(i, j int)

+ type QuotaUsage struct

+ CreateIndex uint64

+ ModifyIndex uint64

+ Name string

+ Used map[string]*QuotaLimit

+ type QuotaUsageIndexSort []*QuotaUsage

+ func (q QuotaUsageIndexSort) Len() int

+ func (q QuotaUsageIndexSort) Less(i, j int) bool

+ func (q QuotaUsageIndexSort) Swap(i, j int)

+ type Quotas struct

+ func (q *Quotas) Delete(quota string, qo *WriteOptions) (*WriteMeta, error)

+ func (q *Quotas) Info(name string, qo *QueryOptions) (*QuotaSpec, *QueryMeta, error)

+ func (q *Quotas) List(qo *QueryOptions) ([]*QuotaSpec, *QueryMeta, error)

+ func (q *Quotas) ListUsage(qo *QueryOptions) ([]*QuotaUsage, *QueryMeta, error)

+ func (q *Quotas) PrefixList(prefix string, qo *QueryOptions) ([]*QuotaSpec, *QueryMeta, error)

+ func (q *Quotas) PrefixListUsage(prefix string, qo *QueryOptions) ([]*QuotaUsage, *QueryMeta, error)

+ func (q *Quotas) Register(spec *QuotaSpec, qo *WriteOptions) (*WriteMeta, error)

+ func (q *Quotas) Usage(name string, qo *QueryOptions) (*QuotaUsage, *QueryMeta, error)

type RegisterJobRequest

+ PolicyOverride bool

+ type RegisterOptions struct

+ EnforceIndex bool

+ ModifyIndex uint64

+ PolicyOverride bool

+ type Search struct

+ func (s *Search) PrefixSearch(prefix string, context contexts.Context, q *QueryOptions) (*SearchResponse, *QueryMeta, error)

+ type SearchRequest struct

+ Context contexts.Context

+ Prefix string

+ type SearchResponse struct

+ Matches map[contexts.Context][]string

+ Truncations map[contexts.Context]bool

+ type SentinelPolicies struct

+ func (a *SentinelPolicies) Delete(policyName string, q *WriteOptions) (*WriteMeta, error)

+ func (a *SentinelPolicies) Info(policyName string, q *QueryOptions) (*SentinelPolicy, *QueryMeta, error)

+ func (a *SentinelPolicies) List(q *QueryOptions) ([]*SentinelPolicyListStub, *QueryMeta, error)

+ func (a *SentinelPolicies) Upsert(policy *SentinelPolicy, q *WriteOptions) (*WriteMeta, error)

+ type SentinelPolicy struct

+ CreateIndex uint64

+ Description string

+ EnforcementLevel string

+ ModifyIndex uint64

+ Name string

+ Policy string

+ Scope string

+ type SentinelPolicyListStub struct

+ CreateIndex uint64

+ Description string

+ EnforcementLevel string

+ ModifyIndex uint64

+ Name string

+ Scope string

type Service

+ AddressMode string

+ CheckRestart *CheckRestart

type ServiceCheck

+ CheckRestart *CheckRestart

+ Header map[string][]string

+ Method string

+ TLSSkipVerify bool

+ type SingleDeploymentResponse struct

+ Deployment *Deployment

type System

+ func (s *System) ReconcileSummaries() error

type TLSConfig

+ func (t *TLSConfig) Copy() *TLSConfig

type Task

+ ShutdownDelay time.Duration

type TaskArtifact

+ GetterMode *string

type TaskEvent

+ GenericSource string

type TaskGroup

+ Update *UpdateStrategy

type TaskState

+ FinishedAt time.Time

+ LastRestart time.Time

+ Restarts uint64

+ StartedAt time.Time

type Template

+ Envvars *bool

+ VaultGrace *time.Duration

type UpdateStrategy

+ AutoRevert *bool

+ Canary *int

+ HealthCheck *string

+ HealthyDeadline *time.Duration

+ MinHealthyTime *time.Duration

+ func DefaultUpdateStrategy() *UpdateStrategy

+ func (u *UpdateStrategy) Canonicalize()

+ func (u *UpdateStrategy) Copy() *UpdateStrategy

+ func (u *UpdateStrategy) Empty() bool

+ func (u *UpdateStrategy) Merge(o *UpdateStrategy)

type WriteOptions

+ AuthToken string

+ Namespace string

type WriteRequest

+ Namespace string

+ SecretID string

v0.7.0-rc1

Oct 19, 2017

v0.5.5

Mar 14, 2017

Changes in this version

+ const OriginEnd

+ const OriginStart

+ const PeriodicSpecCron

+ const RegisterEnforceIndexErrPrefix

+ const TaskArtifactDownloadFailed

+ const TaskDownloadingArtifacts

+ const TaskDriverMessage

+ const TaskFailedValidation

+ const TaskKilling

+ const TaskLeaderDead

+ const TaskNotRestarting

+ const TaskReceived

+ const TaskRestartSignal

+ const TaskRestarting

+ const TaskSetup

+ const TaskSetupFailure

+ const TaskSiblingFailed

+ const TaskSignaling

+ 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 AgentSelf struct

+ Config map[string]interface{}

+ Member AgentMember

+ Stats map[string]map[string]string

+ type AllocFS struct

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

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

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

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

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

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

+ type AllocFileInfo struct

+ FileMode string

+ IsDir bool

+ ModTime time.Time

+ Name string

+ Size int64

+ type AllocResourceUsage struct

+ ResourceUsage *ResourceUsage

+ Tasks map[string]*TaskResourceUsage

+ Timestamp int64

type Allocation

+ AllocModifyIndex uint64

+ CreateTime int64

+ PreviousAllocation string

+ Services map[string]string

type AllocationListStub

+ CreateTime int64

type AllocationMetric

+ NodesAvailable map[string]int

type Allocations

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

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

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

type Client

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

+ func (c *Client) Operator() *Operator

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

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

type Config

+ HttpAuth *HttpBasicAuth

+ TLSConfig *TLSConfig

+ func (c *Config) ConfigureTLS() error

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

+ 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 DispatchPayloadConfig struct

+ File string

+ type EphemeralDisk struct

+ Migrate *bool

+ SizeMB *int

+ Sticky *bool

+ func DefaultEphemeralDisk() *EphemeralDisk

+ func (e *EphemeralDisk) Canonicalize()

type Evaluation

+ AnnotatePlan bool

+ BlockedEval string

+ ClassEligibility map[string]bool

+ EscapedComputedClass bool

+ FailedTGAllocs map[string]*AllocationMetric

+ QueuedAllocations map[string]int

+ SnapshotIndex uint64

type Evaluations

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

+ type FieldDiff struct

+ Annotations []string

+ Name string

+ New string

+ Old string

+ Type string

+ 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 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 HttpBasicAuth struct

+ Password string

+ Username string

type Job

+ JobModifyIndex *uint64

+ ParameterizedJob *ParameterizedJobConfig

+ ParentID *string

+ Payload []byte

+ Periodic *PeriodicConfig

+ VaultToken *string

+ func MockJob() *Job

+ func MockPeriodicJob() *Job

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

+ func (j *Job) Canonicalize()

+ func (j *Job) IsParameterized() bool

+ func (j *Job) IsPeriodic() bool

+ type JobChildrenSummary struct

+ Dead int64

+ Pending int64

+ Running int64

+ func (jc *JobChildrenSummary) Sum() int

+ type JobDiff struct

+ Fields []*FieldDiff

+ ID string

+ Objects []*ObjectDiff

+ TaskGroups []*TaskGroupDiff

+ Type string

+ type JobDispatchRequest struct

+ JobID string

+ Meta map[string]string

+ Payload []byte

+ type JobDispatchResponse struct

+ DispatchedJobID string

+ EvalCreateIndex uint64

+ EvalID string

+ JobCreateIndex uint64

type JobListStub

+ JobModifyIndex uint64

+ JobSummary *JobSummary

+ ParentID string

+ 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 JobRegisterRequest struct

+ EnforceIndex bool

+ Job *Job

+ JobModifyIndex uint64

+ type JobSummary struct

+ Children *JobChildrenSummary

+ CreateIndex uint64

+ JobID string

+ ModifyIndex uint64

+ Summary map[string]TaskGroupSummary

+ type JobValidateRequest struct

+ Job *Job

+ type JobValidateResponse struct

+ DriverConfigValidated bool

+ Error string

+ ValidationErrors []string

type Jobs

+ func (j *Jobs) Dispatch(jobID string, meta map[string]string, payload []byte, q *WriteOptions) (*JobDispatchResponse, *WriteMeta, error)

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

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

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

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

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

+ func (j *Jobs) Validate(job *Job, q *WriteOptions) (*JobValidateResponse, *WriteMeta, error)

+ type KeyringRequest struct

+ Key string

+ type KeyringResponse struct

+ Keys map[string]int

+ Messages map[string]string

+ NumNodes int

+ type LogConfig struct

+ MaxFileSizeMB *int

+ MaxFiles *int

+ func DefaultLogConfig() *LogConfig

+ func (l *LogConfig) Canonicalize()

+ type MemoryStats struct

+ Cache uint64

+ KernelMaxUsage uint64

+ KernelUsage uint64

+ MaxUsage uint64

+ Measured []string

+ RSS uint64

+ Swap uint64

type NetworkResource

+ IP string

+ func (n *NetworkResource) Canonicalize()

type Node

+ HTTPAddr string

+ StatusUpdatedAt int64

+ TLSEnabled bool

type Nodes

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

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

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

+ type ObjectDiff struct

+ Fields []*FieldDiff

+ Name string

+ Objects []*ObjectDiff

+ Type string

+ type Operator struct

+ func (op *Operator) RaftGetConfiguration(q *QueryOptions) (*RaftConfiguration, error)

+ func (op *Operator) RaftRemovePeerByAddress(address string, q *WriteOptions) error

+ type ParameterizedJobConfig struct

+ MetaOptional []string

+ MetaRequired []string

+ Payload string

+ type PeriodicConfig struct

+ Enabled *bool

+ ProhibitOverlap *bool

+ Spec *string

+ SpecType *string

+ TimeZone *string

+ func (p *PeriodicConfig) Canonicalize()

+ func (p *PeriodicConfig) GetLocation() (*time.Location, error)

+ func (p *PeriodicConfig) Next(fromTime time.Time) time.Time

+ type PlanAnnotations struct

+ DesiredTGUpdates map[string]*DesiredUpdates

type QueryOptions

+ Params map[string]string

+ Prefix string

+ type RaftConfiguration struct

+ Index uint64

+ Servers []*RaftServer

+ type RaftServer struct

+ Address string

+ ID string

+ Leader bool

+ Node string

+ Voter bool

type Raw

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

+ type RegisterJobRequest struct

+ EnforceIndex bool

+ Job *Job

+ JobModifyIndex uint64

+ type ResourceUsage struct

+ CpuStats *CpuStats

+ MemoryStats *MemoryStats

type Resources

+ func MinResources() *Resources

+ func (r *Resources) Canonicalize()

+ func (r *Resources) Merge(other *Resources)

type RestartPolicy

+ Mode *string

+ func (r *RestartPolicy) Merge(rp *RestartPolicy)

+ type ServerMembers struct

+ Members []*AgentMember

+ ServerDC string

+ ServerName string

+ ServerRegion string

type Service

+ func (s *Service) Canonicalize(t *Task, tg *TaskGroup, job *Job)

type ServiceCheck

+ Args []string

+ Command string

+ InitialStatus string

+ PortLabel string

type Status

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

+ type StreamFrame struct

+ Data []byte

+ File string

+ FileEvent string

+ Offset int64

+ func (s *StreamFrame) IsHeartbeat() bool

+ type System struct

+ func (s *System) GarbageCollect() error

+ type TLSConfig struct

+ CACert string

+ CAPath string

+ ClientCert string

+ ClientKey string

+ Insecure bool

+ TLSServerName string

type Task

+ Artifacts []*TaskArtifact

+ DispatchPayload *DispatchPayloadConfig

+ KillTimeout *time.Duration

+ Leader bool

+ LogConfig *LogConfig

+ Templates []*Template

+ User string

+ Vault *Vault

+ func (t *Task) Canonicalize(tg *TaskGroup, job *Job)

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

+ type TaskArtifact struct

+ GetterOptions map[string]string

+ GetterSource *string

+ RelativeDest *string

+ func (a *TaskArtifact) Canonicalize()

+ type TaskDiff struct

+ Annotations []string

+ Fields []*FieldDiff

+ Name string

+ Objects []*ObjectDiff

+ Type string

type TaskEvent

+ DiskLimit int64

+ DiskSize int64

+ DownloadError string

+ DriverMessage string

+ FailedSibling string

+ FailsTask bool

+ KillReason string

+ KillTimeout time.Duration

+ RestartReason string

+ SetupError string

+ StartDelay int64

+ TaskSignal string

+ TaskSignalReason string

+ ValidationError string

+ VaultError string

type TaskGroup

+ EphemeralDisk *EphemeralDisk

+ func (g *TaskGroup) Canonicalize(job *Job)

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

+ type TaskGroupDiff struct

+ Fields []*FieldDiff

+ Name string

+ Objects []*ObjectDiff

+ Tasks []*TaskDiff

+ Type string

+ Updates map[string]uint64

+ type TaskGroupSummary struct

+ Complete int

+ Failed int

+ Lost int

+ Queued int

+ Running int

+ Starting int

+ type TaskResourceUsage struct

+ Pids map[string]*ResourceUsage

+ ResourceUsage *ResourceUsage

+ Timestamp int64

type TaskState

+ Failed bool

+ type Template struct

+ ChangeMode *string

+ ChangeSignal *string

+ DestPath *string

+ EmbeddedTmpl *string

+ LeftDelim *string

+ Perms *string

+ RightDelim *string

+ SourcePath *string

+ Splay *time.Duration

+ func (tmpl *Template) Canonicalize()

+ type Vault struct

+ ChangeMode *string

+ ChangeSignal *string

+ Env *bool

+ Policies []string

+ func (v *Vault) Canonicalize()

+ type WriteRequest struct

+ Region string

v0.5.1-rc1

Dec 6, 2016

v0.4.0-rc2

Jun 22, 2016

v0.2.2

Dec 11, 2015

Changes in this version

+ const JobTypeBatch

+ const JobTypeService

+ const TaskDriverFailure

+ const TaskKilled

+ const TaskStarted

+ const TaskTerminated

+ 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 AgentMembersNameSort []*AgentMember

+ func (a AgentMembersNameSort) Len() int

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

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

+ 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

+ TaskStates map[string]*TaskState

+ 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

+ TaskStates map[string]*TaskState

+ 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 AllocationSort []*Allocation

+ func (a AllocationSort) Len() int

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

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

+ 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) Regions() *Regions

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

+ type Config struct

+ Address string

+ HttpClient *http.Client

+ Region string

+ WaitTime time.Duration

+ func DefaultConfig() *Config

+ type Constraint struct

+ LTarget string

+ Operand string

+ RTarget string

+ func NewConstraint(left, operand, right string) *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

+ Update *UpdateStrategy

+ 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 []Port

+ MBits int

+ Public bool

+ ReservedPorts []Port

+ type Node struct

+ Attributes map[string]string

+ CreateIndex uint64

+ Datacenter string

+ Drain bool

+ ID string

+ Links map[string]string

+ Meta 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) ([]*Allocation, *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 Port struct

+ Label string

+ Value int

+ 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 Regions struct

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

+ type Resources struct

+ CPU int

+ DiskMB int

+ IOPS int

+ MemoryMB int

+ Networks []*NetworkResource

+ 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 Status struct

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

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

+ type Task struct

+ Config map[string]interface{}

+ Constraints []*Constraint

+ Driver string

+ Env map[string]string

+ Meta map[string]string

+ Name string

+ Resources *Resources

+ Services []Service

+ 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 TaskEvent struct

+ DriverError string

+ ExitCode int

+ KillError string

+ Message string

+ Signal int

+ Time int64

+ Type string

+ type TaskGroup struct

+ Constraints []*Constraint

+ Count int

+ Meta map[string]string

+ Name string

+ RestartPolicy *RestartPolicy

+ 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 TaskState struct

+ Events []*TaskEvent

+ State string

+ type UpdateStrategy struct

+ MaxParallel int

+ Stagger time.Duration

+ type WriteMeta struct

+ LastIndex uint64

+ RequestTime time.Duration

+ type WriteOptions struct

+ Region string

Other modules containing this package

github.com/tsaarni/nomad/api

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL