consul

Documentation

Index

• func NewHook(cfg Config) (hook.Hook, error)
• type Config
• type Hook
  • func (h *Hook) DeregisterFromConsul(taskInfo mesosutils.TaskInfo) error
  • func (h *Hook) HandleEvent(event hook.Event) (hook.Env, error)
  • func (h *Hook) RegisterIntoConsul(taskInfo mesosutils.TaskInfo) error

Functions

func NewHook

func NewHook(cfg Config) (hook.Hook, error)

NewHook creates new Consul hook that is responsible for graceful Consul deregistration.

Types

type Config

type Config struct {
	// Consul ACL Token
	ConsulToken string `default:"" envconfig:"consul_token"`
}

Config is Consul hook configuration settable from environment

type Hook

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

Hook is an executor hook implementation that will register and deregister a service instance in Consul right after startup and just before task termination, respectively.

func (*Hook) DeregisterFromConsul

func (h *Hook) DeregisterFromConsul(taskInfo mesosutils.TaskInfo) error

DeregisterFromConsul will deregister service IDs from Consul that were created during AfterTaskStartEvent hook event.

func (*Hook) HandleEvent

func (h *Hook) HandleEvent(event hook.Event) (hook.Env, error)

HandleEvent calls appropriate hook functions that correspond to supported event types. Unsupported events are ignored.

func (*Hook) RegisterIntoConsul

func (h *Hook) RegisterIntoConsul(taskInfo mesosutils.TaskInfo) error

RegisterIntoConsul generates an id and sends service information to Consul Agent