package
0.12.12
Repository: https://github.com/hashicorp/nomad.git
Documentation: pkg.go.dev

# Packages

Package allocwatcher allows blocking until another allocation - whether running locally or remotely - completes and migrates the allocation directory if necessary.
Package devicemanager is used to manage device plugins.
dynamicplugins is a package that manages dynamic plugins in Nomad.
Package servers provides an interface for choosing Servers to communicate with from a Nomad Client perspective.

# Functions

NewAllocGarbageCollector returns a garbage collector for terminated allocations on a node.
NewClient is used to create a new client from the given configuration.
NewFingerprintManager is a constructor that creates and returns an instance of FingerprintManager.
TestClient creates an in-memory client for testing purposes and returns a cleanup func to shutdown the client and remove the alloc and state dirs.

# Constants

CSIPluginRequestTimeout is the timeout that should be used when making reqs against CSI Plugins.
MB is a constant which converts values in bytes to MB.
OriginStart and OriginEnd are the available parameters for the origin argument when streaming a file.

# Variables

# Structs

Allocations endpoint is used for interacting with client allocations.
AllocGarbageCollector garbage collects terminated allocations on a node.
Client is used to implement the client interaction with Nomad.
ClientStats endpoint is used for retrieving stats about a client.
CSI endpoint is used for interacting with CSI plugins on a client.
EnterpriseClient holds information and methods for enterprise functionality.
FileSystem endpoint is used for accessing the logs and filesystem of allocations.
FingerprintManager runs a client fingerprinters on a continuous basis, and updates the client when the node has changed.
GCAlloc wraps an allocation runner and an index enabling it to be used within a PQ.
GCConfig allows changing the behaviour of the garbage collector.
IndexedGCAllocPQ is an indexed PQ which maintains a list of allocation runner based on their termination time.

# Interfaces

AllocCounter is used by AllocGarbageCollector to discover how many un-GC'd allocations a client has and is generally fulfilled by the Client.
AllocRunner is the interface implemented by the core alloc runner.TODO Create via factory to allow testing Client with mock AllocRunners.
ClientStatsReporter exposes all the APIs related to resource usage of a Nomad Client.

# Type aliases