nomad

package

v0.20.2 Latest Latest Go to latest Published: Aug 20, 2026 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/paularlott/scriptling

Links

Open Source Insights

Documentation ¶

Overview ¶

Package nomad implements the scriptling.nomad extended library: a thin client over the HashiCorp Nomad HTTP API covering CSI volumes and jobs.

Index ¶

Constants
func Register(registrar interface{ ... })
type CSIVolumeListEntry
type HostVolumeListEntry
type JobListEntry

Constants ¶

View Source

const (
	// DefaultAddr is used when no address is supplied to Client().
	DefaultAddr = "http://127.0.0.1:4646"

	// DefaultTimeout is the per-request HTTP timeout used when none is given
	// to Client().
	DefaultTimeout = 10 * time.Second
)

View Source

const (
	LibraryName = "scriptling.nomad"
	LibraryDesc = "HashiCorp Nomad client library covering CSI volumes and jobs"
)

Variables ¶

This section is empty.

Functions ¶

func Register ¶

func Register(registrar interface{ RegisterLibrary(*object.Library) })

Register registers the scriptling.nomad library with the given registrar.

Types ¶

type CSIVolumeListEntry ¶

type CSIVolumeListEntry struct {
	ID                 string `json:"ID"`
	Name               string `json:"Name"`
	Namespace          string `json:"Namespace"`
	PluginID           string `json:"PluginID"`
	Provider           string `json:"Provider"`
	Schedulable        bool   `json:"Schedulable"`
	ControllersHealthy int    `json:"ControllersHealthy"`
	NodesHealthy       int    `json:"NodesHealthy"`
}

CSIVolumeListEntry is a summary entry as returned by the volume list endpoint.

type HostVolumeListEntry ¶ added in v0.17.2

type HostVolumeListEntry struct {
	ID        string `json:"ID"`
	Name      string `json:"Name"`
	Namespace string `json:"Namespace"`
	PluginID  string `json:"PluginID"`
	NodeID    string `json:"NodeID"`
	NodePool  string `json:"NodePool"`
	State     string `json:"State"`
}

HostVolumeListEntry is a summary entry as returned by the host volume list endpoint.

type JobListEntry ¶

type JobListEntry struct {
	ID        string `json:"ID"`
	Name      string `json:"Name"`
	Namespace string `json:"Namespace"`
	Type      string `json:"Type"`
	Status    string `json:"Status"`
	Priority  int    `json:"Priority"`
}

JobListEntry is a summary entry as returned by the job list endpoint.

Source Files ¶

View all Source files

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