Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

consul

package

Go to main page

Versions in this module

v0

v0.9.2

Aug 10, 2017

v0.9.1

Aug 9, 2017

Changes in this version

type ACL

+ func (a *ACL) Bootstrap(args *structs.DCSpecificRequest, reply *structs.ACL) error

type Client

+ func (c *Client) ServerAddrs() map[string]string

type Config

+ EnableACLReplication bool

type Server

+ func (s *Server) ServerAddrs() map[string]string

v0.9.0

Jul 20, 2017

Changes in this version

type Config

+ NotifyListen func()

type Server

+ Listener net.Listener

+ type SessionTimers struct

+ func NewSessionTimers() *SessionTimers

+ func (t *SessionTimers) Del(id string)

+ func (t *SessionTimers) Get(id string) *time.Timer

+ func (t *SessionTimers) Len() int

+ func (t *SessionTimers) ResetOrCreate(id string, ttl time.Duration, afterFunc func())

+ func (t *SessionTimers) Set(id string, tm *time.Timer)

+ func (t *SessionTimers) Stop(id string)

+ func (t *SessionTimers) StopAll()

v0.9.0-rc1

Jul 17, 2017

v0.8.5

Jun 27, 2017

Changes in this version

+ const ConsulServiceID

+ const ConsulServiceName

+ const DefaultDC

+ const DefaultLANSerfPort

+ const DefaultRPCPort

+ const DefaultRaftMultiplier

+ const DefaultWANSerfPort

+ const MaxRaftMultiplier

+ const ProtocolVersion2Compatible

+ const ProtocolVersionMax

+ const ProtocolVersionMin

+ const SerfCheckAliveOutput

+ const SerfCheckFailedOutput

+ const SerfCheckID

+ const SerfCheckName

+ const StatusReap

+ var DefaultRPCAddr = &net.TCPAddr

+ var ErrQueryNotFound = errors.New("Query not found")

+ func CanServersUnderstandProtocol(members []serf.Member, version uint8) (bool, error)

+ func FilterDirEnt(acl acl.ACL, ent structs.DirEntries) structs.DirEntries

+ func FilterEntries(f Filter) int

+ func FilterKeys(acl acl.ACL, keys []string) []string

+ func FilterTxnResults(acl acl.ACL, results structs.TxnResults) structs.TxnResults

+ func GetPrivateIP() (net.IP, error)

+ func GetPublicIPv6() (net.IP, error)

+ func NewFSM(gc *state.TombstoneGC, logOutput io.Writer) (*consulFSM, error)

+ func ServerMinRaftProtocol(members []serf.Member) (int, error)

+ func ServersMeetMinimumVersion(members []serf.Member, minVersion *version.Version) bool

+ func SnapshotRPC(connPool *pool.ConnPool, dc string, addr net.Addr, useTLS bool, ...) (io.ReadCloser, error)

+ type ACL struct

+ func (a *ACL) Apply(args *structs.ACLRequest, reply *string) error

+ func (a *ACL) Get(args *structs.ACLSpecificRequest, reply *structs.IndexedACLs) error

+ func (a *ACL) GetPolicy(args *structs.ACLPolicyRequest, reply *structs.ACLPolicy) error

+ func (a *ACL) List(args *structs.DCSpecificRequest, reply *structs.IndexedACLs) error

+ func (a *ACL) ReplicationStatus(args *structs.DCSpecificRequest, reply *structs.ACLReplicationStatus) error

+ type AutopilotPolicy interface

+ PromoteNonVoters func(*structs.AutopilotConfig) error

+ type BasicAutopilot struct

+ func (b *BasicAutopilot) PromoteNonVoters(autopilotConfig *structs.AutopilotConfig) error

+ type Catalog struct

+ func (c *Catalog) Deregister(args *structs.DeregisterRequest, reply *struct{}) error

+ func (c *Catalog) ListDatacenters(args *struct{}, reply *[]string) error

+ func (c *Catalog) ListNodes(args *structs.DCSpecificRequest, reply *structs.IndexedNodes) error

+ func (c *Catalog) ListServices(args *structs.DCSpecificRequest, reply *structs.IndexedServices) error

+ func (c *Catalog) NodeServices(args *structs.NodeSpecificRequest, reply *structs.IndexedNodeServices) error

+ func (c *Catalog) Register(args *structs.RegisterRequest, reply *struct{}) error

+ func (c *Catalog) ServiceNodes(args *structs.ServiceSpecificRequest, reply *structs.IndexedServiceNodes) error

+ type Client struct

+ func NewClient(config *Config) (*Client, error)

+ func NewClientLogger(config *Config, logger *log.Logger) (*Client, error)

+ func (c *Client) Encrypted() bool

+ func (c *Client) GetLANCoordinate() (*coordinate.Coordinate, error)

+ func (c *Client) JoinLAN(addrs []string) (int, error)

+ func (c *Client) KeyManagerLAN() *serf.KeyManager

