Documentation
¶
Index ¶
- type CallFunc
- type NetworkCli
- func (cli *NetworkCli) Cmd(chain string, args ...string) error
- func (cli *NetworkCli) CmdNetworkCreate(chain string, args ...string) error
- func (cli *NetworkCli) CmdNetworkInfo(chain string, args ...string) error
- func (cli *NetworkCli) CmdNetworkJoin(chain string, args ...string) error
- func (cli *NetworkCli) CmdNetworkLeave(chain string, args ...string) error
- func (cli *NetworkCli) CmdNetworkLs(chain string, args ...string) error
- func (cli *NetworkCli) CmdNetworkRm(chain string, args ...string) error
- func (cli *NetworkCli) Subcmd(chain, name, signature, description string, exitOnError bool) *flag.FlagSet
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CallFunc ¶
CallFunc provides environment specific call utility to invoke backend functions from UI
type NetworkCli ¶
type NetworkCli struct {
// contains filtered or unexported fields
}
NetworkCli is the UI object for network subcmds
func NewNetworkCli ¶
func NewNetworkCli(out, err io.Writer, call CallFunc) *NetworkCli
NewNetworkCli is a conveninent function to create a NetworkCli object
func (*NetworkCli) Cmd ¶
func (cli *NetworkCli) Cmd(chain string, args ...string) error
Cmd is borrowed from Docker UI and acts as the entry point for network UI commands. network UI commands are designed to be invoked from multiple parent chains
func (*NetworkCli) CmdNetworkCreate ¶
func (cli *NetworkCli) CmdNetworkCreate(chain string, args ...string) error
CmdNetworkCreate handles Network Create UI
func (*NetworkCli) CmdNetworkInfo ¶
func (cli *NetworkCli) CmdNetworkInfo(chain string, args ...string) error
CmdNetworkInfo handles Network Info UI
func (*NetworkCli) CmdNetworkJoin ¶
func (cli *NetworkCli) CmdNetworkJoin(chain string, args ...string) error
CmdNetworkJoin handles the UI to let a Container join a Network via an endpoint Sample UI : <chain> network join <container-name/id> <network-name/id> [<endpoint-name>]
func (*NetworkCli) CmdNetworkLeave ¶
func (cli *NetworkCli) CmdNetworkLeave(chain string, args ...string) error
CmdNetworkLeave handles the UI to let a Container disconnect from a Network Sample UI : <chain> network leave <container-name/id> <network-name/id>
func (*NetworkCli) CmdNetworkLs ¶
func (cli *NetworkCli) CmdNetworkLs(chain string, args ...string) error
CmdNetworkLs handles Network List UI
func (*NetworkCli) CmdNetworkRm ¶
func (cli *NetworkCli) CmdNetworkRm(chain string, args ...string) error
CmdNetworkRm handles Network Delete UI