Documentation ¶
Index ¶
- Constants
- 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 KeyringCommand
- type LeaveCommand
- type MembersCommand
- type MonitorCommand
- type ReloadCommand
- type TargettedUi
- type VersionCommand
- type WatchCommand
Constants ¶
const ( // RPCAddrEnvName defines an environment variable name which sets // an RPC address if there is no -rpc-addr specified. RPCAddrEnvName = "CONSUL_RPC_ADDR" // HTTPAddrEnvName defines an environment variable name which sets // the HTTP address if there is no -http-addr specified. HTTPAddrEnvName = "CONSUL_HTTP_ADDR" )
Variables ¶
This section is empty.
Functions ¶
func HTTPAddrFlag ¶
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 ¶
HTTPClient returns a new Consul HTTP client with the given address.
func HTTPClientDC ¶
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 ¶
EventCommand is a Command implementation that is used to fire new events
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 ExecCommand ¶
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 ¶
func (c *ExecCommand) Help() string
func (*ExecCommand) Run ¶
func (c *ExecCommand) Run(args []string) int
func (*ExecCommand) Synopsis ¶
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 KeyringCommand ¶
KeyringCommand is a Command implementation that handles querying, installing, and removing gossip encryption keys from a keyring.
func (*KeyringCommand) Help ¶
func (c *KeyringCommand) Help() string
func (*KeyringCommand) Run ¶
func (c *KeyringCommand) Run(args []string) int
func (*KeyringCommand) Synopsis ¶
func (c *KeyringCommand) 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 ¶
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 TargettedUi ¶
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 ¶
func (u *TargettedUi) Error(message string)
func (*TargettedUi) Info ¶
func (u *TargettedUi) Info(message string)
func (*TargettedUi) Output ¶
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 ¶
WatchCommand is a Command implementation that is used to setup a "watch" which uses a sub-process
func (*WatchCommand) Help ¶
func (c *WatchCommand) Help() string
func (*WatchCommand) Run ¶
func (c *WatchCommand) Run(args []string) int
func (*WatchCommand) Synopsis ¶
func (c *WatchCommand) Synopsis() string