consul

README

ginny-consul

consul provider for ginny.

Configuration is possible via the standard Consul Environment Variables and via the target URI passed to grpc.Dial.

To register the resolver with the grpc-go run:

resolver.Register(consul.NewBuilder())

Afterwards it can be used by calling grpc.Dial() and passing an URI in the following format:

consul://[<consul-server>]/<serviceName>[?<OPT>[&<OPT>]...]

<OPT> is one of:

OPT	Format	Default	Description
scheme	http|https	default from github.com/hashicorp/consul/api	Establish connection to consul via http or https.
tags	<tag>,[,<tag>]...		Filter service by tags
health	healthy|fallbackToUnhealthy	healthy	healthy resolves only to services with a passing health status. fallbackToUnhealthy resolves to unhealthy ones if none exist with passing healthy status.
token	string	default from github.com/hashicorp/consul/api	Authenticate Consul API Request with the token.

Documentation

Index

• Variables
• func NewBuilder() *resolverBuilder
• func NewOptions(v *viper.Viper) (*consulApi.Config, error)
• type Client
  • func NewClient(ctx context.Context, conf *consulApi.Config) (*Client, error)
  • func (p *Client) Resolver(ctx context.Context, service string, tags []string) (addr string, err error)
  • func (p *Client) ServiceDeregister(ctx context.Context, service string) error
  • func (p *Client) ServiceRegister(ctx context.Context, service, addr string, tags []string, ...) error

Variables

var (
	ProviderSet = wire.NewSet(NewClient, NewOptions)
)

ProviderSet

Functions

func NewBuilder

func NewBuilder() *resolverBuilder

func NewOptions

func NewOptions(v *viper.Viper) (*consulApi.Config, error)

NewOptions

Types

type Client

type Client struct {
	Config *consulApi.Config
	Client *consulApi.Client
}

Client

func NewClient

func NewClient(ctx context.Context, conf *consulApi.Config) (*Client, error)

NewClient

func (*Client) Resolver

func (p *Client) Resolver(ctx context.Context, service string, tags []string) (addr string, err error)

Resolver

func (*Client) ServiceDeregister

func (p *Client) ServiceDeregister(ctx context.Context, service string) error

ServiceDeregister

func (*Client) ServiceRegister

func (p *Client) ServiceRegister(ctx context.Context, service, addr string, tags []string, meta map[string]string) error

ServiceRegister