tasks

README

Cli Tasks

This folder contains apators for the CLI.

Documentation

Index

• Variables
• func AddPluginToManifest(c *cli.Context) error
• func Delete(c *cli.Context)
• func Generate(c *cli.Context)
• func InitialiseNewManifestTask(c *cli.Context) error
• func InstallPlugins(c *cli.Context)
• func PrintEvents(c *cli.Context)
• func Update(c *cli.Context)
• func Upsert(c *cli.Context)

Variables

var CloudFormationStackFlags = []cli.Flag{
	cli.StringFlag{
		Name:  "region, r",
		Usage: "region to deploy to eg `us-east-1`",
	},
	cli.StringFlag{
		Name:  "stack-name",
		Usage: "stack name to deploy [Default: ProjectName-Filename-Environment] eg `StackName-Environment`",
	},
	cli.StringFlag{
		Name:  "environment, e",
		Usage: "environment config to use from ./kombustion.yaml eg `production`",
	},
}

CloudFormationStackFlags for tasks relating to CRUD of cloudformation stacks

var DeleteFlags = []cli.Flag{}

DeleteFlags for use with the delete taks

var GenerateFlags = []cli.Flag{
	cli.StringSliceFlag{
		Name:  "param, p",
		Usage: "cloudformation parameters. eg. `--param Env=dev --param BucketName=test`",
	},
	cli.BoolFlag{
		Name:  "generate-default-outputs, b",
		Usage: "disable generation of outputs for Base AWS types",
	},
	cli.StringFlag{
		Name:  "read-parameters",
		Usage: "Read parameters from a file",
	},
	cli.BoolFlag{
		Name:  "write-parameters, w",
		Usage: "Write parameters to a file",
	},
	cli.StringFlag{
		Name:  "output-directory, d",
		Usage: "Directory to write generated yaml to",
		Value: "compiled",
	},
}

GenerateFlags for kombustion upsert

var GlobalFlags = []cli.Flag{
	cli.BoolFlag{
		Name:  "verbose",
		Usage: "output with high verbosity",
	},
	cli.StringSliceFlag{
		Name:  "param, p",
		Usage: "cloudformation parameters `BucketName=test`",
	},
	cli.StringFlag{
		Name:  "profile",
		Usage: "use a profile from ~/.aws/credentials eg `MyProfile`",
	},
	cli.StringFlag{
		Name:  "manifest-file",
		Usage: "location of the manifest file, defaults to `kombustion.yaml`",
		Value: "kombustion.yaml",
	},
}

GlobalFlags for all tasks

var InitManifestFlags = []cli.Flag{
	cli.StringFlag{
		Name:  "name, n",
		Usage: "Set the name of the project",
	},
	cli.StringFlag{
		Name:  "environments",
		Usage: "comma seperated environments eg: production,development",
	},
}

InitManifestFlags - Flags that will prevent prompts

var UpdateFlags = []cli.Flag{
	cli.BoolFlag{
		Name:  "y",
		Usage: "dont prompt if there is an update",
	},
}

UpdateFlags - Flags that will prevent prompts

var UpsertFlags = []cli.Flag{
	cli.StringSliceFlag{
		Name:  "param, p",
		Usage: "cloudformation parameters. eg `BucketName=test`",
	},
	cli.StringSliceFlag{
		Name:  "tag, t",
		Usage: "tags to add to cloudformation stack. eg `CostCenter=example`",
	},
	cli.BoolFlag{
		Name:  "generate-default-outputs, b",
		Usage: "disable generation of outputs for Base AWS types",
	},
	cli.StringFlag{
		Name:  "read-parameters",
		Usage: "Read parameters from a file",
	},
	cli.BoolFlag{
		Name:  "iam, i",
		Usage: "gives the capability to perform upserts of IAM resources",
	},
	cli.StringSliceFlag{
		Name:  "capability",
		Usage: "set capabilities for the upsert eg `CAPABILITY_IAM`",
	},
	cli.BoolFlag{
		Name:  "confirm",
		Usage: "Manually confirm required changes before applying",
	},
}

UpsertFlags for kombustion upsert

Functions

func AddPluginToManifest

func AddPluginToManifest(c *cli.Context) error

AddPluginToManifest file and update it

func Delete

func Delete(c *cli.Context)

Delete a given stack

func Generate

func Generate(c *cli.Context)

Generate a template and save it to disk, without upserting it

func InitialiseNewManifestTask

func InitialiseNewManifestTask(c *cli.Context) error

InitaliseNewManifestTask - Create a new manifest file, and prompt to fill out the default required fields

func InstallPlugins

func InstallPlugins(c *cli.Context)

InstallPlugins to reconcile the manifest to the lock file, and then the lock file to the disk Which is to say, ensure the manifest and lock file agree with the state of the plugins and then ensure the lock file agrees with the disk on the state of the plugins

func PrintEvents

func PrintEvents(c *cli.Context)

PrintEvents outputs the events of a stack

func Update

func Update(c *cli.Context)

Update kombustion

func Upsert

func Upsert(c *cli.Context)

Upsert a stack