project

Documentation

Index

• Variables
• func CleanStackFolder(stackFolder string, ignoreFolders []string) (err error)
• func CloneEnv(basePath string, name string, src string) (err error)
• func CopyBlueprintFolders(workingFolder string, destinyFolder string, ignoreFolders []string, ...) (err error)
• func DoInit(prjConfig *ProjectConfig, linkInit bool) (err error)
• func GetConfigFiles(location string, fileName string, ignoreFolders []string) (configFiles []string, err error)
• func InitProject(basePath string, linkInit bool) (err error)
• func LinkBlueprintFolders(workingFolder string, destinyFolder string, ignoreFolders []string, ...) (err error)
• func SyncBlueprintFolders(workingFolder string, destinyFolder string, ignoreFolders []string, ...) error
• func ValidateProject(prjConfig *ProjectConfig) (isValid bool, err error)
• type EnvConfig
  • func GetEnvConfig(filePath string) (envConfig *EnvConfig, err error)
• type ProjectConfig
  • func GetProjectConfig(filePath string) (prjConfig *ProjectConfig, err error)
• type ProjectScaffold
  • func NewProject(base *model.Scaffold, plaform string, stack string, blueprint string, ...) (project *ProjectScaffold, err error)
  • func (p *ProjectScaffold) Init() (err error)
• type RegionConfig
  • func GetRegionConfig(filePath string) (regConfig *RegionConfig, err error)

Variables

var (
	DefaultRegions      []string = []string{"us-east-1"}
	DefaultEnvironments []string = []string{"dev"}

	DefaultFileSet assets.FileSet = assets.FileSet{
		AssetsPath: "templates/prj",
		Set: map[string]map[string][]assets.FileTmpl{
			"aws": {
				"platform": []assets.FileTmpl{},
				"project": []assets.FileTmpl{
					{TmplFile: "prj.yml.tmpl", File: "prj.yml"},
					{TmplFile: "gitignore.tmpl", File: ".gitignore"},
					{TmplFile: "terragrunt.hcl.tmpl", File: "terragrunt.hcl"},
				},
				"environment": []assets.FileTmpl{
					{TmplFile: "env.yml.tmpl", File: "env.yml"},
				},
				"region": []assets.FileTmpl{
					{TmplFile: "region.yml.tmpl", File: "region.yml"},
					{TmplFile: "gitignore_region.tmpl", File: ".gitignore"},
				},
			},
		},
	}
)

var (
	DefaultIgnoredFiles []string = []string{
		"prj.yml",
		"env.yml",
		"region.yml",
		".git",
	}

	DefaultIgnoredFolders []string = []string{
		".terraform.lock.hcl",
		".terragrunt-cache",
		".history",
	}
)

Functions

func CleanStackFolder

func CleanStackFolder(stackFolder string, ignoreFolders []string) (err error)

func CloneEnv

func CloneEnv(basePath string, name string, src string) (err error)

func CopyBlueprintFolders

func CopyBlueprintFolders(workingFolder string, destinyFolder string, ignoreFolders []string, verbose bool) (err error)

func DoInit

func DoInit(prjConfig *ProjectConfig, linkInit bool) (err error)

func GetConfigFiles

func GetConfigFiles(location string, fileName string, ignoreFolders []string) (configFiles []string, err error)

func InitProject

func InitProject(basePath string, linkInit bool) (err error)

func LinkBlueprintFolders

func LinkBlueprintFolders(workingFolder string, destinyFolder string, ignoreFolders []string, verbose bool) (err error)

func SyncBlueprintFolders

func SyncBlueprintFolders(workingFolder string, destinyFolder string, ignoreFolders []string, linkInit bool) error

func ValidateProject

func ValidateProject(prjConfig *ProjectConfig) (isValid bool, err error)

Types

type EnvConfig

type EnvConfig struct {
	Environment string   `yaml:"environment"`
	BasePath    string   `yaml:"basePath"`
	Ignore      []string `yaml:"ignore"`
}

func GetEnvConfig

func GetEnvConfig(filePath string) (envConfig *EnvConfig, err error)

type ProjectConfig

type ProjectConfig struct {
	Name          string   `yaml:"name"`
	SlugName      string   `yaml:"slugName"`
	BluePrint     string   `yaml:"blueprint"`
	BluePrintPath string   `yaml:"blueprintPath"`
	Stack         string   `yaml:"stack"`
	BasePath      string   `yaml:"basePath"`
	ProjectPath   string   `yaml:"projectPath"`
	Ignore        []string `yaml:"ignore"`
}

func GetProjectConfig

func GetProjectConfig(filePath string) (prjConfig *ProjectConfig, err error)

type ProjectScaffold

type ProjectScaffold struct {
	model.Scaffold
	Platform       string
	PlatformPath   string
	ProjectPath    string
	Stack          string
	Blueprint      string
	Environments   []model.Environment
	Regions        []model.Region
	UseRemoteState bool
	RemoteBucket   string
	RemoteRegion   string
}

func NewProject

func NewProject(
	base *model.Scaffold,
	plaform string,
	stack string,
	blueprint string,
	useRemoteState bool,
	remoteStateBucket string,
	remoteStateRegion string,
	environments []string,
	regions []string) (project *ProjectScaffold, err error)

func (*ProjectScaffold) Init

func (p *ProjectScaffold) Init() (err error)

type RegionConfig

type RegionConfig struct {
	Region   string   `yaml:"region"`
	BasePath string   `yaml:"basePath"`
	Ignore   []string `yaml:"ignore"`
}

func GetRegionConfig

func GetRegionConfig(filePath string) (regConfig *RegionConfig, err error)