local

Documentation

Index

• Constants
• type App
  • func DeployedApplication(draftTomlPath, draftEnvironment string) (*App, error)
  • func (a *App) Connect(clientset kubernetes.Interface, clientConfig *restclient.Config) (*Connection, error)
  • func (a *App) NewTunnel(clientset kubernetes.Interface, config *restclient.Config) (*kube.Tunnel, string, error)
• type Connection
  • func (c *Connection) RequestLogStream(app *App, logLines int64) (io.ReadCloser, error)

Constants

const DraftLabelKey = "draft"

DraftLabelKey is the label selector key on a pod that allows

us to identify which draft app a pod is associated with

Types

type App

type App struct {
	Name      string
	Namespace string
	Container string
}

App encapsulates information about an application to connect to

Name is the name of the application
Namespace is the Kubernetes namespace it is deployed in
Container is the name the name of the application container to connect to

func DeployedApplication

func DeployedApplication(draftTomlPath, draftEnvironment string) (*App, error)

DeployedApplication returns deployment information about the deployed instance

of the source code given a path to your draft.toml file and the name of the
draft environment

func (*App) Connect

func (a *App) Connect(clientset kubernetes.Interface, clientConfig *restclient.Config) (*Connection, error)

Connect creates a local tunnel to a Kubernetes pod running the application and returns the connection information

func (*App) NewTunnel

func (a *App) NewTunnel(clientset kubernetes.Interface, config *restclient.Config) (*kube.Tunnel, string, error)

NewTunnel creates and returns a tunnel to a Kubernetes pod running the application

type Connection

type Connection struct {
	Tunnel    *kube.Tunnel
	PodName   string
	Clientset kubernetes.Interface
}

Connection encapsulated information to connect to am application

func (*Connection) RequestLogStream

func (c *Connection) RequestLogStream(app *App, logLines int64) (io.ReadCloser, error)

RequestLogStream returns a stream of the application pod's logs