Documentation ¶
Index ¶
- func RPCAddrFlag(f *flag.FlagSet) *string
- func RPCAuthFlag(f *flag.FlagSet) *string
- func RPCClient(addr, auth string) (*client.RPCClient, error)
- type EventCommand
- type ForceLeaveCommand
- type InfoCommand
- type JoinCommand
- type KeygenCommand
- type KeysCommand
- type LeaveCommand
- type Member
- type MemberContainer
- type MembersCommand
- type MonitorCommand
- type QueryCommand
- type RTTCommand
- type ReachabilityCommand
- type StatsContainer
- type TagsCommand
- type VersionCommand
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RPCAddrFlag ¶
RPCAddrFlag returns a pointer to a string that will be populated when the given flagset is parsed with the RPC address of the Serf.
func RPCAuthFlag ¶ added in v0.5.0
RPCAuthFlag returns a pointer to a string that will be populated when the given flagset is parsed with the RPC auth token of the Serf.
Types ¶
type EventCommand ¶
EventCommand is a Command implementation that queries a running Serf agent what members are part of the cluster currently.
func (*EventCommand) Help ¶
func (c *EventCommand) Help() string
func (*EventCommand) Run ¶
func (c *EventCommand) Run(args []string) int
func (*EventCommand) Synopsis ¶
func (c *EventCommand) Synopsis() string
type ForceLeaveCommand ¶ added in v0.2.0
ForceLeaveCommand is a Command implementation that tells a running Serf to force a member to enter the "left" state.
func (*ForceLeaveCommand) Help ¶ added in v0.2.0
func (c *ForceLeaveCommand) Help() string
func (*ForceLeaveCommand) Run ¶ added in v0.2.0
func (c *ForceLeaveCommand) Run(args []string) int
func (*ForceLeaveCommand) Synopsis ¶ added in v0.2.0
func (c *ForceLeaveCommand) Synopsis() string
type InfoCommand ¶ added in v0.6.0
InfoCommand is a Command implementation that queries a running Serf agent for various debugging statistics for operators
func (*InfoCommand) Help ¶ added in v0.6.0
func (i *InfoCommand) Help() string
func (*InfoCommand) Run ¶ added in v0.6.0
func (i *InfoCommand) Run(args []string) int
func (*InfoCommand) Synopsis ¶ added in v0.6.0
func (i *InfoCommand) Synopsis() string
type JoinCommand ¶
JoinCommand is a Command implementation that tells a running Serf agent to join another.
func (*JoinCommand) Help ¶
func (c *JoinCommand) Help() string
func (*JoinCommand) Run ¶
func (c *JoinCommand) Run(args []string) int
func (*JoinCommand) Synopsis ¶
func (c *JoinCommand) Synopsis() string
type KeygenCommand ¶ added in v0.2.0
KeygenCommand is a Command implementation that generates an encryption key for use in `serf agent`.
func (*KeygenCommand) Help ¶ added in v0.2.0
func (c *KeygenCommand) Help() string
func (*KeygenCommand) Run ¶ added in v0.2.0
func (c *KeygenCommand) Run(_ []string) int
func (*KeygenCommand) Synopsis ¶ added in v0.2.0
func (c *KeygenCommand) Synopsis() string
type KeysCommand ¶ added in v0.6.0
func (*KeysCommand) Help ¶ added in v0.6.0
func (c *KeysCommand) Help() string
func (*KeysCommand) Run ¶ added in v0.6.0
func (c *KeysCommand) Run(args []string) int
func (*KeysCommand) Synopsis ¶ added in v0.6.0
func (c *KeysCommand) Synopsis() string
type LeaveCommand ¶ added in v0.3.0
LeaveCommand is a Command implementation that instructs the Serf agent to gracefully leave the cluster
func (*LeaveCommand) Help ¶ added in v0.3.0
func (c *LeaveCommand) Help() string
func (*LeaveCommand) Run ¶ added in v0.3.0
func (c *LeaveCommand) Run(args []string) int
func (*LeaveCommand) Synopsis ¶ added in v0.3.0
func (c *LeaveCommand) Synopsis() string
type Member ¶ added in v0.4.0
type Member struct { Name string `json:"name"` Addr string `json:"addr"` Port uint16 `json:"port"` Tags map[string]string `json:"tags"` Status string `json:"status"` Proto map[string]uint8 `json:"protocol"` // contains filtered or unexported fields }
A container of member details. Maintaining a command-specific struct here makes sense so that the agent.Member struct can evolve without changing the keys in the output interface.
type MemberContainer ¶ added in v0.4.0
type MemberContainer struct {
Members []Member `json:"members"`
}
func (MemberContainer) String ¶ added in v0.4.0
func (c MemberContainer) String() string
type MembersCommand ¶
MembersCommand is a Command implementation that queries a running Serf agent what members are part of the cluster currently.
func (*MembersCommand) Help ¶
func (c *MembersCommand) Help() string
func (*MembersCommand) Run ¶
func (c *MembersCommand) Run(args []string) int
func (*MembersCommand) Synopsis ¶
func (c *MembersCommand) Synopsis() string
type MonitorCommand ¶
type MonitorCommand struct { ShutdownCh <-chan struct{} Ui cli.Ui // contains filtered or unexported fields }
MonitorCommand is a Command implementation that queries a running Serf agent what members are part of the cluster currently.
func (*MonitorCommand) Help ¶
func (c *MonitorCommand) Help() string
func (*MonitorCommand) Run ¶
func (c *MonitorCommand) Run(args []string) int
func (*MonitorCommand) Synopsis ¶
func (c *MonitorCommand) Synopsis() string
type QueryCommand ¶ added in v0.5.0
QueryCommand is a Command implementation that is used to trigger a new query and wait for responses and acks
func (*QueryCommand) Help ¶ added in v0.5.0
func (c *QueryCommand) Help() string
func (*QueryCommand) Run ¶ added in v0.5.0
func (c *QueryCommand) Run(args []string) int
func (*QueryCommand) Synopsis ¶ added in v0.5.0
func (c *QueryCommand) Synopsis() string
type RTTCommand ¶ added in v0.7.0
RTTCommand is a Command implementation that allows users to query the estimated round trip time between nodes using network coordinates.
func (*RTTCommand) Help ¶ added in v0.7.0
func (c *RTTCommand) Help() string
func (*RTTCommand) Run ¶ added in v0.7.0
func (c *RTTCommand) Run(args []string) int
func (*RTTCommand) Synopsis ¶ added in v0.7.0
func (c *RTTCommand) Synopsis() string
type ReachabilityCommand ¶ added in v0.5.0
ReachabilityCommand is a Command implementation that is used to trigger a new reachability test
func (*ReachabilityCommand) Help ¶ added in v0.5.0
func (c *ReachabilityCommand) Help() string
func (*ReachabilityCommand) Run ¶ added in v0.5.0
func (c *ReachabilityCommand) Run(args []string) int
func (*ReachabilityCommand) Synopsis ¶ added in v0.5.0
func (c *ReachabilityCommand) Synopsis() string
type StatsContainer ¶ added in v0.6.0
func (StatsContainer) String ¶ added in v0.6.0
func (s StatsContainer) String() string
type TagsCommand ¶ added in v0.4.5
TagsCommand is an interface to dynamically add or otherwise modify a running serf agent's tags.
func (*TagsCommand) Help ¶ added in v0.4.5
func (c *TagsCommand) Help() string
func (*TagsCommand) Run ¶ added in v0.4.5
func (c *TagsCommand) Run(args []string) int
func (*TagsCommand) Synopsis ¶ added in v0.4.5
func (c *TagsCommand) Synopsis() string
type VersionCommand ¶
VersionCommand is a Command implementation prints the version.
func (*VersionCommand) Help ¶
func (c *VersionCommand) Help() string
func (*VersionCommand) Run ¶
func (c *VersionCommand) Run(_ []string) int
func (*VersionCommand) Synopsis ¶
func (c *VersionCommand) Synopsis() string