box

type AWSConfig struct {
	// DefaultAccountID is the default Account ID to use when communicating
	// with AWS.
	DefaultAccountID string `yaml:"defaultAccountID"`

	// DefaultIAMIdPARN is the default IAM IdP ARN to use when communicating
	// with AWS.
	DefaultIAMIdPARN string `yaml:"defaultIAMIdPARN"`

	// DefaultProfile is the default profile to use when communicating
	// with AWS.
	DefaultProfile string `yaml:"defaultProfile"`

	// DefaultRole is the default role to assume when communicating
	// with AWS.
	DefaultRole string `yaml:"defaultRole"`

	// Okta contains configuration for using Okta authentication
	// with AWS.
	Okta OktaConfig `yaml:"okta"`

	// RefreshMethod is the CLI used to refresh AWS credentials.
	// Known values:
	// * okta-aws-cli (default)
	RefreshMethod string `yaml:"refreshMethod"`
}

type CD struct {
	// Concourse contains the concourse configuration settings
	Concourse struct {
		// Address is the concourse host url
		Address string `yaml:"address"`
	} `yaml:"concourse"`
	// Maestro contains the maestro configuration settings
	Maestro struct {
		// Address is the maestro host url
		Address string `yaml:"address"`
	} `yaml:"maestro"`
}

type CI struct {
	// CircleCI contains the CircleCI configuration settings
	CircleCI struct {
		// Contexts are authentication contexts that can be used
		// to authenticate with CircleCI.
		Contexts struct {
			// AWS is the AWS authentication context
			// The context should contain the following values:
			// AWS_ACCESS_KEY_ID: <access key id>
			// AWS_SECRET_ACCESS_KEY: <secret access key>
			AWS string `yaml:"aws"`

			// Github is the Github authentication context
			// The context should contain the following values:
			// GHACCESSTOKEN_GHAPP_1: <github app>
			// GHACCESSTOKEN_PAT_1: <github personal access token>
			//
			// For more information on this, see:
			// https://github.com/getoutreach/ci/blob/main/cmd/ghaccesstoken/token.go
			Github string `yaml:"github"`

			// Docker is the docker authentication context
			// Currently all that is supported is gcp.
			// The context should contain the following values:
			// GCLOUD_SERVICE_ACCOUNT: <gcp service account json>
			Docker string `yaml:"docker"`

			// NPM is the npm authentication context
			// The context should contain the following values:
			// NPM_TOKEN: <npm token>
			NPM string `yaml:"npm"`

			// ExtraContexts is a list of extra contexts to include
			// for every job
			ExtraContexts []string `yaml:"extraContexts"`
		} `yaml:"contexts"`
	} `yaml:"circleci"`
}

type Config struct {
	// RefreshInterval is the interval to use when refreshing a box configuration
	RefreshInterval time.Duration `yaml:"refreshInterval"`

	// 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"`

	// AWS is the configuration for communicating with AWS.
	AWS AWSConfig `yaml:"aws"`

	// CI is the configuration for the CI environment
	CI CI `yaml:"ci"`

	// CD is the configuration
	CD CD `yaml:"cd"`
}

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"`

	// VersionResolvers stores the configuration for version resolvers
	VersionResolvers DevenvVersionResolvers `yaml:"versionResolvers"`
}

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

	// DevelopmentRegistries are image registries that should be used for
	// development docker images. These are only ever used for remote devenvs.
	DevelopmentRegistries DevelopmentRegistries `yaml:"developmentRegistries"`

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

type DevelopmentRegistries struct {
	// Path is a go-template string of the path to append to the end of the endpoint
	// for the docker image registry to use. This is useful for namespacing images.
	Path string `yaml:"path"`

	// Clouds is a CloudName -> DevelopmentRegistriesSlice
	Clouds map[region.CloudName]DevelopmentRegistriesSlice
}

type DevelopmentRegistriesSlice []DevelopmentRegistry

type DevelopmentRegistry struct {
	// Endpoint is the endpoint of this registry, e.g.
	// gcr.io/outreach-docker or docker.io/getoutreach
	Endpoint string `yaml:"endpoint"`

	// Region that this registry should be used in. If not set will be randomly selected.
	Region region.Name `yaml:"region"`
}

