Documentation
¶
Index ¶
- type Artifacts
- type Config
- type ConnectedChart
- type Environment
- func (m *Environment) AddChart(f func(root cdk8s.Chart) ConnectedChart) *Environment
- func (m *Environment) AddHelm(chart ConnectedChart) *Environment
- func (m *Environment) Clear()
- func (m *Environment) Deploy(manifest string) error
- func (m *Environment) PrintURLs() error
- func (m *Environment) Run() error
- func (m *Environment) Shutdown() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Artifacts ¶
type Artifacts struct {
Namespace string
DBName string
Client *client.K8sClient
// contains filtered or unexported fields
}
Artifacts is an artifacts dumping structure that copies logs and database dumps for all deployed pods
func NewArtifacts ¶
NewArtifacts create new artifacts instance for provided environment
type Config ¶
type Config struct {
TTL time.Duration
NamespacePrefix string
Namespace string
Labels []string
NSLabels *map[string]*string
ReadyCheckData *client.ReadyCheckData
DryRun bool
InsideK8s bool
KeepConnection bool
RemoveOnInterrupt bool
}
Config environment configuration
type ConnectedChart ¶ added in v0.2.3
type ConnectedChart interface {
GetName() string
GetPath() string
GetValues() *map[string]interface{}
ExportData(e *Environment) error
}
ConnectedChart interface to interact both with cdk8s apps and helm charts
type Environment ¶
type Environment struct {
App cdk8s.App
Charts []ConnectedChart
Cfg *Config
Client *client.K8sClient
Fwd *client.Forwarder
Artifacts *Artifacts
URLs map[string][]string
// contains filtered or unexported fields
}
func (*Environment) AddChart ¶ added in v0.2.3
func (m *Environment) AddChart(f func(root cdk8s.Chart) ConnectedChart) *Environment
func (*Environment) AddHelm ¶ added in v0.2.3
func (m *Environment) AddHelm(chart ConnectedChart) *Environment
func (*Environment) Clear ¶ added in v0.2.3
func (m *Environment) Clear()
func (*Environment) Deploy ¶
func (m *Environment) Deploy(manifest string) error
Deploy deploy synthesized manifest and check logs for readiness
func (*Environment) PrintURLs ¶ added in v0.2.3
func (m *Environment) PrintURLs() error
func (*Environment) Run ¶ added in v0.2.3
func (m *Environment) Run() error
Run deploys or connects to already created environment
func (*Environment) Shutdown ¶
func (m *Environment) Shutdown() error
Shutdown environment, remove namespace
Click to show internal directories.
Click to hide internal directories.