portainer

Documentation

Index

• type API
  • func (r *API) GetContainerConn(params *ContainerExecParams) ShellSession
  • func (r *API) GetExecSessionExitCode(execInstanceId string) (int, error)
• type ContainerExecParams
• type ShellSession
• type TerminalDimensions
• type TriggerResize

Types

type API

type API struct {
	ApiUrl   string
	Endpoint int
	User     string
	Password string
	Jwt      string
	ApiKey   string
}

API handles remote API calls to Portainer.

func (*API) GetContainerConn

func (r *API) GetContainerConn(params *ContainerExecParams) ShellSession

GetContainerConn finds a container to connect, executes a command in it and returns spawned websocket connection.

func (*API) GetExecSessionExitCode

func (r *API) GetExecSessionExitCode(execInstanceId string) (int, error)

GetExecSessionExitCode retrieves exec instance exit code.

type ContainerExecParams

type ContainerExecParams struct {
	ContainerName string
	Command       []string
	User          string
	WorkingDir    string
}

ContainerExecParams contains details required for connecting to a specific container.

type ShellSession

type ShellSession struct {
	InstanceId      string
	WsUrl           string
	PortainerApi    *API
	ShellConnection *websocket.Conn
}

ShellSession contains details about remote shell connected via WebSocket.

type TerminalDimensions

type TerminalDimensions struct {
	Width  int
	Height int
}

TerminalDimensions is a simple struct containing current user's terminal width and height.

type TriggerResize

type TriggerResize struct{}

TriggerResize is a simple Resize event trigger.