package command

import "github.com/hashicorp/serf/command"

Index

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 RPCClient 

func RPCClient(addr 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 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 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 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

Source Files

event.go force_leave.go join.go keygen.go leave.go members.go monitor.go output.go rpc.go tags.go version.go

Directories

PathSynopsis
command/agent
Version
v0.4.5
Published
Feb 25, 2014
Platform
js/wasm
Imports
16 packages
Last checked
3 weeks ago –

Tools for package owners.