Nucleator CLI Reference

SYNOPSIS

nucleator [--version] [--help] [-v | --verbose | -v[v*]]
    <command> [<args>]

DESCRIPTION

Nucleator is a devops framework that provides for the creation of secure, scalable, highly available environments in Amazon Web Services (AWS), into which reusable stacks of components can be deployed to address common cloud usage scenarios. Each Nucleator Stackset implements an AWS Reference Architecture, and provides for provisioning, configuration, and operations.

Nucleator makes it easy to partition environments across multiple AWS accounts and to leverage a supported and maintained set of CloudFormation stacks that work together to allow users to focus on their core problems. It can be used to rapidly implement common scenarios in brand new AWS Accounts so that customers new to AWS can get started quickly while leveraging accumulated best practices.

Nucleator provides an extensible model for Stackset contributions from both public and private communities. Git is leveraged extensively for community-oriented distributed development, versioning and release management of Stacksets.

See nucleatorquickstart(7) to get started. The Nucleator User’s Guide provides a more in-depth introduction.

OPTIONS

--version: Prints the nucleator suite version that the nucleator program came from.
--help: Prints the synopsis and a list of the most commonly used commands. If the option --all or -a is given then all available commands are printed. If a nucleator command is named this option will bring up the manual page for that command.

Other options are available to control how the manual page is displayed. See linkgit:nucleator-help[1] for more information, because nucleator --help ... is converted internally into nucleator help ....
-v
--verbose
-v[v*]: Increase verbosity used for all commands / subcommands, as well as any invoked provisioning or configuration playbooks. Multiple v's may be specified for increased levels of verbosity.

NUCLEATOR COMMANDS

nucleator-account(1): implement AWS Account setup best practices.
nucleator-account-rolespec(1): maintain IAM Roles in AWS Account required by Nucleator Stacksets.
nucleator-account-setup(1): set up AWS account with minimal best-practice AWS Resources.
nucleator-bakery(1): Provision, Configure and Publish Operations on EC2 Amazon Machine Images.
nucleator-beanstalk(1): Provision, Configure and Invoke Operations on Elastic Beanstalk Applications and Environments in Nucleator Cages.
nucleator-builder(1): Install the builder stackset which includes the Nucleator and the Nucleator UI in a secure manner within a Nucleator build Cage..
nucleator-cage(1): Provision, Configure and Invoke Operations on Nucleator Cages.
nucleator-init(1): Initialize nucleator local configuration files.
nucleator-redshift(1): Provision Amazon Redshift clusters in Nucleator Cages.
nucleator-setup(1): manage the site configuration files.
nucleator-update(1): localize Nucleator Stacksets from specified public or private git sources.

Authors

Nucleator was created by 47Lining. http://www.47lining.com

Contributing to Nucleator

Community contributions and feedback are strongly encouraged.

Nucleator project discussion occurs on the nucleator-project google group list.

Development discussion occurs on the nucleator-dev google group list.

Report bugs at the 47lining/nucleator-core repository at github, or directly against the appropriate Nucleator Stackset repository.

NUCLEATOR

Part of the nucleator(1) suite