plan

Documentation

Index

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

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  `json:"account_name" yaml:"account_name"`
	Profile     string  `json:"profile" yaml:"profile"`
	Region      string  `json:"region" yaml:"region"`
	Bucket      string  `json:"bucket" yaml:"bucket"`
	DynamoTable *string `json:"dynamo_table" yaml:"dynamo_table"`
}

AWSBackend represents aws backend configuration

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

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 `json:",inline" 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 `json:"additional_regions,omitempty" yaml:"additional_regions,omitempty"`
	AWSProfile        string   `json:"aws_profile,omitempty" yaml:"aws_profile,omitempty"`
	AWSRegion         string   `json:"aws_region,omitempty" yaml:"aws_region,omitempty"`
	Version           *string  `json:"version,omitempty" yaml:"version,omitempty"`
}

BlessProvider represents Bless ssh provider configuration

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 `json:",inline" yaml:",inline"`

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

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

Component is a component

type ComponentCommon

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

	Atlantis  AtlantisComponent `yaml:"atlantis"`
	Backend   AWSBackend        `json:"backend" yaml:"backend"`
	ExtraVars map[string]string `json:"extra_vars" yaml:"extra_vars"`
	Owner     string            `json:"owner" yaml:"owner"`
	Project   string            `json:"project" yaml:"project"`
	Providers Providers         `json:"providers" yaml:"providers"`
	TfLint    TfLint            `json:"tf_lint" yaml:"tf_lint"`
	TravisCI  TravisComponent
}

ComponentCommon represents common fields for components

type Env

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

Env is an env

type GithubProvider

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

GithubProvider represents a configuration of a github provider

type Module

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

Module is a module

type OktaProvider

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

OktaProvider represents Okta configuration

type Plan

type Plan struct {
	Accounts map[string]Account `json:"account" yaml:"account"`
	Atlantis Atlantis           `json:"atlantis" yaml:"atlantis"`
	Envs     map[string]Env     `json:"envs" yaml:"envs"`
	Global   Component          `json:"global" yaml:"global"`
	Modules  map[string]Module  `json:"modules" yaml:"modules"`
	TravisCI TravisCI           `json:"travis_ci" yaml:"travis_ci"`
	Version  string             `json:"version" yaml:"version"`
}

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"`
	Github    *GithubProvider    `yaml:"github"`
	Snowflake *SnowflakeProvider `yaml:"snowflake"`
	Bless     *BlessProvider     `yaml:"bless"`
	Okta      *OktaProvider      `yaml:"okta"`
}

type SnowflakeProvider

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

SnowflakeProvider represents Snowflake DB provider configuration

type TfLint

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

TfLint containts a plan for running tflint

type TravisCI

type TravisCI struct {
	Enabled     bool
	FoggVersion string
	TestBuckets [][]TravisProject
	AWSProfiles map[string]AWSRole
}

type TravisComponent

type TravisComponent struct {
	Enabled        bool
	AWSProfileName string
	AWSRoleName    string
	AWSAccountID   string
	Command        string
}

type TravisProject

type TravisProject struct {
	Name    string
	Dir     string
	Command string
}