consul

Documentation

Overview

Package consul provides subscriber and registrar implementations for Consul.

Index

• type Client
  • func NewClient(c *consul.Client) Client
• type Registrar
  • func NewRegistrar(client Client, r *stdconsul.AgentServiceRegistration, logger log.Logger) *Registrar
  • func (p *Registrar) Deregister()
  • func (p *Registrar) Register()
• type Subscriber
  • func NewSubscriber(client Client, factory sd.Factory, logger log.Logger, service string, ...) *Subscriber
  • func (s *Subscriber) Endpoints() ([]endpoint.Endpoint, error)
  • func (s *Subscriber) Stop()

Types

type Client

type Client interface {
	// Register a service with the local agent.
	Register(r *consul.AgentServiceRegistration) error

	// Deregister a service with the local agent.
	Deregister(r *consul.AgentServiceRegistration) error

	// Service
	Service(service, tag string, passingOnly bool, queryOpts *consul.QueryOptions) ([]*consul.ServiceEntry, *consul.QueryMeta, error)
}

Client is a wrapper around the Consul API.

func NewClient

func NewClient(c *consul.Client) Client

NewClient returns an implementation of the Client interface, wrapping a concrete Consul client.

type Registrar

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

Registrar registers service instance liveness information to Consul.

func NewRegistrar

func NewRegistrar(client Client, r *stdconsul.AgentServiceRegistration, logger log.Logger) *Registrar

NewRegistrar returns a Consul Registrar acting on the provided catalog registration.

func (*Registrar) Deregister

func (p *Registrar) Deregister()

Deregister implements sd.Registrar interface.

func (*Registrar) Register

func (p *Registrar) Register()

Register implements sd.Registrar interface.

type Subscriber

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

Subscriber yields endpoints for a service in Consul. Updates to the service are watched and will update the Subscriber endpoints.

func NewSubscriber

func NewSubscriber(client Client, factory sd.Factory, logger log.Logger, service string, tags []string, passingOnly bool) *Subscriber

NewSubscriber returns a Consul subscriber which returns endpoints for the requested service. It only returns instances for which all of the passed tags are present.

func (*Subscriber) Endpoints

func (s *Subscriber) Endpoints() ([]endpoint.Endpoint, error)

Endpoints implements the Subscriber interface.

func (*Subscriber) Stop

func (s *Subscriber) Stop()

Stop terminates the subscriber.