command

Documentation

Index

• func RPCAddrFlag(f *flag.FlagSet) *string
• func RPCAuthFlag(f *flag.FlagSet) *string
• func RPCClient(addr, auth string) (*client.RPCClient, error)
• type EventCommand
  • func (c *EventCommand) Help() string
  • func (c *EventCommand) Run(args []string) int
  • func (c *EventCommand) Synopsis() string
• type ForceLeaveCommand
  • func (c *ForceLeaveCommand) Help() string
  • func (c *ForceLeaveCommand) Run(args []string) int
  • func (c *ForceLeaveCommand) Synopsis() string
• type InfoCommand
  • func (i *InfoCommand) Help() string
  • func (i *InfoCommand) Run(args []string) int
  • func (i *InfoCommand) Synopsis() string
• type JoinCommand
  • func (c *JoinCommand) Help() string
  • func (c *JoinCommand) Run(args []string) int
  • func (c *JoinCommand) Synopsis() string
• type KeygenCommand
  • func (c *KeygenCommand) Help() string
  • func (c *KeygenCommand) Run(_ []string) int
  • func (c *KeygenCommand) Synopsis() string
• type KeysCommand
  • func (c *KeysCommand) Help() string
  • func (c *KeysCommand) Run(args []string) int
  • func (c *KeysCommand) Synopsis() string
• type LeaveCommand
  • func (c *LeaveCommand) Help() string
  • func (c *LeaveCommand) Run(args []string) int
  • func (c *LeaveCommand) Synopsis() string
• type Member
• type MemberContainer
  • func (c MemberContainer) String() string
• type MembersCommand
  • func (c *MembersCommand) Help() string
  • func (c *MembersCommand) Run(args []string) int
  • func (c *MembersCommand) Synopsis() string
• type MonitorCommand
  • func (c *MonitorCommand) Help() string
  • func (c *MonitorCommand) Run(args []string) int
  • func (c *MonitorCommand) Synopsis() string
• type QueryCommand
  • func (c *QueryCommand) Help() string
  • func (c *QueryCommand) Run(args []string) int
  • func (c *QueryCommand) Synopsis() string
• type ReachabilityCommand
  • func (c *ReachabilityCommand) Help() string
  • func (c *ReachabilityCommand) Run(args []string) int
  • func (c *ReachabilityCommand) Synopsis() string
• type StatsContainer
  • func (s StatsContainer) String() string
• type TagsCommand
  • func (c *TagsCommand) Help() string
  • func (c *TagsCommand) Run(args []string) int
  • func (c *TagsCommand) Synopsis() string
• type VersionCommand
  • func (c *VersionCommand) Help() string
  • func (c *VersionCommand) Run(_ []string) int
  • func (c *VersionCommand) Synopsis() string

Functions

func RPCAddrFlag

func RPCAddrFlag(f *flag.FlagSet) *string

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

func RPCAuthFlag(f *flag.FlagSet) *string

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.

func RPCClient

func RPCClient(addr, auth string) (*client.RPCClient, error)

RPCClient returns a new Serf RPC client with the given address.

Types

type EventCommand

type EventCommand struct {
	Ui cli.Ui
}

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

type ForceLeaveCommand struct {
	Ui cli.Ui
}

ForceLeaveCommand is a Command implementation that tells a running Serf to force a member to enter the "left" state.

func (*ForceLeaveCommand) Help

func (c *ForceLeaveCommand) Help() string

func (*ForceLeaveCommand) Run

func (c *ForceLeaveCommand) Run(args []string) int

func (*ForceLeaveCommand) Synopsis

func (c *ForceLeaveCommand) Synopsis() string

type InfoCommand

type InfoCommand struct {
	Ui cli.Ui
}

InfoCommand is a Command implementation that queries a running Serf agent for various debugging statistics for operators

func (*InfoCommand) Help

func (i *InfoCommand) Help() string

func (*InfoCommand) Run

func (i *InfoCommand) Run(args []string) int

func (*InfoCommand) Synopsis

func (i *InfoCommand) Synopsis() string

type JoinCommand

type JoinCommand struct {
	Ui cli.Ui
}

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

type KeygenCommand struct {
	Ui cli.Ui
}

KeygenCommand is a Command implementation that generates an encryption key for use in `serf agent`.

func (*KeygenCommand) Help

func (c *KeygenCommand) Help() string

func (*KeygenCommand) Run

func (c *KeygenCommand) Run(_ []string) int

func (*KeygenCommand) Synopsis

func (c *KeygenCommand) Synopsis() string

type KeysCommand

type KeysCommand struct {
	Ui cli.Ui
}

func (*KeysCommand) Help

func (c *KeysCommand) Help() string

func (*KeysCommand) Run

func (c *KeysCommand) Run(args []string) int

func (*KeysCommand) Synopsis

func (c *KeysCommand) Synopsis() string

type LeaveCommand

type LeaveCommand struct {
	Ui cli.Ui
}

LeaveCommand is a Command implementation that instructs the Serf agent to gracefully leave the cluster

func (*LeaveCommand) Help

func (c *LeaveCommand) Help() string

func (*LeaveCommand) Run

func (c *LeaveCommand) Run(args []string) int

func (*LeaveCommand) Synopsis

func (c *LeaveCommand) Synopsis() string

type Member

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

type MemberContainer struct {
	Members []Member `json:"members"`
}

func (MemberContainer) String

func (c MemberContainer) String() string

type MembersCommand

type MembersCommand struct {
	Ui cli.Ui
}

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

type QueryCommand struct {
	ShutdownCh <-chan struct{}
	Ui         cli.Ui
}

QueryCommand is a Command implementation that is used to trigger a new query and wait for responses and acks

func (*QueryCommand) Help

func (c *QueryCommand) Help() string

func (*QueryCommand) Run

func (c *QueryCommand) Run(args []string) int

func (*QueryCommand) Synopsis

func (c *QueryCommand) Synopsis() string

type ReachabilityCommand

type ReachabilityCommand struct {
	ShutdownCh <-chan struct{}
	Ui         cli.Ui
}

ReachabilityCommand is a Command implementation that is used to trigger a new reachability test

func (*ReachabilityCommand) Help

func (c *ReachabilityCommand) Help() string

func (*ReachabilityCommand) Run

func (c *ReachabilityCommand) Run(args []string) int

func (*ReachabilityCommand) Synopsis

func (c *ReachabilityCommand) Synopsis() string

type StatsContainer

type StatsContainer map[string]map[string]string

func (StatsContainer) String

func (s StatsContainer) String() string

type TagsCommand

type TagsCommand struct {
	Ui cli.Ui
}

TagsCommand is an interface to dynamically add or otherwise modify a running serf agent's tags.

func (*TagsCommand) Help

func (c *TagsCommand) Help() string

func (*TagsCommand) Run

func (c *TagsCommand) Run(args []string) int

func (*TagsCommand) Synopsis

func (c *TagsCommand) Synopsis() string

type VersionCommand

type VersionCommand struct {
	Revision          string
	Version           string
	VersionPrerelease string
	Ui                cli.Ui
}

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