bee

Documentation

Index

• type Bee
• type Bees
  • func NewBees(argocd argocd.ArgoCD, stateLoader terra.StateLoader, seeder seed.Seeder, ...) (Bees, error)
• type CreateOptions
• type DeleteOptions
• type PinOptions
• type ProvisionOptions

Types

type Bee

type Bee struct {
	Environment      terra.Environment
	Status           map[terra.Release]status.Status
	ContainerLogsURL string
}

Bee encapsulates operational information about a BEE

type Bees

type Bees interface {
	DeleteWith(name string, options DeleteOptions) (*Bee, error)
	CreateWith(options CreateOptions) (*Bee, error)
	ProvisionWith(name string, options ProvisionOptions) (*Bee, error)
	GetBee(name string) (terra.Environment, error)
	GetTemplate(templateName string) (terra.Environment, error)
	Seeder() seed.Seeder
	FilterBees(filter terra.EnvironmentFilter) ([]terra.Environment, error)
	PinVersions(bee terra.Environment, overrides PinOptions) error
	UnpinVersions(bee terra.Environment) error
	SyncEnvironmentGenerator(env terra.Environment) error
	SyncArgoAppsIn(env terra.Environment, options ...argocd.SyncOption) (map[terra.Release]status.Status, error)
	ResetStatefulSets(env terra.Environment) (map[terra.Release]status.Status, error)
	RefreshBeeGenerator() error
}

func NewBees

func NewBees(argocd argocd.ArgoCD, stateLoader terra.StateLoader, seeder seed.Seeder, cleanup cleanup.Cleanup, kubectl kubectl.Kubectl, ops ops.Ops) (Bees, error)

type CreateOptions

type CreateOptions struct {
	NamePrefix   string
	Owner        string
	GenerateName bool
	Template     string
	ProvisionOptions
}

type DeleteOptions

type DeleteOptions struct {
	Unseed     bool
	ExportLogs bool
}

type PinOptions

type PinOptions struct {
	// Flags holds global-to-the-environment overrides like --terra-helmfile-ref, firecloud-develop-ref, --build-number
	Flags struct {
		// TerraHelmfileRef the ref the environments Argo app generator should use
		TerraHelmfileRef string
		// FirecloudDevelopRef the ref the environments Argo app generator should use
		FirecloudDevelopRef string
	}
	// FileOverrides holds overrides for individual releases, loaded from a YAML or JSON file
	FileOverrides map[string]terra.VersionOverride
}

type ProvisionOptions

type ProvisionOptions struct {
	// Name within the context of ProvisionOptions is just the name of the environment.
	// In the context of CreateOptions, it means the name of the environment *to create*.
	Name                     string
	SyncGeneratorOnly        bool
	WaitHealthy              bool
	WaitHealthTimeoutSeconds int
	PinOptions               PinOptions
	Seed                     bool
	SeedOptions              seed.SeedOptions
	ExportLogsOnFailure      bool
}