plan

Documentation

Index

• func Print(p *Plan) error
• type AWSBackend
• type AWSProfile
• type AWSProvider
• type AWSRole
• type Account
• type Atlantis
• type AtlantisComponent
• type AtlantisProject
• type BlessProvider
• type Common
• type Component
• type ComponentCommon
• type Env
• type Module
• type OktaProvider
• type Plan
  • func Eval(c *v2.Config) (*Plan, error)
• type Providers
• type SnowflakeProvider
• type TfLint
• type TravisCI

Functions

func Print

func Print(p *Plan) error

Print prints a plan

Types

type AWSBackend

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

AWSBackend represents aws backend configuration

type AWSProfile

type AWSProfile struct {
	Name string
	ID   json.Number
	Role string
}

type AWSProvider

type AWSProvider struct {
	AccountID         json.Number `yaml:"account_id"`
	Profile           string      `yaml:"profile"`
	Version           string      `yaml:"version"`
	Region            string      `yaml:"region"`
	AdditionalRegions []string    `yaml:"additional_regions"`
}

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

	AllAccounts map[string]json.Number `yaml:"all_accounts"`
	AccountName string                 `yaml:"account_name"`
	Global      *Component
}

Account is an account

type Atlantis

type Atlantis struct {
	Enabled  bool
	Projects []AtlantisProject

	// AWSProfiles is a map of profile name -> role info
	// TODO de-dupe this with AWSProfile in the travis-ci plan
	AWSProfiles map[string]AWSRole
}

type AtlantisComponent

type AtlantisComponent struct {
	Enabled  bool   `yaml:"enabled"`
	RoleName string `yaml:"role_name"`
	RolePath string `yaml:"role_path"`
}

type AtlantisProject

type AtlantisProject struct {
	Name             string `yaml:"name"`
	Dir              string `yaml:"dir"`
	TerraformVersion string `yaml:"terraform_version"`
	PathToRepoRoot   string `yaml:"path_to_repo_root"`
}

type BlessProvider

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

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

	Accounts  map[string]Account // Reference accounts for remote state
	Component string
	EKS       *v1.EKSConfig `yaml:"eks,omitempty"`
	Env       string

	Kind            *v1.ComponentKind `yaml:"kind,omitempty"`
	ModuleSource    *string           `yaml:"module_source"`
	OtherComponents []string          `yaml:"other_components"`
	Global          *Component
}

Component is a component

type ComponentCommon

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

	Atlantis  AtlantisComponent `yaml:"atlantis"`
	Backend   AWSBackend        `yaml:"backend"`
	ExtraVars map[string]string `yaml:"extra_vars"`
	Owner     string
	Project   string
	Providers Providers `yaml:"providers"`
	TfLint    TfLint
}

type Env

type Env struct {
	Components map[string]Component
	Env        string
	EKS        *v1.EKSConfig //TODO get rid of this
}

Env is an env

type Module

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

Module is a module

type OktaProvider

type OktaProvider struct {
	OrgName string  `json:"org_name,omitempty"`
	Version *string `json:"version,omitempty"`
}

type Plan

type Plan struct {
	Accounts map[string]Account
	Atlantis Atlantis
	Envs     map[string]Env
	Global   Component
	Modules  map[string]Module
	TravisCI TravisCI
	Version  string
}

Plan represents a set of actions to take

func Eval

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

Eval evaluates a config

type Providers

type Providers struct {
	AWS       *AWSProvider       `yaml:"aws"`
	Snowflake *SnowflakeProvider `yaml:"snowflake"`
	Bless     *BlessProvider     `yaml:"bless"`
	Okta      *OktaProvider      `yaml:"okta"`
}

type SnowflakeProvider

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

type TfLint

type TfLint struct {
	Enabled bool
}

TfLint containts a plan for running tflint

type TravisCI

type TravisCI struct {
	AWSProfiles []AWSProfile
	Enabled     bool
	FoggVersion string
	TestBuckets [][]string
}