+ func (c *Client) LANMembers() []serf.Member

+ func (c *Client) Leave() error

+ func (c *Client) LocalMember() serf.Member

+ func (c *Client) RPC(method string, args interface{}, reply interface{}) error

+ func (c *Client) RemoveFailedNode(node string) error

+ func (c *Client) Shutdown() error

+ func (c *Client) SnapshotRPC(args *structs.SnapshotRequest, in io.Reader, out io.Writer, ...) error

+ func (c *Client) Stats() map[string]map[string]string

+ type Config struct

+ ACLAgentToken string

+ ACLDatacenter string

+ ACLDefaultPolicy string

+ ACLDownPolicy string

+ ACLEnforceVersion8 bool

+ ACLMasterToken string

+ ACLReplicationApplyLimit int

+ ACLReplicationInterval time.Duration

+ ACLReplicationToken string

+ ACLTTL time.Duration

+ ACLToken string

+ AutopilotConfig *structs.AutopilotConfig

+ AutopilotInterval time.Duration

+ Bootstrap bool

+ BootstrapExpect int

+ Build string

+ CAFile string

+ CAPath string

+ CertFile string

+ CoordinateUpdateBatchSize int

+ CoordinateUpdateMaxBatches int

+ CoordinateUpdatePeriod time.Duration

+ DataDir string

+ Datacenter string

+ DevMode bool

+ Domain string

+ KeyFile string

+ LogOutput io.Writer

+ NodeID types.NodeID

+ NodeName string

+ NonVoter bool

+ ProtocolVersion uint8

+ RPCAddr *net.TCPAddr

+ RPCAdvertise *net.TCPAddr

+ RPCHoldTimeout time.Duration

+ RPCSrcAddr *net.TCPAddr

+ RaftConfig *raft.Config

+ ReconcileInterval time.Duration

+ RejoinAfterLeave bool

+ SerfFloodInterval time.Duration

+ SerfLANConfig *serf.Config

+ SerfWANConfig *serf.Config

+ ServerHealthInterval time.Duration

+ ServerName string

+ ServerUp func()

+ SessionTTLMin time.Duration

+ TLSCipherSuites []uint16

+ TLSMinVersion string

+ TLSPreferServerCipherSuites bool

+ TombstoneTTL time.Duration

+ TombstoneTTLGranularity time.Duration

+ UseTLS bool

+ UserEventHandler func(serf.UserEvent)

+ VerifyIncoming bool

+ VerifyOutgoing bool

+ VerifyServerHostname bool

+ func DefaultConfig() *Config

+ func (c *Config) CheckACL() error

+ func (c *Config) CheckProtocolVersion() error

+ func (c *Config) GetTokenForAgent() string

+ func (c *Config) ScaleRaft(raftMultRaw uint)

+ type Coordinate struct

+ func NewCoordinate(srv *Server) *Coordinate

+ func (c *Coordinate) ListDatacenters(args *struct{}, reply *[]structs.DatacenterMap) error

+ func (c *Coordinate) ListNodes(args *structs.DCSpecificRequest, reply *structs.IndexedCoordinates) error

+ func (c *Coordinate) Update(args *structs.CoordinateUpdateRequest, reply *struct{}) (err error)

+ type Filter interface

+ Filter func(int) bool

+ Len func() int

+ Move func(dst, src, span int)

+ type Health struct

+ func (h *Health) ChecksInState(args *structs.ChecksInStateRequest, reply *structs.IndexedHealthChecks) error

+ func (h *Health) NodeChecks(args *structs.NodeSpecificRequest, reply *structs.IndexedHealthChecks) error

+ func (h *Health) ServiceChecks(args *structs.ServiceSpecificRequest, reply *structs.IndexedHealthChecks) error

+ func (h *Health) ServiceNodes(args *structs.ServiceSpecificRequest, reply *structs.IndexedCheckServiceNodes) error

+ type Internal struct

+ func (m *Internal) EventFire(args *structs.EventFireRequest, reply *structs.EventFireResponse) error

+ func (m *Internal) KeyringOperation(args *structs.KeyringRequest, reply *structs.KeyringResponses) error

+ func (m *Internal) NodeDump(args *structs.DCSpecificRequest, reply *structs.IndexedNodeDump) error

+ func (m *Internal) NodeInfo(args *structs.NodeSpecificRequest, reply *structs.IndexedNodeDump) error

+ type KVS struct

+ func (k *KVS) Apply(args *structs.KVSRequest, reply *bool) error

+ func (k *KVS) Get(args *structs.KeyRequest, reply *structs.IndexedDirEntries) error

+ func (k *KVS) List(args *structs.KeyRequest, reply *structs.IndexedDirEntries) error

+ func (k *KVS) ListKeys(args *structs.KeyListRequest, reply *structs.IndexedKeyList) error

+ type Operator struct

