metadata

Documentation

Index

• Constants
• func AddFeatureFlags(tags map[string]string, flags ...string)
• func Build(m *serf.Member) (*version.Version, error)
• type Key
  • func (k *Key) Equal(x *Key) bool
• type Server
  • func IsConsulServer(m serf.Member) (bool, *Server)
  • func (s *Server) Key() *Key
  • func (s *Server) String() string

Constants

const TagACLs = "acls"

TODO(ACL-Legacy-Compat): remove in phase 2

Functions

func AddFeatureFlags

func AddFeatureFlags(tags map[string]string, flags ...string)

AddFeatureFlags to the tags. The tags map is expected to be a serf.Config.Tags. The feature flags are encoded in the tags so that IsConsulServer can decode them and populate the Server.FeatureFlags map.

func Build

func Build(m *serf.Member) (*version.Version, error)

Build extracts the Consul version info for a member.

Types

type Key

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

Key is used in maps and for equality tests. A key is based on endpoints.

func (*Key) Equal

func (k *Key) Equal(x *Key) bool

Equal compares two Key objects

type Server

type Server struct {
	Name             string // <node>.<dc>
	ShortName        string // <node>
	ID               string
	Datacenter       string
	Segment          string
	Port             int
	SegmentAddrs     map[string]string
	SegmentPorts     map[string]int
	WanJoinPort      int
	LanJoinPort      int
	ExternalGRPCPort int
	Bootstrap        bool
	Expect           int
	Build            version.Version
	Version          int
	RaftVersion      int
	Addr             net.Addr
	Status           serf.MemberStatus
	ReadReplica      bool
	FeatureFlags     map[string]int

	// If true, use TLS when connecting to this server
	UseTLS bool
}

Server is used to return details of a consul server

func IsConsulServer

func IsConsulServer(m serf.Member) (bool, *Server)

IsConsulServer returns true if a serf member is a consul server agent. Returns a bool and a pointer to the Server.

func (*Server) Key

func (s *Server) Key() *Key

Key returns the corresponding Key

func (*Server) String

func (s *Server) String() string

String returns a string representation of Server