consul

package module

v0.1.0 Latest Latest Go to latest Published: Feb 25, 2023 License: BSD-3-Clause Imports: 15 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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.

This section is empty.

View Source

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

ProviderSet

func NewBuilder() *resolverBuilder

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

NewOptions

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

Client

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

NewClient

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

Resolver

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

ServiceDeregister

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

ServiceRegister