======================================================================
Installation of the CloudCoreo CLI tool, managed via NPM, is super simple. For a global install, which is recommended, run:
npm install -g cloudcoreo-cli
The following is a list of commands that can be run with the CLI tool. This is auto-generated.
-h, --help output usage information
-V, --version output the version number
The CloudCoreo CLI uses git-style subcommands. For help, try:
coreo help <command>
or
coreo <command> help <subcommand>
The init command houses everything necessary to create new AppStacks.
-h, --help output usage information
-V, --version output the version number
-D, --directory <fully-qualified-path> the working directory
new description
-h, --help output usage information
-s, --stack-type <stack type> What will this stack be? (server | stack)
Excluding the -D (--directory) option assumes your working directory is
where your AppStack exists.
$ coreo init new-stack -s server
$ coreo init new-stack --stack-type stack
Subcommands and actions housed within the stack command will handle all types of AppStack manipulation.
-h, --help output usage information
-V, --version output the version number
-s, --stack-id <appstack_id> the id of the appstack you want to list the versions of
-D, --directory <fully-qualified-path> the working directory
-p, --profile <profileName> What profile name to use - default is ['default']
a readme for the current working directory.
-h, --help output usage information
This will take a few different files and generate a readme for your stack.
It is handy for automating insertion into the CloudCoreo Hub
To use properly, create a few files:
description.md - contains the description for the CloudCoreo Hub entry. Generally a how-to for the stack.
no example for this one - it can be as long as you want and is all in markdown format
diagram.md - contains the markdown url for the diagram image
example diagram.md >
icon.md - contains the markdown url for the diagram image
example icon.md >
head.md - contains the header section. A one-liner usually.
example head.md >
stack-one-click
============================
This stack will work with CloudCoreo in a single click.
tags.md - contains a markdown list of tags to make the stack searchable in the hub
example tags.md >
1. Containers
1. High Availability
1. Multi-cluster
Example Usage:
$ cd <my cool stack base dir>
$ coreo stack generate-readme
the stack versions running in your CloudCoreo account.
-h, --help output usage information
This lists all of the stack versions running in your CloudCoreo account.
You must supply a profile name or it will assume [default].
$ coreo stack list
-= OR =.
$ coreo --profile myprofile stack list
the versions of the AppStacks running in your CloudCoreo account.
-h, --help output usage information
This lists all of the stack versions running in your CloudCoreo account.
You must supply a profile name or it will assume [default].
You must also supply a Stack ID or partial ID. If you supply a partial
ID, CloudCoreo will assume you want to see all versions from all matching
AppStacks. For instance, if you want to see version information for an
AppStack with id=543ee6737dd1, you can supply that id with:
--stack-id 543ee6737dd1
On the other hand, you can supply a value of:
--stack-id 5
And CloudCoreo will return all versions for all AppStacks with IDs begining
with the number 5.
$ coreo stack --stack-id 543 list-versions
-= OR =.
$ coreo --profile myprofile stack -s 543 list-versions
Add a sibling stack.
-h, --help output usage information
-s, --stack-type <stack type> What will this stack be? (server | stack)
-n, --stack-name <stack name> The name you would like to give to the sibling stack.
-g, --from-git <git ssh url> The Git SSH URL from which this stack will be extended.
Excluding the -D (--directory) option assumes your working directory is
where your AppStack exists.
This command will add a VPN server to your AppStack.
$ coreo stack add -s "server" -g "git@github.com:CloudCoreo/servers-vpn.git" -n "vpn"
$ coreo stack add --stack-type "server" --from-git "git@github.com:CloudCoreo/servers-vpn.git" -stack-name "vpn"
Extend a stack.
-h, --help output usage information
-g, --from-git <git ssh url> The Git SSH URL from which this stack will be extended.
Excluding the -D (--directory) option assumes your working directory is
where your AppStack exists.
This command will set your AppStack up to extend the CloudCoreo VPC.
$ coreo stack extend -g git@github.com:cloudcoreo/cloudcoreo-vpc
These are subcommands used to view log files.
-h, --help output usage information
-V, --version output the version number
-i, --version-id <version_id> the id of the appstack version you want to view the logs of
-p, --profile <profileName> What profile name to use - default is ['default']
the log of a running AppStack version
-h, --help output usage information
This lists all of the stack versions running in your CloudCoreo account.
You must supply a profile name or it will assume [default].
$ coreo stack list
-= OR =.
$ coreo --profile myprofile stack list
These are subcommands used for interacting with logged-in CloudCoreo accounts.
-h, --help output usage information
-V, --version output the version number
-p, --profile <profileName> What profile name to use - default is ['default']
Link your CLI with an existing CloudCoreo account.
-h, --help output usage information
-e, --email <email> What email do you use with your CloudCoreo account
This will associate a CloudCoreo account with the CLI tool account
and add a profile to your $HOME/.cloudcoreo/config file
$ coreo account link -e me@example.com
-= OR =.
$ coreo account link --email me@example.com
Link your CLI with an existing CloudCoreo account and upsert API keys.
-h, --help output usage information
-e, --email <email> What email do you use with your CloudCoreo account
This will associate a CloudCoreo account with the CLI tool account
and add a profile to your $HOME/.cloudcoreo/config file.
NOTE: This method will create or update API keys. If you need to rotate
credentials, simply run this command and the old keys will be
invalidated and replaced with new ones.
$ coreo --profile myprofile account link -e @example.com
-= OR =.
$ coreo --profile myprofile account link --email me@example.com
Create a new CloudCoreo account
-h, --help output usage information
-u, --username <username> What username to use on your new account
-e, --email <email> What email address to use on your new account
This will create a new CloudCoreo account and key pairs,
which can be used to access your account via the CLI tool.
The CLI tool will create a $HOME/.cloudcoreo directory and add a
config file with a JSON representation of the key pair and your username.
$ coreo account create -u my_new_username -e me@example.com
Use these to test aspects of your stack.
-h, --help output usage information
-V, --version output the version number
-D, --directory <fully-qualified-path> the working directory
that all variables are exposed in the top level variable file.
-h, --help output usage information
Excluding the -D (--directory) option assumes your working directory.
Run processes on a stack without a CloudCoreo account with these commands.
-h, --help output usage information
Create a new CloudCoreo account
-h, --help output usage information
-p, --profile <profile> the CloudCoreo profile to use. If it does not exist, it will be created and associated with the cloud account.
-a, --access-key-id <access-key-id> What Amazon AWS access key ID to use.
-e, --secret-access-key <secret-access-key> The secret access key associated with the corresponding access key ID.
-r, --region <region> The region in which this should be launched. If nothing is specified, it will look to launch in the default region supplied by an AWS CLI config file. If there is no CLI config specified, an error will occur.
This will create a new CloudCoreo account and key pairs,
which can be used for accessing your account via the CLI tool.
The CLI tool will create a $HOME/.cloudcoreo directory and add a
config file with a JSON representation of the key pair and your username.
$ coreo account create -u my_new_username -e me@example.com