type DevenvVersionResolvers struct {
	// Enabled is a list of image resolvers to use. If none are specified Maestro will be used
	// ordered based on priority. External customers should default to git
	Enabled []string `yaml:"enabled"`

	// Config is the configuration information for all version resolvers
	Config VersionResolverConfig `yaml:"config"`
}

type LoadBoxOption func(*LoadBoxOptions)

type LoadBoxOptions struct {
	// MinVersion of a box configuration that is required for this
	// LoadBox call.
	MinVersion *float32

	// DefaultBoxSources is a list of URLs to present to the user
	// as being the default locations of box configuration.
	// Deprecated: Configure before running an application instead.
	DefaultBoxSources []string

	// Agent is the SSH agent used when fetching the box git repository.
	Agent agent.Agent
	// contains filtered or unexported fields
}

type LoftCluster struct {
	// Name is the name of the cluster in loft
	Name string `yaml:"name"`

	// Region is the region that this cluster is in
	Region region.Name `yaml:"region"`

	// Cloud is the cloud that this loft cluster is in. Not currently used anywhere.
	Cloud region.CloudName `yaml:"cloud"`
}

type LoftClusters []LoftCluster

type LoftRuntimeConfig struct {
	// Clusters is a list of clusters provided by this loft instance
	Clusters LoftClusters `yaml:"clusters"`

	// DefaultCloud is the default cloud to use. Currently the only way to specify
	// which cloud.
	DefaultCloud region.CloudName `yaml:"defaultCloud"`

	// DefaultRegion is the default region to use when a nearest one couldn't
	// be calculated
	DefaultRegion region.Name `yaml:"regionName"`

	// URL is the URL of a loft instance.
	URL string `yaml:"URL"`
}

type MaestroConfig struct {
	// VaultSecretPath vault path that contains the auth secret to access maestro API
	VaultSecretPath string `yaml:"vaultSecretPath"`

	// VaultSecretKey the key within the VaultSecretPath that contains the API token
	VaultSecretKey string `yaml:"vaultSecretKey"`

	// Channels list of channels that maestro should retrieve version from
	Channels []string `yaml:"channels"`
}

type OktaConfig struct {
	// FederationAppID is the Okta app ID for the AWS federation app.
	FederationAppID string `yaml:"federationAppID"`
	// OIDCClientID is the Okta app ID for the AWS OIDC app (not the
	// federation one).
	OIDCClientID string `yaml:"oidcClientID"`
	// OrgDomain is the hostname of the Okta instance.
	OrgDomain string `yaml:"orgDomain"`
	// SessionDuration is the TTL for the session in seconds.
	SessionDuration uint `yaml:"sessionDuration"`
}

type RestoreStep struct {
	// Description describes what resources are restored in this step
	Description string

	// IncludedNamespaces defines what namespaces are restored in this step. It maps to Velero IncludedNamespaces restore parameter
	IncludedNamespaces []string `yaml:"included_namespaces"`

	// ExcludedNamespaces defines what namespaces are not restored in this step. It maps to Velero ExcludedNamespaces restore parameter
	ExcludedNamespaces []string `yaml:"excluded_namespaces"`
}

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 RO access to AWS
	ReadAWSRole string `yaml:"readAWSRole"`

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

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"`
}

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"`
}

type SnapshotLockChannel string

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

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"`
}

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"`
}

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"`

	// RestoreSteps defines the startup order of the resources within this snapshot.
	// If not specified, all snapshot resources are started at the same time
	RestoreSteps []RestoreStep `yaml:"restore_steps"`
}

type Storage struct {
	// Config is the box configuration, see Config.
	// This is an yaml.Node because we can't guarantee that the
	// underlying type is a Config as we expect it to be.
	Config yaml.Node `yaml:"config"`

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

	// Version is the version of this box spec.
	Version float32 `yaml:"version"`

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

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"`

	// AddressCI is the URL to use to talk to Vault in CI
	// Defaults to Address
	AddressCI string `yaml:"addressCI"`
}

type VersionResolverConfig struct {
	// Maestro configuration used by maestro image resolver
	Maestro MaestroConfig `yaml:"maestro"`
}