box

package
v1.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 18, 2021 License: Apache-2.0 Imports: 13 Imported by: 24

Documentation

Overview

Package box implements the definitions of a box configuration file and tools to access it. This is used to configure the suite of tools that outreach provides, aka "startup in a box"

Index

Constants

This section is empty.

Variables

View Source 
var (
	// BoxConfigPath is the $HOME/<BoxConfigPath> location of the box config storage
	BoxConfigPath = ".outreach/.config/box"
	// BoxConfigFile is the name of the box config storage file
	BoxConfigFile = "box.yaml"
)

Functions

func ApplyEnvOverrides 

func ApplyEnvOverrides(s *Config)

ApplyEnvOverrides overrides a box configuration based on env vars. This should really only be used for things that need to be overridden on runtime, e.g. CI

func InitializeBox 

func InitializeBox(ctx context.Context, defaults []string) error

InitializeBox prompts the user for a box config location, downloads it and then saves it to disk. In general EnsureBox should be used over this function.

func SaveBox 

func SaveBox(_ context.Context, s *Storage) error

SaveBox takes a Storage wrapped box configuration, serializes it and then saves it to the well-known config path on disk.

Types

type Config 

type Config struct {
	// Org is the Github org for this box, e.g. getoutreach
	Org string `yaml:"org"`

	// DeveloperEnvironmentConfig is the configuration for the developer environment for this box
	DeveloperEnvironmentConfig *DeveloperEnvironmentConfig `yaml:"devenv"`
}

Config is the basis of a box configuration

func DownloadBox 

func DownloadBox(ctx context.Context, gitRepo string) (*Config, error)

DownloadBox downloads and parses a box config from a given repository URL.

func EnsureBox 

func EnsureBox(ctx context.Context, defaults []string, log logrus.FieldLogger) (*Config, error)

EnsureBox loads a box if it already exists, or prompts the user for the box if not found. If it exists, remote is querired periodically for a new version

func LoadBox 

func LoadBox() (*Config, error)

LoadBox loads the default box or returns an error

func NewConfig 

func NewConfig() *Config

NewConfig makes a full initialized Config

type DeveloperEnvironmentConfig 

type DeveloperEnvironmentConfig struct {
	// SnapshotConfig is the snapshot configuration for the devenv
	SnapshotConfig *SnapshotConfig `yaml:"snapshots"`

	// VaultConfig denotes how to talk to Vault
	VaultConfig *VaultConfig `yaml:"vault"`

	// ImagePullSecret is a path to credentials used to pull images with
	// currently the only supported value is a vault key path with
	// VaultEnabled being true
	ImagePullSecret string `yaml:"imagePullSecret"`

	// ImageRegistry is the registry to use for detecting your apps
	// e.g. gcr.io/outreach-docker
	ImageRegistry string `yaml:"imageRegistry"`

	// RuntimeConfig stores configuration specific to different devenv
	// runtimes.
	RuntimeConfig *DeveloperEnvironmentRuntimeConfig `yaml:"runtimeConfig"`
}

type DeveloperEnvironmentRuntimeConfig added in v1.15.0 

type DeveloperEnvironmentRuntimeConfig struct {
	// EnabledRuntimes dictates which runtimes are enabled, generally defaults to all.
	EnabledRuntimes []string `yaml:"enabledRuntimes"`

	// Loft is configuration for the loft runtime in the devenv
	Loft *LoftRuntimeConfig `yaml:"loft"`
}

DeveloperEnvironmentRuntimeConfig stores configuration specific to different runtimes.

type LoftRuntimeConfig added in v1.15.0 

type LoftRuntimeConfig struct {
	// URL is the URL of a loft instance.
	URL string `yaml:"URL"`
}

LoftRuntimeConfig is configuration for loft runtimes

type SnapshotConfig 

type SnapshotConfig struct {
	// Endpoint is the S3 compatible endpoint to fetch a snapshot from
	Endpoint string `yaml:"endpoint"`

	// Region is the region to use for this bucket
	Region string `yaml:"region"`

	// Bucket is the bucket that the snapshots are in
	Bucket string `yaml:"bucket"`

	// DefaultName is the default name (snapshot) to use, e.g. flagship
	DefaultName string `yaml:"defaultName"`

	// ReadAWSRole is the role to use, if set, for saml2aws for RO access
	ReadAWSRole string `yaml:"readAWSRole"`

	// WriteAWSRole is the role to use, if set, for saml2aws for RW access
	WriteAWSRole string `yaml:"writeAWSRole"`
}

SnapshotConfig stores configuration for generated and accessing snapshots

type SnapshotGenerateConfig 

type SnapshotGenerateConfig struct {
	// Targets are all of the snapshots that can be generated. The key equates
	// the name of the generated snapshot
	Targets map[string]*SnapshotTarget `yaml:"targets"`
}

