clever-tools

clever-tools

Command Line Interface for Clever Cloud.

Installation

⚠️ We no longer support the usage and installation of Clever Tools via a global npm install.

Please follow the installation instructions for your platform (see below) and make sure to uninstall the npm version with this:

npm uninstall -g clever-tools

Please refer to https://www.clever-cloud.com/doc/clever-tools/getting_started/ for the installation details.

MacOS

Clever Tools is packaged using homebrew:

brew install CleverCloud/tap/clever-tools

If you don't want to use brew, a pre-compiled version is available: clever-tools-latest_macos.tar.gz. You need to put both files (clever and nodegit.node) in your PATH to use the application.

Autocompletion

Clever Tools comes with a comprehensive auto-completion system. The brew package installs it automatically (for bash and zsh). Make sure bash-completions or zsh-completions are properly set up.

# In ~/.bash_profile
. /usr/local/etc/bash_completion

# In ~/.zshrc
fpath=(/usr/local/share/zsh-completions $fpath)

Windows

Clever Tools is packaged using chocolatey:

choco install clever-tools

If you don't want to use chocolatey, a pre-compiled version is available: clever-tools-latest_win.zip. You need to add both files (clever.exe and nodegit.node) to your PATH to use the application.

GNU/Linux

Debian/Ubuntu

You need to add our deb repository which is provided by bintray. Make sure that you have what it needs to add an HTTPS repo and its GPG key.

apt-get install -y apt-transport-https gnupg
apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys "379CE192D401AB61"
echo "deb https://dl.bintray.com/clevercloud/deb stable main" | tee -a /etc/apt/sources.list
apt-get update
apt-get install -y clever-tools

CentOS/Fedora/RHEL

You need to add our rpm repository which is provided by bintray.

curl https://bintray.com/clevercloud/rpm/rpm > /etc/yum.repos.d/bintray-clevercloud-rpm.repo
echo "exclude=*beta*" >> /etc/yum.repos.d/bintray-clevercloud-rpm.repo
yum install clever-tools

Archlinux

The package is available on the AUR: clever-tools-bin

Other distributions

A pre-compiled version is available: clever-tools-latest_linux.tar.gz. You need to add both files (clever and nodegit.node) to your PATH (you can put them in ~/.local/bin for instance) to use the application.

curl -O https://clever-tools.cellar.services.clever-cloud.com/releases/latest/clever-tools-latest_linux.tar.gz
tar zxf clever-tools-latest_linux.tar.gz
cp {clever,nodegit.node} ~/.local/bin/

Autocompletion

Clever Tools comes with a comprehensive auto-completion system.

# for bash
clever --bash-autocomplete-script $(which clever) | sudo tee /usr/share/bash-completion/completions/clever

# for zsh
clever --zsh-autocomplete-script $(which clever) | sudo tee /usr/share/zsh/site-functions

How to use

Login

To use clever-tools, you have to login.

clever login

It will open a page in your browser. Copy the provided token and secret codes in the CLI.

