consul

Documentation

Overview

Package consul exposes a Consul service and client.

Index

• Constants
• func NewComponent(opts ...docker.SimpleContainerOptionFunc) *docker.SimpleComponent
• type Client
  • func NewClient(address string) (Client, error)
  • func (c Client) Delete(key string) error
  • func (c Client) DeleteTree(prefix string) error
  • func (c Client) Live() error
  • func (c Client) Put(key, value string) error

Constants

const (
	// ServiceName is the advertised name of this service.
	ServiceName = "consul"
)

Functions

func NewComponent

func NewComponent(opts ...docker.SimpleContainerOptionFunc) *docker.SimpleComponent

NewComponent creates a new Consul component.

Types

type Client

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

Client is a Consul client.

func NewClient

func NewClient(address string) (Client, error)

NewClient creates a new Client.

func (Client) Delete

func (c Client) Delete(key string) error

Delete removes a value.

func (Client) DeleteTree

func (c Client) DeleteTree(prefix string) error

DeleteTree removes values under a prefix.

func (Client) Live

func (c Client) Live() error

Live is a liveness check.

func (Client) Put

func (c Client) Put(key, value string) error

Put stores a value.