commands

Documentation

Index

• Variables
• type AddBackend
  • func (ab *AddBackend) Help() string
  • func (ab *AddBackend) Run(args []string) int
  • func (ab *AddBackend) Synopsis() string
• type AddListener
  • func (al *AddListener) Help() string
  • func (al *AddListener) Run(args []string) int
  • func (al *AddListener) Synopsis() string
• type AddRoute
  • func (ar *AddRoute) Help() string
  • func (ar *AddRoute) Run(args []string) int
  • func (ar *AddRoute) Synopsis() string
• type AddServer
  • func (as *AddServer) Help() string
  • func (as *AddServer) Run(args []string) int
  • func (as *AddServer) Synopsis() string
• type BackendList
  • func (sl *BackendList) Help() string
  • func (sl *BackendList) Run(args []string) int
  • func (sl *BackendList) Synopsis() string
• type Listen
  • func (l *Listen) Help() string
  • func (l *Listen) Run(args []string) int
  • func (l *Listen) Synopsis() string
• type ListenerList
  • func (sl *ListenerList) Help() string
  • func (sl *ListenerList) Run(args []string) int
  • func (sl *ListenerList) Synopsis() string
• type PingServer
  • func (ps *PingServer) Help() string
  • func (ps *PingServer) Run(args []string) int
  • func (ps *PingServer) Synopsis() string
• type PluginList
  • func (sl *PluginList) Help() string
  • func (sl *PluginList) Run(args []string) int
  • func (sl *PluginList) Synopsis() string
• type RESTAgent
  • func (a *RESTAgent) Help() string
  • func (a *RESTAgent) Run(args []string) int
  • func (a *RESTAgent) Synopsis() string
• type RouteList
  • func (sl *RouteList) Help() string
  • func (sl *RouteList) Run(args []string) int
  • func (sl *RouteList) Synopsis() string
• type ServerList
  • func (sl *ServerList) Help() string
  • func (sl *ServerList) Run(args []string) int
  • func (sl *ServerList) Synopsis() string

Variables

var ErrBadPathSpec = errors.New("CA certificate path is invalid or inaccessible")

ErrBadPathSPec indicates the given CACertPath is invalid. Note at config time we just check that the path is valid. When the listen command is run if the backend is part of a processing path we load the file, check its format and content, and so on.

Types

type AddBackend

type AddBackend struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

AddBackend provides a CLI compatible command

func (*AddBackend) Help

func (ab *AddBackend) Help() string

Help provides detailed command help

func (*AddBackend) Run

func (ab *AddBackend) Run(args []string) int

Run processed the command line argument passed in args for adding a backend configuration to the KV store assocaited with AddBackend

func (*AddBackend) Synopsis

func (ab *AddBackend) Synopsis() string

Synopsis gives the synopsis of the AddBackend command

type AddListener

type AddListener struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

AddListener command

func (*AddListener) Help

func (al *AddListener) Help() string

Help provides details on the expected arguments for the AddListener command

func (*AddListener) Run

func (al *AddListener) Run(args []string) int

Run executes the AddListener command with the given arguments

func (*AddListener) Synopsis

func (al *AddListener) Synopsis() string

Synopsis gives the synopsis of the AddListener command

type AddRoute

type AddRoute struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

AddRoute command

func (*AddRoute) Help

func (ar *AddRoute) Help() string

Help provides details on command line options for AddRoute

func (*AddRoute) Run

func (ar *AddRoute) Run(args []string) int

Run executes the AddRoute command using the provided arguments

func (*AddRoute) Synopsis

func (ar *AddRoute) Synopsis() string

Synopsis provides a concise description of the AddRoute command.

type AddServer

type AddServer struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

AddServer command

func (*AddServer) Help

func (as *AddServer) Help() string

Help provides details on using the AddServer command

func (*AddServer) Run

func (as *AddServer) Run(args []string) int

Run executes the AddServer command using the supplied args

func (*AddServer) Synopsis

func (as *AddServer) Synopsis() string

Synopsis gives a concise description of the AddServer command

type BackendList

type BackendList struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

BackendList command

func (*BackendList) Help

func (sl *BackendList) Help() string

Help provides details on the BackendList command

func (*BackendList) Run

func (sl *BackendList) Run(args []string) int

Run executes the BackendList command with the supplied args

func (*BackendList) Synopsis

func (sl *BackendList) Synopsis() string

Synopsis provides a concise description of the BackendList command

type Listen

type Listen struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

Listen command, which starts up a proxy listener based on the configuration associated with the given listener name

func (*Listen) Help

func (l *Listen) Help() string

Help provides details on the Listen command

func (*Listen) Run

func (l *Listen) Run(args []string) int

Run executes the Listen command with the supplied arguments

func (*Listen) Synopsis

func (l *Listen) Synopsis() string

Synopsis provides a concise description of the Listen command

type ListenerList

type ListenerList struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

ListenerList command

func (*ListenerList) Help

func (sl *ListenerList) Help() string

Help provides details on the ListenerList command

func (*ListenerList) Run

func (sl *ListenerList) Run(args []string) int

Run executes the ListenerList command with the supplied args

func (*ListenerList) Synopsis

func (sl *ListenerList) Synopsis() string

Synopsis provides a concise description of the ListenerList command

type PingServer

type PingServer struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

PingServer command, use to ping a server based on the named server definition.

func (*PingServer) Help

func (ps *PingServer) Help() string

Help provides details on the PingServer command

func (*PingServer) Run

func (ps *PingServer) Run(args []string) int

Run executes the PingServer command using the supplied args

func (*PingServer) Synopsis

func (ps *PingServer) Synopsis() string

Synopsis provides a concise description of the PingServer command

type PluginList

type PluginList struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

PluginList command

func (*PluginList) Help

func (sl *PluginList) Help() string

Help provides details on the PluginList command

func (*PluginList) Run

func (sl *PluginList) Run(args []string) int

Run executes the PluginList command with the supplied args

func (*PluginList) Synopsis

func (sl *PluginList) Synopsis() string

Synopsis provides a concise description of the PluginList command

type RESTAgent

type RESTAgent struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

RESTAgent command, which starts a REST endpoint for executing commands supporting a REST interface

func (*RESTAgent) Help

func (a *RESTAgent) Help() string

Help provides details on the RESTAgent command

func (*RESTAgent) Run

func (a *RESTAgent) Run(args []string) int

Run executes the RESTAgent command with the supplied args

func (*RESTAgent) Synopsis

func (a *RESTAgent) Synopsis() string

Synopsis provides a concise description of the RESTAgent command

type RouteList

type RouteList struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

RouteList command

func (*RouteList) Help

func (sl *RouteList) Help() string

Help provides details on the RouteList command

func (*RouteList) Run

func (sl *RouteList) Run(args []string) int

Run executes the RouteList command with the supplied args

func (*RouteList) Synopsis

func (sl *RouteList) Synopsis() string

Synopsis provides a concise description of the RouteList command

type ServerList

type ServerList struct {
	UI      cli.Ui
	KVStore kvstore.KVStore
}

ServerList command

func (*ServerList) Help

func (sl *ServerList) Help() string

Help provides details on the ServerList command

func (*ServerList) Run

func (sl *ServerList) Run(args []string) int

Run executes the ServerList command with the supplied args

func (*ServerList) Synopsis

func (sl *ServerList) Synopsis() string

Synopsis provides a concise description of the ServerList command