+ func (op *Operator) AutopilotGetConfiguration(args *structs.DCSpecificRequest, reply *structs.AutopilotConfig) error

+ func (op *Operator) AutopilotSetConfiguration(args *structs.AutopilotSetConfigRequest, reply *bool) error

+ func (op *Operator) RaftGetConfiguration(args *structs.DCSpecificRequest, reply *structs.RaftConfigurationResponse) error

+ func (op *Operator) RaftRemovePeerByAddress(args *structs.RaftRemovePeerRequest, reply *struct{}) error

+ func (op *Operator) RaftRemovePeerByID(args *structs.RaftRemovePeerRequest, reply *struct{}) error

+ func (op *Operator) ServerHealth(args *structs.DCSpecificRequest, reply *structs.OperatorHealthReply) error

+ type PreparedQuery struct

+ func (p *PreparedQuery) Apply(args *structs.PreparedQueryRequest, reply *string) (err error)

+ func (p *PreparedQuery) Execute(args *structs.PreparedQueryExecuteRequest, ...) error

+ func (p *PreparedQuery) ExecuteRemote(args *structs.PreparedQueryExecuteRemoteRequest, ...) error

+ func (p *PreparedQuery) Explain(args *structs.PreparedQueryExecuteRequest, ...) error

+ func (p *PreparedQuery) Get(args *structs.PreparedQuerySpecificRequest, ...) error

+ func (p *PreparedQuery) List(args *structs.DCSpecificRequest, reply *structs.IndexedPreparedQueries) error

+ type RaftLayer struct

+ func NewRaftLayer(src, addr net.Addr, tlsWrap tlsutil.Wrapper, ...) *RaftLayer

+ func (l *RaftLayer) Accept() (net.Conn, error)

+ func (l *RaftLayer) Addr() net.Addr

+ func (l *RaftLayer) Close() error

+ func (l *RaftLayer) Dial(address raft.ServerAddress, timeout time.Duration) (net.Conn, error)

+ func (l *RaftLayer) Handoff(c net.Conn) error

+ type Server struct

+ func NewServer(config *Config) (*Server, error)

+ func NewServerLogger(config *Config, logger *log.Logger) (*Server, error)

+ func (s *Server) Encrypted() bool

+ func (s *Server) Flood(portFn servers.FloodPortFn, global *serf.Serf)

+ func (s *Server) FloodNotify()

+ func (s *Server) GetLANCoordinate() (*coordinate.Coordinate, error)

+ func (s *Server) GetWANCoordinate() (*coordinate.Coordinate, error)

+ func (s *Server) IsACLReplicationEnabled() bool

+ func (s *Server) IsLeader() bool

+ func (s *Server) JoinLAN(addrs []string) (int, error)

+ func (s *Server) JoinWAN(addrs []string) (int, error)

+ func (s *Server) KeyManagerLAN() *serf.KeyManager

+ func (s *Server) KeyManagerWAN() *serf.KeyManager

+ func (s *Server) LANMembers() []serf.Member

+ func (s *Server) Leave() error

+ func (s *Server) LocalMember() serf.Member

+ func (s *Server) RPC(method string, args interface{}, reply interface{}) error

+ func (s *Server) RegisterEndpoint(name string, handler interface{}) error

+ func (s *Server) RemoveFailedNode(node string) error

+ func (s *Server) Shutdown() error

+ func (s *Server) SnapshotRPC(args *structs.SnapshotRequest, in io.Reader, out io.Writer, ...) error

+ func (s *Server) Stats() map[string]map[string]string

+ func (s *Server) WANMembers() []serf.Member

+ type Session struct

+ func (s *Session) Apply(args *structs.SessionRequest, reply *string) error

+ func (s *Session) Get(args *structs.SessionSpecificRequest, reply *structs.IndexedSessions) error

+ func (s *Session) List(args *structs.DCSpecificRequest, reply *structs.IndexedSessions) error

+ func (s *Session) NodeSessions(args *structs.NodeSpecificRequest, reply *structs.IndexedSessions) error

+ func (s *Session) Renew(args *structs.SessionSpecificRequest, reply *structs.IndexedSessions) error

+ type StatsFetcher struct

+ func NewStatsFetcher(logger *log.Logger, pool *pool.ConnPool, datacenter string) *StatsFetcher

+ func (f *StatsFetcher) Fetch(ctx context.Context, servers []*agent.Server) map[string]*structs.ServerStats

+ type Status struct

+ func (s *Status) Leader(args struct{}, reply *string) error

+ func (s *Status) Peers(args struct{}, reply *[]string) error

+ func (s *Status) Ping(args struct{}, reply *struct{}) error

+ func (s *Status) RaftStats(args struct{}, reply *structs.ServerStats) error

+ type Txn struct

+ func (t *Txn) Apply(args *structs.TxnRequest, reply *structs.TxnResponse) error

+ func (t *Txn) Read(args *structs.TxnReadRequest, reply *structs.TxnReadResponse) error