Documentation ¶
Index ¶
- func HTTPAddrFlag(f *flag.FlagSet) *string
- func HTTPClient(addr string) (*consulapi.Client, error)
- func HTTPClientDC(addr, dc string) (*consulapi.Client, error)
- func RPCAddrFlag(f *flag.FlagSet) *string
- func RPCClient(addr string) (*agent.RPCClient, error)
- type EventCommand
- type ExecCommand
- type ForceLeaveCommand
- type InfoCommand
- type JoinCommand
- type KeygenCommand
- type LeaveCommand
- type MembersCommand
- type MonitorCommand
- type ReloadCommand
- type TargettedUi
- type VersionCommand
- type WatchCommand
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HTTPAddrFlag ¶ added in v0.4.0
HTTPAddrFlag returns a pointer to a string that will be populated when the given flagset is parsed with the HTTP address of the Consul.
func HTTPClient ¶ added in v0.4.0
HTTPClient returns a new Consul HTTP client with the given address.
func HTTPClientDC ¶ added in v0.4.0
HTTPClientDC returns a new Consul HTTP client with the given address and datacenter
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 Consul.
Types ¶
type EventCommand ¶ added in v0.4.0
EventCommand is a Command implementation that is used to fire new events
func (*EventCommand) Help ¶ added in v0.4.0
func (c *EventCommand) Help() string
func (*EventCommand) Run ¶ added in v0.4.0
func (c *EventCommand) Run(args []string) int
func (*EventCommand) Synopsis ¶ added in v0.4.0
func (c *EventCommand) Synopsis() string
type ExecCommand ¶ added in v0.4.0
type ExecCommand struct { ShutdownCh <-chan struct{} Ui cli.Ui // contains filtered or unexported fields }
ExecCommand is a Command implementation that is used to do remote execution of commands
func (*ExecCommand) Help ¶ added in v0.4.0
func (c *ExecCommand) Help() string
func (*ExecCommand) Run ¶ added in v0.4.0
func (c *ExecCommand) Run(args []string) int
func (*ExecCommand) Synopsis ¶ added in v0.4.0
func (c *ExecCommand) Synopsis() string
type ForceLeaveCommand ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶ added in v0.3.0
ReloadCommand is a Command implementation that instructs the Consul agent to reload configurations
func (*ReloadCommand) Help ¶ added in v0.3.0
func (c *ReloadCommand) Help() string
func (*ReloadCommand) Run ¶ added in v0.3.0
func (c *ReloadCommand) Run(args []string) int
func (*ReloadCommand) Synopsis ¶ added in v0.3.0
func (c *ReloadCommand) Synopsis() string
type TargettedUi ¶ added in v0.4.0
TargettedUi is a UI that wraps another UI implementation and modifies the output to indicate a specific target. Specifically, all Say output is prefixed with the target name. Message output is not prefixed but is offset by the length of the target so that output is lined up properly with Say output. Machine-readable output has the proper target set.
func (*TargettedUi) Error ¶ added in v0.4.0
func (u *TargettedUi) Error(message string)
func (*TargettedUi) Info ¶ added in v0.4.0
func (u *TargettedUi) Info(message string)
func (*TargettedUi) Output ¶ added in v0.4.0
func (u *TargettedUi) Output(message 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
type WatchCommand ¶ added in v0.4.0
WatchCommand is a Command implementation that is used to setup a "watch" which uses a sub-process
func (*WatchCommand) Help ¶ added in v0.4.0
func (c *WatchCommand) Help() string
func (*WatchCommand) Run ¶ added in v0.4.0
func (c *WatchCommand) Run(args []string) int
func (*WatchCommand) Synopsis ¶ added in v0.4.0
func (c *WatchCommand) Synopsis() string