A command line interface for colony
Project description
Colony CLI
Cloudshell Colony CLI
Colony CLI is a command line interface tool for CloudShell Colony.
The main functionality this tool currently provides is validation of Colony blueprints and launching sandbox environments from main and development branches.
Why use Colony CLI
When developing blueprints for Colony, it can be very helpful to immediately check your work for errors.
Let's assume you are currently working in development branch, and you also have a main branch which is connected to a Colony space. You would like to be sure that your latest committed changes haven't broken anything before merging them to the main branch.
This is where this tool might be handy for you. Instead of reconnecting Colony to your development branch in UI or "merge and pray" you can use Colony CLI to validate your current blueprints state and even launch sandboxes from them.
Installing
You can install Colony CLI with pip:
$ python -m pip install colony-cli
Or if you want to install it for your user:
$ python -m pip install --user colony-cli
Configuration
First of all you need to generate an access token. In the Colony UI navigate to Settings (in your space) -> Integrations -> click “Connect” under any of the CI tools -> click “New Token” to get an API token. Then, you need to configure Colony CLI with the generated token and the colony space you are going to access. There are three ways how to do it:
- Use credentials file, with profiles. Create an INI formatted file like this:
[default]
token = xxxyyyzzz
space = DemoSpace
[user]
token = aaabbbccc
space = TestSpace
And place it in your home user directory ('~/.colony/config' on Mac and Linux or in '%UserProfile%\.colony\config' on Windows). If you wish to place credentials file in a different location, you need to tell Colony CLI where to find it. Do this by setting the appropriate environment variable:
$ export COLONY_CONFIG_PATH=/path/to/file
- Set environment variables:
export COLONY_TOKEN = xxxzzzyyy
export COLONY_SPACE = demo_space
- Specify --space and --token options as part of the command:
$ colony --space=trial --token=xxxyyyzzz <command>
Basic Usage
Colony CLI currently allows you to make two actions:
- validate blueprint (using
colony bp validate
command) - start sandbox (via
colony sb start
)
In order to get help run:
$ colony --help
It will give you detailed output with usage:
$ colony --help
Usage: colony [--space=<space>] [--token=<token>] [--profile=<profile>] [--help] [--debug]
<command> [<args>...]
Options:
-h --help Show this screen.
--space=<space> Colony Space name
--token=<token> Specify token generated by Colony
--profile=<profile> Profile indicates a section in config file.
If set neither --token or --space must not be specified.
Commands:
bp, blueprint validate colony blueprints
sb, sandbox start sandbox
You can get additional help information for a particular command by specifying --help flag after command name, like:
usage:
colony (sb | sandbox) start <blueprint_name> [options]
colony (sb | sandbox) status <sandbox_id>
colony (sb | sandbox) end <sandbox_id>
colony (sb | sandbox) list [--filter={all|my|auto}] [--show-ended] [--count=<N>]
colony (sb | sandbox) [--help]
options:
-h --help Show this message
-d, --duration <minutes> Sandbox will automatically deprovision at the end of the provided duration
-n, --name <sandbox_name> Provide name of Sandbox. If not set, the name will be generated using timestamp
-i, --inputs <input_params> Comma separated list of input parameters. Example: key1=value1, key2=value2.
By default Colony CLI will try to take default values for inputs from blueprint
definition yaml file (if you are inside a git-enabled folder of blueprint repo).
Use this option to override them.
-a, --artifacts <artifacts> Comma separated list of artifacts with paths where artifacts are defined per
application. The artifact name is the name of the application.
Example: appName1=path1, appName2=path2.
By default Colony CLI will try to take artifacts from blueprint definition yaml
file (if you are inside a git-enabled folder of blueprint repo).
Use this option to override them.
-b, --branch <branch> Specify the name of remote git branch. If not provided, we will try to
automatically detect the current working branch if the command is used in a
git enabled folder.
-c, --commit <commitId> Specify commit ID. It's required to run sandbox from a blueprint from an
historic commit. Must be used together with the branch option.
If not specified then the latest commit will be used
-w, --wait <timeout> Set the timeout in minutes for the sandbox to become active. If not set, command
will not block terminal and just return the ID of started sandbox
Blueprint validation
-
If you are currently inside a git-enabled folder containing your blueprint, commit and push your latest changes and run (Colony CLI will automatically detect the current working branch):
$ colony bp validate MyBlueprint
-
If you want to validate a blueprint from another branch you can specify --branch argument or even check validation in a specific point in time by setting --commit:
$ colony bp validate MyBlueprint --branch dev --commit fb88a5e3275q5d54697cff82a160a29885dfed24
NOTE
If you are not it git-enabled folder of your blueprint repo and haven't set --branch/--commit arguments tool will validate blueprint with name "MyBlueprint" from branch currently attached to your Colony space.
If blueprint is valid you will get output with "Valid" message. If no, it will print you a table with found errors.
Example:
$colony blueprint validate Jenkins -b master
ERROR - colony.commands - Validation failed
message name
--------------------------------------------------------------------------- -------------------------------
Cloud account: AWS is not recognized as a valid cloud account in this space Blueprint unknown cloud account
Launching sandbox
-
Similar to the previous command you can omit --branch/--commit arguments if you are in a git-enabled folder of your blueprint repo:
$ colony sb start MyBlueprint
-
This will create a sandbox from the specified blueprint
-
If you want to start a sandbox from a blueprint in a specific state, specify --branch and --commit arguments:
$ colony sb start MyBlueprint --branch dev --commit fb88a5e3275q5d54697cff82a160a29885dfed24
-
Additional optional options that you can provide here are:
-d, --duration <minutes>
- you can specify duration for the sandbox environment in minutes. Default is 120 minutes-n, --name <sandbox_name>
- the name of sandbox you want to create. By default it will generate name using blueprint name + current timestamp-i, --inputs <input_params>
- comma-separated list of input parameters for sandbox, like: "param1=val1, param2=val2"-a, --artifacts <artifacts>
- comma-separated list of sandbox artifacts, like: "app1=path1, app2=path2"-w, --wait <timeout>
- is a number of minutes. If set, you Colony CLI will wait for sandbox to become active and lock your terminal.
NOTE
-
If you are not it git-enabled folder of your blueprint repo and haven't set --branch/--commit arguments tool will start sandbox using blueprint with name "MyBlueprint" from branch currently attached to your Colony space.
-
If you omit artifacts and inputs options, you are inside a git enabled folder and the local is in sync with remote, then Colony Cli will try to get default values for artifacts and inputs from the blueprint yaml.
Result of the command is a Sandbox ID.
Example:
colony sb start MyBlueprint --inputs "CS_COLONY_TOKEN=ABCD, IAM_ROLE=s3access-profile, BUCKET_NAME=abc"
ybufpamyok03c11
Other functionality
You can also end colony sandbox knowing its Id with command:
$ colony sb end <sandbox> id
To get current sandbox status run:
$ colony sb status <sandbox> id
In order to list sandboxes in your space use the following command:
$ colony sb list
- By default it will show only yours sandbox which are not in an ended status.
- You can include ended sandboxes by setting
--show-ended
flag - Default output length is 25. You can override with option
--count=N
where N < 1000 - You can also list sandboxes created by other users or filter only automation sandboxes by setting option
--filter={all|my|auto}
. Default ismy
.
Troubleshooting and Help
To troubleshoot what Colony CLI is doing you can add --debug to get additional information.
For questions, bug reports or feature requests, please refer to the Issue Tracker.
Contributing
All your contributions are welcomed and encouraged. We've compiled detailed information about:
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for colony_cli-1.2.2b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb1a3075cc21c7f43114914faf77cff2739282ef80c636b3f3ae1612d7c7c5f0 |
|
MD5 | 41042a656b6110354d703e815a7ded04 |
|
BLAKE2b-256 | 7340be7dea97cc2751c2d175b75e533937f72cef29cafb34b7557d0ebab5b951 |