package
0.4.1
Repository: https://github.com/bigcommerce/nomad.git
Documentation: pkg.go.dev

# Functions

DefaultConfig returns a default configuration for the client.
NewBatchJob creates and returns a new batch-style job for short-lived processes using the provided name and ID along with the relative job priority.
NewClient returns a new client.
NewConstraint generates a new job placement constraint.
NewFrameReader takes a channel of frames and returns a FrameReader which implements io.ReadCloser.
NewServiceJob creates and returns a new service-style job for long-lived processes using the provided name, ID, and relative job priority.
NewTask creates and initializes a new Task.
NewTaskGroup creates a new TaskGroup.

# Constants

JobTypeBatch indicates a short-lived process.
JobTypeService indicates a long-running processes.
No description provided by the author
OriginStart and OriginEnd are the available parameters for the origin argument when streaming a file.
RegisterEnforceIndexErrPrefix is the prefix to use in errors caused by enforcing the job modify index during registers.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Agent encapsulates an API client which talks to Nomad's agent endpoints for a specific node.
AgentMember represents a cluster member known to the agent.
Allocation is used for serialization of allocations.
AllocationListStub is used to return a subset of an allocation during list operations.
AllocationMetric is used to deserialize allocation metrics.
Allocations is used to query the alloc-related endpoints.
AllocFileInfo holds information about a file inside the AllocDir.
AllocFS is used to introspect an allocation directory on a Nomad client.
AllocResourceUsage holds the aggregated task resource usage of the allocation.
Client provides a client to the Nomad API.
Config is used to configure the creation of a client.
Constraint is used to serialize a job placement constraint.
CpuStats holds cpu usage related stats.
No description provided by the author
Evaluation is used to serialize an evaluation.
Evaluations is used to query the evaluation endpoints.
No description provided by the author
FrameReader is used to convert a stream of frames into a read closer.
No description provided by the author
No description provided by the author
No description provided by the author
HostStats represents resource usage stats of the host running a Nomad client.
HttpBasicAuth is used to authenticate http client with HTTP Basic Authentication.
Job is used to serialize a job.
No description provided by the author
JobListStub is used to return a subset of information about jobs during list operations.
No description provided by the author
No description provided by the author
Jobs is used to access the job-specific endpoints.
JobSummary summarizes the state of the allocations of a job.
LogConfig provides configuration for log rotation.
MemoryStats holds memory usage related stats.
NetworkResource is used to describe required network resources of a given task.
Node is used to deserialize a node entry.
NodeListStub is a subset of information returned during node list operations.
Nodes is used to query node-related API endpoints.
No description provided by the author
PeriodicConfig is for serializing periodic config for a job.
No description provided by the author
No description provided by the author
QueryMeta is used to return meta data about a query.
QueryOptions are used to parameterize a query.
Raw can be used to do raw queries against custom endpoints.
Regions is used to query the regions in the cluster.
RegisterJobRequest is used to serialize a job registration.
Resources encapsulates the required resources of a given task or task group.
ResourceUsage holds information related to cpu and memory stats.
RestartPolicy defines how the Nomad client restarts tasks in a taskgroup when they fail.
The Service model represents a Consul service definition.
The ServiceCheck data model represents the consul health check that Nomad registers for a Task.
Status is used to query the status-related endpoints.
StreamFrame is used to frame data of a file when streaming.
Status is used to query the status-related endpoints.
Task is a single process in a task group.
TaskArtifact is used to download artifacts before running a task.
No description provided by the author
TaskEvent is an event that effects the state of a task and contains meta-data appropriate to the events type.
TaskGroup is the unit of scheduling.
No description provided by the author
TaskGroup summarizes the state of all the allocations of a particular TaskGroup.
TaskResourceUsage holds aggregated resource usage of all processes in a Task and the resource usage of the individual pids.
TaskState tracks the current state of a task and events that caused state transitions.
UpdateStrategy is for serializing update strategy for a job.
WriteMeta is used to return meta data about a write.
WriteOptions are used to parameterize a write.

# Type aliases

AgentMembersNameSort implements sort.Interface for []*AgentMembersNameSort based on the Name, DC and Region.
AllocationSort reverse sorts allocs by CreateIndex.
AllocIndexSort reverse sorts allocs by CreateIndex.
EvalIndexSort is a wrapper to sort evaluations by CreateIndex.
JobIDSort is used to sort jobs by their job ID's.
NodeIndexSort reverse sorts nodes by CreateIndex.