Getting started with Cloud 66 Toolbelt
12 October 2016
This feature series will focus on the Cloud 66 Toolbelt and will be organized into three parts: for beginners, intermediate and advanced level users. This is part one.
What is Toolbelt
Toolbelt is our open source command line tool, allowing developers to manage and interact with their stacks using their Cloud 66 account. Additionally, it provides you with access to advanced configuration options and is available for Linux, Mac and Windows users.
To get started, log in to your Cloud 66 account, scroll to the bottom of the page and click on Get Toolbelt. Download the toolbelt executable and install it directly to your PATH.
Note: You’ll need to link the Toolbelt to your Cloud 66 account before you start using it. To do this, issue the following command:
$ cx stacks list
This command will direct you to the URL, which you need to copy and paste into your browser. This URL will redirect you to your account and ask for authorization. Once that’s done, copy and paste the given code directly to your Toolbelt and you’re ready to go.
For more details, check out our introduction to Toolbelt help page.
Ok, now you have Cloud 66 Toolbelt successfully installed and you have already used your first command line, you can now start to explore it further. As a beginner, I’d recommend you start with the following commands: redeploy a stack and create a stack with EasyDeploy. This will help you become more familiar with the process.
To redeploy your existing stack, you can either click on the redeploy button in our UI, or you can use our
$ cx redeploy command line.
In situations when you need to redeploy the same stack multiple times, it will automatically enqueue your redeployment command and will run it immediately after the current deployment is finished.
This is how you can use the redeploy command line (where s = stack, y = automatically answer yes to any prompts and e = your stack environment)
$ cx redeploy [-s <stack>] [-y] [--git-ref <git_ref>] [--service <service>] [--service <service>] [--service <service>]
For a list of parameters and more examples please visit our help page.
- Creating a stack with EasyDeploy
With our Toolbelt you can deploy a Docker stack from the Cloud 66 EasyDeploy App Store with a single command line:
$ cx easydeploys list
The EasyDeploy App Store is our automated platform where you can deploy and manage open source applications. For more details on EasyDeploy App Store read our blog post or check out our help page on how to use the EasyDeploy command line.
The following commands are useful if you need to find out more information about your toolbelt.
cx help- lists available commands
cx info- shows information about your toolbelt
cx --version- outputs your toolbelt version
cx stacks list- lists available stacks
cx servers list -s <stack_name>- lists available servers in a given stack
cx open -s <stack_name>- opens your web browser to visit the app server in your stack
Once you’re confident you’ve got the hang of things, you can explore our Toolbelt command directory listed on our help page. Additionally, you can read part two of this post and start using more complicated command lines.
Originally published at blog.cloud66.com on October 12, 2016.