jobspec

README

Nomad Jobspec

The Nomad Jobspec plugin deploys to a Nomad cluster from a pre-existing Nomad job specification file.

Components

1. Platform

Related Plugins

1. Docker
2. Nomad Jobspec Canary

Resources

1. Nomad Job

Documentation

Index

• Variables
• type Config
• type Deployment
  • func (*Deployment) Descriptor() ([]byte, []int)
  • func (x *Deployment) GetId() string
  • func (x *Deployment) GetName() string
  • func (x *Deployment) GetResourceState() *opaqueany.Any
  • func (*Deployment) ProtoMessage()
  • func (x *Deployment) ProtoReflect() protoreflect.Message
  • func (x *Deployment) Reset()
  • func (x *Deployment) String() string
• type Platform
  • func (p *Platform) Config() (interface{}, error)
  • func (p *Platform) Deploy(ctx context.Context, log hclog.Logger, src *component.Source, ...) (*Deployment, error)
  • func (p *Platform) DeployFunc() interface{}
  • func (p *Platform) Destroy(ctx context.Context, log hclog.Logger, deployment *Deployment, ui terminal.UI) error
  • func (p *Platform) DestroyFunc() interface{}
  • func (p *Platform) Documentation() (*docs.Documentation, error)
  • func (p *Platform) Generation(ctx context.Context, log hclog.Logger, src *component.Source, ...) ([]byte, error)
  • func (p *Platform) GenerationFunc() interface{}
  • func (p *Platform) Status(ctx context.Context, log hclog.Logger, deployment *Deployment, ui terminal.UI) (*sdk.StatusReport, error)
  • func (p *Platform) StatusFunc() interface{}
• type Resource
  • func (*Resource) Descriptor() ([]byte, []int)
  • func (*Resource) ProtoMessage()
  • func (x *Resource) ProtoReflect() protoreflect.Message
  • func (x *Resource) Reset()
  • func (x *Resource) String() string
• type Resource_Job
  • func (*Resource_Job) Descriptor() ([]byte, []int)
  • func (x *Resource_Job) GetId() string
  • func (x *Resource_Job) GetName() string
  • func (x *Resource_Job) GetNamespace() string
  • func (*Resource_Job) ProtoMessage()
  • func (x *Resource_Job) ProtoReflect() protoreflect.Message
  • func (x *Resource_Job) Reset()
  • func (x *Resource_Job) String() string

Variables

var File_waypoint_builtin_nomad_jobspec_plugin_proto protoreflect.FileDescriptor

var Options = []sdk.Option{
	sdk.WithComponents(&Platform{}),
}

Options are the SDK options to use for instantiation for the Nomad plugin.

Types

type Config

type Config struct {
	// The path to the job specification to load.
	Jobspec string `hcl:"jobspec,attr"`

	// Signifies whether the jobspec should be parsed as HCL1 or not
	Hcl1 bool `hcl:"hcl1,optional"`
}

Config is the configuration structure for the Platform.

type Deployment

type Deployment struct {
	Id            string         `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name          string         `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	ResourceState *opaqueany.Any `protobuf:"bytes,3,opt,name=resource_state,json=resourceState,proto3" json:"resource_state,omitempty"`
	// contains filtered or unexported fields
}

func (*Deployment) Descriptor

func (*Deployment) Descriptor() ([]byte, []int)

Deprecated: Use Deployment.ProtoReflect.Descriptor instead.

func (*Deployment) GetId

func (x *Deployment) GetId() string

func (*Deployment) GetName

func (x *Deployment) GetName() string

func (*Deployment) GetResourceState

func (x *Deployment) GetResourceState() *opaqueany.Any

func (*Deployment) ProtoMessage

func (*Deployment) ProtoMessage()

func (*Deployment) ProtoReflect

func (x *Deployment) ProtoReflect() protoreflect.Message

func (*Deployment) Reset

func (x *Deployment) Reset()

func (*Deployment) String

func (x *Deployment) String() string

type Platform

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

Platform is the Platform implementation for Nomad.

func (*Platform) Config

func (p *Platform) Config() (interface{}, error)

Config implements Configurable

func (*Platform) Deploy

func (p *Platform) Deploy(
	ctx context.Context,
	log hclog.Logger,
	src *component.Source,
	img *docker.Image,
	deployConfig *component.DeploymentConfig,
	dcr *component.DeclaredResourcesResp,
	ui terminal.UI,
) (*Deployment, error)

Deploy deploys an image to Nomad.

func (*Platform) DeployFunc

func (p *Platform) DeployFunc() interface{}

DeployFunc implements component.Platform

func (*Platform) Destroy

func (p *Platform) Destroy(
	ctx context.Context,
	log hclog.Logger,
	deployment *Deployment,
	ui terminal.UI,
) error

Destroy deletes the Nomad job.

func (*Platform) DestroyFunc

func (p *Platform) DestroyFunc() interface{}

DestroyFunc implements component.Destroyer

func (*Platform) Documentation

func (p *Platform) Documentation() (*docs.Documentation, error)

func (*Platform) Generation

func (p *Platform) Generation(
	ctx context.Context,
	log hclog.Logger,
	src *component.Source,
	img *docker.Image,
	deployConfig *component.DeploymentConfig,
	ui terminal.UI,
) ([]byte, error)

Generation returns the generation ID. The ID we use is the name of the job since this is the unique ID that determines insert vs. update behavior for Nomad.

func (*Platform) GenerationFunc

func (p *Platform) GenerationFunc() interface{}

GenerationFunc implements component.Generation

func (*Platform) Status

func (p *Platform) Status(
	ctx context.Context,
	log hclog.Logger,
	deployment *Deployment,
	ui terminal.UI,
) (*sdk.StatusReport, error)

func (*Platform) StatusFunc

func (p *Platform) StatusFunc() interface{}

StatusFunc implements component.Status

type Resource

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

Resource contains the internal resource states.

func (*Resource) Descriptor

func (*Resource) Descriptor() ([]byte, []int)

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) ProtoMessage

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect

func (x *Resource) ProtoReflect() protoreflect.Message

func (*Resource) Reset

func (x *Resource) Reset()

func (*Resource) String

func (x *Resource) String() string

type Resource_Job

type Resource_Job struct {
	Name      string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Id        string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// contains filtered or unexported fields
}

func (*Resource_Job) Descriptor

func (*Resource_Job) Descriptor() ([]byte, []int)

Deprecated: Use Resource_Job.ProtoReflect.Descriptor instead.

func (*Resource_Job) GetId

func (x *Resource_Job) GetId() string

func (*Resource_Job) GetName

func (x *Resource_Job) GetName() string

func (*Resource_Job) GetNamespace

func (x *Resource_Job) GetNamespace() string

func (*Resource_Job) ProtoMessage

func (*Resource_Job) ProtoMessage()

func (*Resource_Job) ProtoReflect

func (x *Resource_Job) ProtoReflect() protoreflect.Message

func (*Resource_Job) Reset

func (x *Resource_Job) Reset()

func (*Resource_Job) String

func (x *Resource_Job) String() string