plan

Documentation

Index

• func Print(p *Plan) error
• type AWSProvider
• type AWSRole
• type Account
• type Backend
• type BackendKind
• type BlessProvider
• type CIComponent
• type CIConfig
• type CIProject
• type CircleCIComponent
• type CircleCIConfig
• type Common
• type Component
• type ComponentCommon
• type DatadogProvider
• type Env
• type GitHubActionsCIConfig
• type GitHubActionsComponent
• type GithubProvider
• type HerokuProvider
• type KubernetesProvider
• type Module
• type OktaProvider
• type Plan
  • func Eval(c *v2.Config) (*Plan, error)
• type ProviderConfiguration
• type ProviderVersion
• type RemoteBackend
• type S3Backend
• type SentryProvider
• type SnowflakeProvider
• type TfLint
• type TfeProvider
• type TravisCIComponent
• type TravisCIConfig

Functions

func Print

func Print(p *Plan) error

Print prints a plan

Types

type AWSProvider

type AWSProvider struct {
	AccountID json.Number `yaml:"account_id"`
	Alias     *string     `yaml:"alias"`
	Profile   *string     `yaml:"profile"`
	Region    string      `yaml:"region"`
	RoleArn   *string     `yaml:"role_arn"`
}

AWSProvider represents AWS provider configuration

type AWSRole

type AWSRole struct {
	AccountID string `yaml:"account_id"`
	RolePath  string `yaml:"role_path"`
	RoleName  string `yaml:"role_name"`
}

type Account

type Account struct {
	ComponentCommon `yaml:",inline"`

	Account string     `yaml:"account"`
	Global  *Component `yaml:"global"`
}

Account is an account

type Backend

type Backend struct {
	Kind   BackendKind    `yaml:"kind"`
	S3     *S3Backend     `yaml:"s3,omitempty"`
	Remote *RemoteBackend `yaml:"remote,omitempty"`
}

Backend represents a plan for configuring the terraform backend. Only one struct member can be non-nil at a time

type BackendKind

type BackendKind string

BackendKind is a enum of backends we support

const (
	// BackendKindS3 is https://www.terraform.io/docs/backends/types/s3.html
	BackendKindS3     BackendKind = "s3"
	BackendKindRemote BackendKind = "remote"
)

type BlessProvider

type BlessProvider struct {
	AdditionalRegions []string `yaml:"additional_regions,omitempty"`
	AWSProfile        *string  `yaml:"aws_profile,omitempty"`
	AWSRegion         string   `yaml:"aws_region,omitempty"`
	RoleArn           *string  `yaml:"role_arn,omitempty"`
}

BlessProvider represents Bless ssh provider configuration

type CIComponent

type CIComponent struct {
	Enabled     bool
	Buildevents bool

	AWSProfileName string
	AWSRoleName    string
	AWSAccountID   string
	Command        string
}

type CIConfig

type CIConfig struct {
	Enabled     bool
	FoggVersion string
	Env         map[string]string

	TestBuckets [][]CIProject
	AWSProfiles ciAwsProfiles
	Buildevents bool
	// contains filtered or unexported fields
}

type CIProject

type CIProject struct {
	Name    string
	Dir     string
	Command string
}

type CircleCIComponent

type CircleCIComponent struct {
	CIComponent

	SSHFingerprints []string
}

type CircleCIConfig

type CircleCIConfig struct {
	CIConfig
	SSHFingerprints []string
}

type Common

type Common struct {
	PathToRepoRoot   string `yaml:"path_to_repo_root"`
	TerraformVersion string `yaml:"terraform_version"`
}

Common represents common fields

type Component

type Component struct {
	ComponentCommon `yaml:",inline"`

	EKS          *v2.EKSConfig     `yaml:"eks,omitempty"`
	Kind         *v2.ComponentKind `yaml:"kind,omitempty"`
	ModuleSource *string           `yaml:"module_source"`
	ModuleName   *string           `yaml:"module_name"`
	Global       *Component        `yaml:"global"`
}

Component is a component

type ComponentCommon

type ComponentCommon struct {
	Common `yaml:",inline"`

	AccountBackends       map[string]Backend         `yaml:"account_backends"`
	Accounts              map[string]*json.Number    `yaml:"all_accounts"`
	Backend               Backend                    `yaml:"backend"`
	ComponentBackends     map[string]Backend         `yaml:"comonent_backends"`
	Env                   string                     ` yaml:"env"`
	ExtraVars             map[string]string          `yaml:"extra_vars"`
	Name                  string                     `yaml:"name"`
	Owner                 string                     `yaml:"owner"`
	Project               string                     `yaml:"project"`
	ProviderConfiguration ProviderConfiguration      `yaml:"providers_configuration"`
	ProviderVersions      map[string]ProviderVersion `yaml:"provider_versions"`

	TfLint TfLint `yaml:"tf_lint"`

	TravisCI        TravisCIComponent
	CircleCI        CircleCIComponent
	GitHubActionsCI GitHubActionsComponent
}