SnapshotGenerateConfig stores configuration for snapshots that should be generated

type SnapshotLock 

type SnapshotLock struct {
	// Version is the version of this configuration, used for breaking changes
	Version int `yaml:"version"`
	// GeneratedAt is when this lock was generated
	GeneratedAt time.Time `yaml:"generatedAt"`

	// Deprecated: Use TargetsV2 instead
	// Targets is a single snapshot for each target
	Targets map[string]*SnapshotLockTarget `yaml:"targets"`

	// TargetsV2 is a target -> lock list for snapshots
	TargetsV2 map[string]*SnapshotLockList `yaml:"targets_v2"`
}

SnapshotLock is an manifest of all the available snapshots

type SnapshotLockChannel 

type SnapshotLockChannel string

SnapshotLockChannel is used to determine the quality of a given snapshot 

const (
	// SnapshotLockChannelStable is a stable channel
	SnapshotLockChannelStable SnapshotLockChannel = "stable"

	// SnapshotLockChannelRC is a release candidate (less stable) channel
	SnapshotLockChannelRC SnapshotLockChannel = "rc"
)

type SnapshotLockList 

type SnapshotLockList struct {
	// Snapshots is a channel separated list of snapshots for a given target
	Snapshots map[SnapshotLockChannel][]*SnapshotLockListItem `yaml:"snapshots"`
}

SnapshotLockList contains a channel (different releases of snapshots) separated list of snapshots

type SnapshotLockListItem 

type SnapshotLockListItem struct {
	// Digest is a MD5 base64 encoded digest of the archive
	Digest string `yaml:"digest"`

	// Key is the key that this snapshot is stored at, note that the bucket is
	// not set or determined here and instead come from the snapshotconfig
	URI string `yaml:"key"`

	// Config is the config used to generate this snapshot
	Config *SnapshotTarget

	// VeleroBackupName is the name of this snapshot. This is used to invoke velero
	// commands. It should not be used for uniqueness constraints.
	VeleroBackupName string `yaml:"veleroBackupName"`
}

SnapshotLockListItem is a replacement for SnapshotLockTarget which is used by SnapshotLockList to provide details about a snapshot

type SnapshotLockTarget 

type SnapshotLockTarget struct {
	// Digest is a MD5 base64 encoded digest of the archive
	Digest string `yaml:"digest"`

	// Key is the key that this snapshot is stored at, note that the bucket is
	// not set or determined here and instead come from the snapshotconfig
	URI string `yaml:"key"`

	// Config is the config used to generate this snapshot
	Config *SnapshotTarget

	// VeleroBackupName is the name of this snapshot. This is used to invoke velero
	// commands. It should not be used for uniqueness constraints.
	VeleroBackupName string `yaml:"veleroBackupName"`
}

SnapshotLockTarget is a generated snapshot and metadata on it. In general SnapshotLockListItem should be used instead.

type SnapshotTarget 

type SnapshotTarget struct {
	// Command is the command to be run to generate this snapshot,
	// note that a devenv is already provisioned and accessible at this
	// stage of the generation process
	Command string `yaml:"command"`

	// PostRestore is a path to a yaml file that contains pre-rendered manifests
	// These manifests will be ran through a special go-template that allows
	// injecting information like the current user / git email.
	PostRestore string `yaml:"post_restore"`

	// DeployApps is an array of applications to deploy via deploy-app
	// before running the Command specified.
	DeployApps []string `yaml:"deploy_apps"`

	// PostDeployApps is an array of applications to deploy via deploy-app
	// after running the Command specified.
	PostDeployApps []string `yaml:"post_deploy_apps"`

	// ReadyAddress is a URL to ping before marking the devenv as ready
	ReadyAddress string `yaml:"readyAddress"`
}

SnapshotTarget is the defn for a generated snapshot

type Storage 

type Storage struct {
	// Config is the box configuration, see Config
	Config *Config `yaml:"config"`

	// LastUpdated is the last time this file was checked for updates
	LastUpdated time.Time `yaml:"lastUpdated"`

	// StorageURL is the location that this came from
	StorageURL string `yaml:"storageURL"`
}

Storage is a wrapper type used for storing the box configuration

func LoadBoxStorage 

func LoadBoxStorage() (*Storage, error)

LoadBoxStorage reads a serialized, storage wrapped box config from disk and returns it. In general LoadBox should be used over this function.

type VaultConfig 

type VaultConfig struct {
	// Enabled determines if we should setup vault or not
	Enabled bool `yaml:"enabled"`

	// AuthMethod is the method to talk to vault, e.g. oidc
	AuthMethod string `yaml:"authMethod"`

	// Address is the URL to talk to Vault
	Address string `yaml:"address"`
}

VaultConfig is the configuration for accessing Vault

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.