clever login tries to open a browser through xdg-open on GNU/Linux systems (and in bash for windows). Make sure you have xdg-utils available as well as a default browser set (or you can copy and paste the URL displayed in the console.

Create an application

clever create <name> --type <type> \
  [--region <region>] \
  [--org <organisation>] \
  [--alias <alias>]

Where type is one of:

• docker: for Docker-based applications
• go: for Go applications
• gradle: for applications launched with gradle
• haskell: for haskell applications
• jar: for applications deployed as standalone jar files
• maven: for applications launched with maven
• node: for node.js applications
• php: for PHP applications
• play1: for Play1 applications
• play2: for Play2 applications
• python: for python27 applications
• ruby: for ruby applications
• rust: for rust applications
• sbt: for applications launched with SBT
• static-apache: for static (HTML only) websites
• war: for applications deployed as war files

Where region is one of:

• par (for Paris)
• mtl (for Montreal)

--org allows you to chose the organisation in which your app is created.

--alias allows you to deploy the same application in multiple environments on Clever Cloud (eg: production, testing, …)

Link an existing application

clever link [--org <ORG-NAME>] <APP-NAME> [--alias <alias>]

Where APP-NAME is the name of your application, and ORG-NAME is the name of the organisation it's in. You can specify a complete application id instead of its name (in that case, --org can be omitted).

Deploy an application

clever deploy [--alias <alias>]

--alias allows you to deploy your application several times on Clever Cloud (eg: production, testing, …)

Application status

clever status [--alias <alias>]

Change application scalability

clever scale [--alias <alias>] [--min-flavor <minflavor>] [--max-flavor <maxflavor>] [--min-instances <mininstances>] [--max-instances <maxinstances>]

Logs Drains

# create drain
clever drain create [--alias <alias>] <DRAIN-TYPE> <DRAIN-URL> [--username <username>] [--password <password>]

# list drains
clever drain [--alias <alias>]

# remove drain
clever drain remove [--alias <alias>] <DRAIN-ID>

Where DRAIN-TYPE is one of:

• TCPSyslog: for TCP syslog endpoint ;
• UDPSyslog: for UDP syslog endpoint ;
• HTTP: for TCP syslog endpoint (note that this endpoint has optional username/passwordparameters as HTTP Basic Authentication);
• ElasticSearch: for ElasticSearch endpoint (note that this endpoint requires username/password parameters as HTTP Basic Authentication).

ElasticSearch drains use the Elastic bulk API. To match this endpoint, specify /_bulk at the end of your ElasticSearch endpoint.

Display help

You can display help about each command with clever help.

clever help
clever help deploy

Examples

cd node_project
clever login
clever create "Node.js application" -t node -r mtl
clever deploy

How to send feedback?

Send us an email! or submit an issue.

Automated testing

This project uses Travis CI to launch unit tests and validate pull requests before they're merged: https://travis-ci.org/CleverCloud/clever-tools

Automated releases

When it comes to support multiple platforms (MacOS, Windows & GNU/Linux) and multiple versions of node.js, one of our dependencies (nodegit) is a tricky beast. In order to simplify the development and maintenance of this project, we chose to package the clever tools CLI with pkg. It allowed us to:

• fix node.js to a version that is officially tested with nodegit (8.3.0 for now)
• produce one binary per platform (MacOS, Windows & GNU/Linux) with one command
  • the only caveat is that the binary is not 100% standalone because we need to provide nodegit.node along with it

To distribute these binaries, we're packaging them as archives and releasing them on a Clever Cloud cellar bucket. We're also distributing them via platform specific systems (archlinux AUR, homebrew, chocolatey).

All those packages are built with an internal Jenkins. Here are some details about those build jobs.

Job: clever-tools

• This job runs scripts/release-job.sh on each commit merged to the master branch.
• It builds 3 archives, one for each platform (MacOS, Windows & GNU/Linux) and computes sha256 sums.
  • The files are always named with master.
• All those artifacts (tar.gz, zip and sha256) are archived on Jenkins.

Job: clever-tools-tag

• This job runs scripts/release-job.sh on each tag.
  • It forces a BUILD_ONLY=1 when launching npm install but we're not sure about the details. See #1246, #1225 and #1361.
• It builds 3 archives, one for each platform (MacOS, Windows & GNU/Linux) and computes sha256 sums.
  • The files are named with the tag name (semver X.Y.Z).
  • The files are also copy/pasted with latest.
• All those artifacts (tar.gz, zip and sha256) are published on a Clever Cloud cellar bucket.

This job also triggers 3 sub-jobs :

• clever-tools-bin-arch
• clever-tools-brew
• clever-tools-choco

All those jobs receive 2 variables: the tag name and the sha256 sums.

Job: clever-tools-bin-arch

This job builds a new archlinux AUR package with the following tasks:

• clone this project clever-tools-bin
• use sed command on files PKGBUILD.template and .SRCINFO.template to inject variables (version and sha256 sum) and create new files
• create a new commit with [e-mail]
• push to remote master (which will make the new aur package available)

Job: clever-tools-brew

This job builds a new homebrew package with the following tasks:

• clone this project homebrew-tap
• use sed command on file clever-tools.template.rb to inject variables (version and sha256 sum) and create new file
• create a new commit with [e-mail]
• push to remote master (which will make the homebrew package available)

Job: clever-tools-choco

This job builds a new chocolatey package with the following tasks:

• clone this project chocolatey-packages
• run scripts/build-nupkg.sh to produce the new nupkg file
  • This nupkg file artifact is archived on Jenkins.

⚠️ The publication of this artifact on the public chocolatey site is still a manual process. You can find more information about why on this issue. mercredi 29 août 2018, 14:49:21 (UTC+0200)