ComponentCommon represents common fields for components

type DatadogProvider

type DatadogProvider struct {
}

type Env

type Env struct {
	Components map[string]Component `yaml:"components"`
	Env        string               `yaml:"env"`
	EKS        *v2.EKSConfig        `yaml:"eks"`
}

Env is an env

type GitHubActionsCIConfig

type GitHubActionsCIConfig struct {
	CIConfig
	SSHKeySecrets []string
}

type GitHubActionsComponent

type GitHubActionsComponent struct {
	CIComponent
}

type GithubProvider

type GithubProvider struct {
	Organization string  `yaml:"organization"`
	BaseURL      *string `yaml:"base_url"`
}

GithubProvider represents a configuration of a github provider

type HerokuProvider

type HerokuProvider struct {
}

type KubernetesProvider

type KubernetesProvider struct {
}

type Module

type Module struct {
	Common `yaml:",inline"`
}

Module is a module

type OktaProvider

type OktaProvider struct {
	OrgName string  `yaml:"org_name,omitempty"`
	BaseURL *string `yaml:"base_url,omitempty"`
}

OktaProvider represents Okta configuration

type Plan

type Plan struct {
	Accounts        map[string]Account    `yaml:"account"`
	Envs            map[string]Env        `yaml:"envs"`
	Global          Component             `yaml:"global"`
	Modules         map[string]Module     `yaml:"modules"`
	TravisCI        TravisCIConfig        `yaml:"travis_ci"`
	CircleCI        CircleCIConfig        `yaml:"circleci_ci"`
	GitHubActionsCI GitHubActionsCIConfig `yaml:"github_actions_ci"`
	Version         string                `yaml:"version"`
}

Plan represents a set of actions to take

func Eval

func Eval(c *v2.Config) (*Plan, error)

Eval evaluates a config

type ProviderConfiguration

type ProviderConfiguration struct {
	AWS                    *AWSProvider        `yaml:"aws"`
	AWSAdditionalProviders []AWSProvider       `yaml:"aws_regional_providers"`
	Bless                  *BlessProvider      `yaml:"bless"`
	Datadog                *DatadogProvider    `yaml:"datadog"`
	Github                 *GithubProvider     `yaml:"github"`
	Heroku                 *HerokuProvider     `yaml:"heroku"`
	Kubernetes             *KubernetesProvider `yaml:"kubernetes"`
	Okta                   *OktaProvider       `yaml:"okta"`
	Sentry                 *SentryProvider     `yaml:"sentry"`
	Snowflake              *SnowflakeProvider  `yaml:"snowflake"`
	Tfe                    *TfeProvider        `yaml:"tfe"`
}

type ProviderVersion

type ProviderVersion struct {
	Source  string  `yaml:"source"`
	Version *string `yaml:"version"`
}

type RemoteBackend

type RemoteBackend struct {
	HostName     string `yaml:"host_name"`
	Organization string `yaml:"organization"`
	Workspace    string `yaml:"workspace"`
}

RemoteBackend represents a plan to configure a terraform remote backend

type S3Backend

type S3Backend struct {
	AccountID   *string `yaml:"account_id,omitempty"`
	AccountName string  `yaml:"account_name"`
	Bucket      string  `yaml:"bucket"`
	DynamoTable *string `yaml:"dynamo_table"`
	KeyPath     string  `yaml:"key_path"`
	Profile     *string `yaml:"profile"`
	Region      string  `yaml:"region"`
	RoleArn     *string `yaml:"role_arn"`
}

S3Backend represents aws backend configuration

type SentryProvider

type SentryProvider struct {
	Enabled bool
	BaseURL *string `yaml:"base_url,omitempty"`
}

type SnowflakeProvider

type SnowflakeProvider struct {
	Account string `yaml:"account,omitempty"`
	Role    string `yaml:"role,omitempty"`
	Region  string `yaml:"region,omitempty"`
}

SnowflakeProvider represents Snowflake DB provider configuration

type TfLint

type TfLint struct {
	Enabled bool `yaml:"enabled"`
}

TfLint contains a plan for running tflint

type TfeProvider

type TfeProvider struct {
	Enabled  bool    `yaml:"enabled,omitempty"`
	Hostname *string `yaml:"hostname,omitempty"`
}

type TravisCIComponent

type TravisCIComponent struct {
	CIComponent
}

type TravisCIConfig

type TravisCIConfig struct {
	CIConfig
}