nomad

Documentation

Index

• type Config
• type Connector
  • func New(nomadServerAddress string, options ...Option) (*Connector, error)
  • func (nc *Connector) AdjustScalingObjectCount(jobname string, min uint, max uint, from uint, to uint) error
  • func (nc *Connector) GetScalingObjectCount(jobname string) (uint, error)
  • func (nc *Connector) IsScalingObjectDead(jobname string) (bool, error)
  • func (c *Connector) String() string
• type Deployments
• type Evaluations
• type Jobs
• type Option
  • func WithDeploymentTimeOut(timeout time.Duration) Option
  • func WithEvaluationTimeOut(timeout time.Duration) Option
  • func WithLogger(logger zerolog.Logger) Option

Examples

• New

Types

type Config

type Config struct {
	NomadServerAddress string
	Logger             zerolog.Logger

	// DeploymentTimeOut reflects the timeout sokar will wait (at max) for a deployment to be applied.
	DeploymentTimeOut time.Duration
	// EvaluationTimeOut reflects the timeout sokar will wait (at max) for gathering information about evaluations.
	EvaluationTimeOut time.Duration
}

Config contains the main configuration for the nomad connector

type Connector

type Connector struct {
	// contains filtered or unexported fields
}

Connector is a object that allows to interact with nomad

func New

func New(nomadServerAddress string, options ...Option) (*Connector, error)

New creates a new nomad connector

Example

conn, err := New("http://1.2.3.4")

if err != nil {
	log.Fatalf("Unable to create connector: %s.", err.Error())
}

// just to avoid the not used error
_ = conn

func (*Connector) AdjustScalingObjectCount

func (nc *Connector) AdjustScalingObjectCount(jobname string, min uint, max uint, from uint, to uint) error

AdjustScalingObjectCount sets the given count for the given nomad job. HACK: The count is set to the same value for all groups inside the job.

func (*Connector) GetScalingObjectCount

func (nc *Connector) GetScalingObjectCount(jobname string) (uint, error)

GetScalingObjectCount retunrs the actual count of the given nomad job. HACK: To unify the multiple groups with we take the job with max count.

func (*Connector) IsScalingObjectDead

func (nc *Connector) IsScalingObjectDead(jobname string) (bool, error)

IsScalingObjectDead returns true if the mentioned job is in state nomad./structs/JobStatusDead, false otherwise.

func (*Connector) String

func (c *Connector) String() string

type Deployments

type Deployments interface {
	Info(deploymentID string, q *nomadApi.QueryOptions) (*nomadApi.Deployment, *nomadApi.QueryMeta, error)
}

Deployments represents the interface for interacting with nomads over the deployments end-point

type Evaluations

type Evaluations interface {
	Info(evalID string, q *nomadApi.QueryOptions) (*nomadApi.Evaluation, *nomadApi.QueryMeta, error)
}

Evaluations represents the interface for interacting with nomads over the evaluations end-point

type Jobs

type Jobs interface {
	Info(jobID string, q *nomadApi.QueryOptions) (*nomadApi.Job, *nomadApi.QueryMeta, error)
	Register(job *nomadApi.Job, q *nomadApi.WriteOptions) (*nomadApi.JobRegisterResponse, *nomadApi.WriteMeta, error)
}

Jobs represents the interface for interacting with nomads over the jobs end-point

type Option

type Option func(conn *Connector)

Option represents an option for the Connector

func WithDeploymentTimeOut

func WithDeploymentTimeOut(timeout time.Duration) Option

WithDeploymentTimeOut sets the timeout that should be regarded during deployments

func WithEvaluationTimeOut

func WithEvaluationTimeOut(timeout time.Duration) Option

WithEvaluationTimeOut sets the timeout that should be regarded during evaluations

func WithLogger

func WithLogger(logger zerolog.Logger) Option

WithLogger adds a configured Logger to the Connector