terminal

Documentation

Index

• type KeyCode
• type KubeTerminal
  • func NewKubeTerminal(p jetstream_api.PortalProxy) *KubeTerminal
  • func (k *KubeTerminal) Start(c echo.Context) error
  • func (k *KubeTerminal) StartCleanup()
• type PodCreationData

Types

type KeyCode

type KeyCode struct {
	Key  string `json:"key"`
	Cols int    `json:"cols"`
	Rows int    `json:"rows"`
}

KeyCode - JSON object that is passed from the front-end to notify of a key press or a term resize

type KubeTerminal

type KubeTerminal struct {
	PortalProxy jetstream_api.PortalProxy
	Namespace   string `configName:"STRATOS_KUBERNETES_NAMESPACE"`
	Image       string `configName:"STRATOS_KUBERNETES_TERMINAL_IMAGE"`
	Token       []byte
	APIServer   string
	Kube        api.Kubernetes
}

KubeTerminal supports spawning pods to provide a CLI environment to the user

func NewKubeTerminal

func NewKubeTerminal(p jetstream_api.PortalProxy) *KubeTerminal

NewKubeTerminal checks that the environment is set up to support the Kube Terminal

func (*KubeTerminal) Start

func (k *KubeTerminal) Start(c echo.Context) error

Start handles web-socket request to launch a Kubernetes Terminal

func (*KubeTerminal) StartCleanup

func (k *KubeTerminal) StartCleanup()

StartCleanup starts a background routine to cleanup orphaned pods

type PodCreationData

type PodCreationData struct {
	Namespace    string
	PodClient    corev1.PodInterface
	SecretClient corev1.SecretInterface
	PodName      string
	SecretName   string
}

PodCreationData stores the clients and names used to create pod and secret