types

Documentation

Index

• type CloseFunc
• type ClusterConfig
• type ConnAuth
• type ConnConfig
• type FocusFunc
• type LayoutFunc
• type Menu
• type Module
• type NodeClient
• type PageClusterData
• type PageConsoleData

Types

type CloseFunc

type CloseFunc func(container string, page *console.Page)

type ClusterConfig

type ClusterConfig struct {
	Name   string
	Config ConnConfig
}

type ConnAuth

type ConnAuth struct {
	// Type: ssh, cert
	Type string
	// Kind: key (ssh), file (certs), vault, password
	Kind string
	// Certficates: file path or from vault
	Ca        string
	Client    string
	ClientKey string

	// SSH key: file path or from vault
	SshKey string

	// Username & password when Kind is password
	Username string
	Passord  string
}

ConnAuth contains informations about authentication type

type ConnConfig

type ConnConfig struct {
	// Host: ip or domain name
	Host string
	// Port
	Port int
	// Type: docker (swarm) or k8s (kubernetes)
	Type string
	// Auth: connection authentication
	Auth ConnAuth
}

ConnConfig contains informations for connection to host

type FocusFunc

type FocusFunc func(page *console.Page)

type LayoutFunc

type LayoutFunc func(container string, page *console.Page) error

type Menu

type Menu struct {
	Name string

	//Cmd         CmdFunc
	Layout LayoutFunc
	Close  CloseFunc
	Focus  FocusFunc
}

type Module

type Module struct {
	Name        string
	Version     string
	Description string

	Client interface{}
	Layout LayoutFunc
	Menus  map[string]Menu
}

Struct for a command of a given module

type NodeClient

type NodeClient struct {
	// Config: configuration of connection
	Config ConnConfig
	// CLient: docker or kubernetes or other stuffs
	Client interface{}
}

Nodeclient use config of type ClusterConfig to connect to the server. in the cluster This struct can be used to execute a command on a container on the node

type PageClusterData

type PageClusterData struct {
	PageName string
	Configs  []ClusterConfig

	//Client              interface{}
	Module *Module

	App *console.App
}

type PageConsoleData

type PageConsoleData struct {
	PageName string

	Node *NodeClient
	App  *console.App
}