env

Documentation

Index

• Constants
• Variables
• func Connect(opts EnvConnectOpts) error
• func ExistingPidForConnection(name string) int
• func GenerateConnectPort(name string) int
• func GetProxyPIDs(availableEnvironments []environment.Environment) (map[string]ProcessDetails, error)
• func IsConnectChild(opts EnvConnectOpts) bool
• func IsConnectParent(opts EnvConnectOpts) bool
• func IsConnectStartup(opts EnvConnectOpts) bool
• func KillProcess(name string, pid int32, force bool) error
• func Listen(streams userio.IOStreams, opts EnvConnectOpts, ctx context.Context, ...)
• func OpenResource(resourceType ResourceType, env *environment.Environment) (string, error)
• func ResourceStringList() []string
• func SetBackgroundEnv() string
• func Validate(ctx context.Context, env *environment.Environment, cmd command.Commander, ...) error
• func WritePidFile(name string, pid int)
• type EnvConnectOpts
• type ProcessDetails
• type ResourceType
• type TableEnv
  • func NewTable(streams userio.IOStreams, showProxy bool) TableEnv
  • func (t TableEnv) AppendEnv(env environment.Environment, proxy string, pid string)
  • func (t TableEnv) AppendRow(name, id, platform, proxy, pid string)
  • func (t TableEnv) Render() string

Constants

const (
	GrafanaResourceType               = "grafana"
	GrafanaContinuousLoadResourceType = "grafana/continuous-load"
)

const BastionSquidProxyPort = 3128

const DefaultInterfaceName = "nic0"

const DefaultZone = "europe-west2-a"

const KubeNamespace = "default"

const NoBackgroundEnvVar = "NO_BACKGROUND"

const PidFileDir = "/tmp/corectl"

const PortConnectMax = 40000

const PortConnectMin = 30000

Variables

var (
	ErrCloudPlatformNotSupported = errors.New("cloud platform is not supported")
	ErrInvalidEnvironment        = errors.New("environment is not valid")
)

var (
	ErrorUnknownResourceType = errors.New("unknown resource type")
)

Functions

func Connect

func Connect(opts EnvConnectOpts) error

Connect establishes a connection with a gke cluster via a bastion host

func ExistingPidForConnection

func ExistingPidForConnection(name string) int

func GenerateConnectPort

func GenerateConnectPort(name string) int

func GetProxyPIDs

func GetProxyPIDs(availableEnvironments []environment.Environment) (map[string]ProcessDetails, error)

func IsConnectChild

func IsConnectChild(opts EnvConnectOpts) bool

func IsConnectParent

func IsConnectParent(opts EnvConnectOpts) bool

func IsConnectStartup

func IsConnectStartup(opts EnvConnectOpts) bool

func KillProcess

func KillProcess(name string, pid int32, force bool) error

func Listen

func Listen(streams userio.IOStreams, opts EnvConnectOpts, ctx context.Context, listen string, dialOpts []iap.DialOption, execute func() error)

Listen starts a proxy server that listens on the given address and port.

func OpenResource

func OpenResource(resourceType ResourceType, env *environment.Environment) (string, error)

func ResourceStringList

func ResourceStringList() []string

func SetBackgroundEnv

func SetBackgroundEnv() string

func Validate

func Validate(ctx context.Context, env *environment.Environment, cmd command.Commander, client *gcp.Client) error

Validate checks if the required tools and configurations for the environment are installed and set up correctly.

func WritePidFile

func WritePidFile(name string, pid int)

Types

type EnvConnectOpts

type EnvConnectOpts struct {
	Port               int
	Environment        *environment.Environment
	RepositoryLocation string
	ProjectID          string
	Region             string
	Streams            userio.IOStreams
	SilentExec         Commander
	Exec               Commander
	GcpClient          *gcp.Client
	Command            []string
	SkipTunnel         bool
	Background         bool
	Force              bool
}

type ProcessDetails

type ProcessDetails struct {
	Pid  int32
	Port int32
}

type ResourceType

type ResourceType string

type TableEnv

type TableEnv struct {
	// contains filtered or unexported fields
}

func NewTable

func NewTable(streams userio.IOStreams, showProxy bool) TableEnv

func (TableEnv) AppendEnv

func (t TableEnv) AppendEnv(env environment.Environment, proxy string, pid string)

func (TableEnv) AppendRow

func (t TableEnv) AppendRow(name, id, platform, proxy, pid string)

func (TableEnv) Render

func (t TableEnv) Render() string