core plugins

The Botoform bf tool ships with many core plugins and subcommands.

botoform.plugins.create

class botoform.plugins.create.Create

Create a new VPC and related services, modeled from YAML template.

This is a class plugin for the bf tool.

static main(args, evpc=None)

Creates a new VPC and related services, modeled from a YAML template.

Parameters:
Returns:

None

static setup_parser(parser)

Accepts a subparser and attaches additional arguments and flags.

Parameters:parser – An ArgumentParser sub parser. Reference: https://docs.python.org/3/library/argparse.html
Returns:None

botoform.plugins.destroy

botoform.plugins.destroy.destroy(args, evpc)

Destroy a VPC and related resources and services.

Parameters:
Returns:

None

botoform.plugins.lock

botoform.plugins.lock.lock(args, evpc)

Lock all instances in VPC to prevent termination.

Parameters:
Returns:

None

botoform.plugins.unlock

botoform.plugins.unlock.unlock(args, evpc)

Unock all instances in VPC to allow termination.

Parameters:
Returns:

None

botoform.plugins.dump

class botoform.plugins.dump.Dump

Dump AWS resourses as Botoform Schema.

This is a class plugin for the bf tool.

static main(args, evpc)
static setup_parser(parser)
botoform.plugins.dump.ansible_hosts(args, evpc)

Output an Ansible host inventory for the VPC.

Parameters:
Returns:

Ansible inventory to standard out.

botoform.plugins.dump.instances(args, evpc)

Output instance roles to standard out in Botoform Schema.

Parameters:
Returns:

instance_roles to standard out in Botoform Schema.

botoform.plugins.dump.security_groups(args, evpc)

Output Security Groups to standard out in Botoform Schema.

Parameters:
Returns:

security_groups to standard out in Botoform Schema.

botoform.plugins.repl

botoform.plugins.repl.REPL(args, evpc)

Open an interactive REPL (read-eval-print-loop) with access to evpc object

Parameters:
Subcommand aliases:
 

cli and shell

Returns:

Interactive shell with evpc botoform.enriched.vpc.EnrichedVPC().