package
0.9.1-rc1
Repository: https://github.com/smithx10/nomad.git
Documentation: pkg.go.dev

# Packages

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

# Functions

DefaultConfig returns the default configuration.
NewBlockedEvals creates a new blocked eval tracker that will enqueue unblocked evals into the passed broker.
NewCoreScheduler is used to return a new system scheduler instance.
NewEnterpriseEndpoints returns a stub of the enterprise endpoints since there are none in oss.
NewEvalBroker creates a new evaluation broker.
NewEvaluatePool returns a pool of the given size.
NewFSMPath is used to construct a new FSM with a blank state.
NewPeriodicDispatch returns a periodic dispatcher that is used to track and launch periodic jobs.
No description provided by the author
NewPlanQueue is used to construct and return a new plan queue.
NewRaftLayer is used to initialize a new RaftLayer which can be used as a StreamLayer for Raft.
NewServer is used to construct a new Nomad server from the configuration, potentially returning an error.
NewStatsFetcher returns a stats fetcher.
NewTimeTable creates a new time table which stores entries at a given granularity for a maximum limit.
NewVaultClient returns a Vault client from the given config.
NewWorker starts a new worker associated with the given server.
NodeRpc is used to make an RPC call to a node.
NodeStreamingRpc is used to make a streaming RPC call to a node.
PoliciesFrom parses the set of policies returned by a token lookup.
ServersMeetMinimumVersion returns whether the given alive servers are at least on the given Nomad version.
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
AutopilotRZTag is the Serf tag to use for the redundancy zone value when passing the server metadata to Autopilot.
AutopilotRZTag is the Serf tag to use for the custom version value when passing the server metadata to Autopilot.
No description provided by the author
DefaultDequeueTimeout is used if no dequeue timeout is provided.
No description provided by the author
No description provided by the author
No description provided by the author
DispatchPayloadSizeLimit is the maximum size of the uncompressed input data payload.
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
NodeDrainEvents are the various drain messages.
No description provided by the author
NodeEligibilityEventEligible is used when the nodes eligiblity is marked eligible.
NodeEligibilityEventIneligible is used when the nodes eligiblity is marked ineligible.
NodeHeartbeatEventMissed is the event used when the Nodes heartbeat is missed.
NodeHeartbeatEventReregistered is the message used when the node becomes reregistered by the heartbeat.
No description provided by the author
No description provided by the author
These are the protocol versions that Nomad can understand.
These are the protocol versions that Nomad can understand.
RegisterEnforceIndexErrPrefix is the prefix to use in errors caused by enforcing the job modify index during registers.
No description provided by the author
StatusReap is used to update the status of a node if we are handling a EventMemberReap.
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
ErrNackTimeoutReached is returned if an expired evaluation is reset.
ErrNotOutstanding is returned if an evaluation is not outstanding.
ErrTokenMismatch is the outstanding eval has a different token.

# Structs

ACL endpoint is used for manipulating ACL tokens and policies.
Alloc endpoint is used for manipulating allocations.
AutopilotDelegate is a Nomad delegate for autopilot operations.
BlockedEvals is used to track evaluations that shouldn't be queued until a certain class of nodes becomes available.
BlockedStats returns all the stats about the blocked eval tracker.
BrokerStats returns all the stats about the broker.
ClientAllocations is used to forward RPC requests to the targed Nomad client's Allocation endpoint.
ClientStats is used to forward RPC requests to the targed Nomad client's ClientStats endpoint.
Config is used to parameterize the server.
CoreScheduler is a special "scheduler" that is registered as "_core".
Deployment endpoint is used for manipulating deployments.
EnterpriseEndpoints holds the set of enterprise only endpoints to register.
No description provided by the author
Eval endpoint is used for eval interactions.
EvalBroker is used to manage brokering of evaluations.
EvaluatePool is used to have a pool of workers that are evaluating if a plan is valid.
FileSystem endpoint is used for accessing the logs and filesystem of allocations from a Node.
FSMConfig is used to configure the FSM.
Job endpoint is used for job interactions.
Node endpoint is used for client interactions.
Operator endpoint is used to perform low-level operator tasks for Nomad.
Periodic endpoint is used for periodic job interactions.
PeriodicDispatch is used to track and launch periodic jobs.
Plan endpoint is used for plan interactions.
PlanQueue is used to submit commit plans for task allocations to the current leader.
QueueStats returns all the stats about the plan queue.
RaftLayer implements the raft.StreamLayer interface, so that we can use a single RPC layer for Raft and Nomad.
Region is used to query and list the known regions.
RPCContext provides metadata about the RPC connection.
SchedulerStats returns the stats per scheduler.
Search endpoint is used to look up matches for a given prefix and context.
Server is Nomad server which manages the job queues, schedulers, and notification bus for agents.
StatsFetcher has two functions for autopilot.
Status endpoint is used to check on server status.
System endpoint is used to call invoke system tasks.
TestVaultClient is a Vault client appropriate for use during testing.
TimeTable is used to associate a Raft index with a timestamp.
TimeTableEntry is used to track a time and index.
VaultStats returns all the stats about Vault tokens created and managed by Nomad.
Worker is a single threaded scheduling worker.

# Interfaces

JobEvalDispatcher is an interface to submit jobs and have evaluations created for them.
PlanFuture is used to return a future for an enqueue.
VaultClient is the Servers interface for interfacing with Vault.

# Type aliases

LogApplier is the definition of a function that can apply a Raft log.
LogAppliers is a mapping of the Raft MessageType to the appropriate log applier.
PendingEvaluations is a list of waiting evaluations.
PendingPlans is a list of waiting plans.
PurgeVaultAccessor is called to remove VaultAccessors from the system.
SnapshotRestorer is the definition of a function that can apply a Raft log.
SnapshotRestorers is a mapping of the SnapshotType to the appropriate snapshot restorer.
SnapshotType is prefixed to a record in the FSM snapshot so that we can determine the type for restore.