command

Documentation

Index

• func RPCAddrFlag(f *flag.FlagSet) *string
• func RPCClient(addr string) (*agent.RPCClient, error)
• 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 LeaveCommand
  • func (c *LeaveCommand) Help() string
  • func (c *LeaveCommand) Run(args []string) int
  • func (c *LeaveCommand) Synopsis() 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 ReloadCommand
  • func (c *ReloadCommand) Help() string
  • func (c *ReloadCommand) Run(args []string) int
  • func (c *ReloadCommand) 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 Consul.

func RPCClient

func RPCClient(addr string) (*agent.RPCClient, error)

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

Types

type ForceLeaveCommand

type ForceLeaveCommand struct {
	Ui cli.Ui
}

ForceLeaveCommand is a Command implementation that tells a running Consul 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 Consul 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 Consul 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 `consul 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 Consul 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 MembersCommand

type MembersCommand struct {
	Ui cli.Ui
}

MembersCommand is a Command implementation that queries a running Consul 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 Consul 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 ReloadCommand

type ReloadCommand struct {
	Ui cli.Ui
}

ReloadCommand is a Command implementation that instructs the Consul agent to reload configurations

func (*ReloadCommand) Help

func (c *ReloadCommand) Help() string

func (*ReloadCommand) Run

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

func (*ReloadCommand) Synopsis

func (c *ReloadCommand) 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