Installing tsuru clients

tsuru contains three clients: tsuru, tsuru-admin and crane.

  • tsuru is the command line utility used by application developers, that will allow users to create, list, bind and manage apps. For more details, check tsuru usage;
  • crane is used by service administrators. For more detail, check crane usage;
  • tsuru-admin is used by cloud administrators. Whoever is allowed to use it has gotten super powers :-)

This document describes how you can install those clients, using pre-compiled binaries or building them from source.

Using homebrew (Mac OS X only)

Using the PPA (Ubuntu only)

Pre-built binaries (Linux and Mac OS X)

Build from source (Linux and Mac OS X)

Using homebrew (Mac OS X only)

If you use Mac OS X and homebrew, you may use a custom tap to install tsuru, crane and tsuru-admin. First you need to add the tap:

$ brew tap tsuru/homebrew-tsuru

Now you can install tsuru, tsuru-admin and crane:

$ brew install tsuru
$ brew install tsuru-admin
$ brew install crane

Whenever a new version of any of tsuru’s clients is out, you can just run:

$ brew update
$ brew upgrade <formula> # tsuru/tsuru-admin/crane

For more details on taps, check homebrew documentation.

NOTE: Tsuru requires Go 1.1 or higher. Make sure you have the last version of Go installed in your system.

Using the PPA (Ubuntu only)

Ubuntu users can install Tsuru clients using apt-get and the Tsuru PPA. You’ll need to add the PPA repository locally and run an apt-get update:

$ sudo apt-add-repository ppa:tsuru/ppa
$ sudo apt-get update

Now you can install Tsuru’s clients:

$ sudo apt-get install tsuru
$ sudo apt-get install crane
$ sudo apt-get install tsuru-admin

Pre-built binaries (Linux and Mac OS X)

tsuru clients are also distributed in binary version, so you can just download an executable and put them somewhere in your PATH.

It’s important to note that all binaries are platform dependent. Currently, we provide each of them in three flavors:

  1. darwin_amd64: This is Mac OS X, 64 bits. Make sure the command uname -ms prints “Darwin x86_64”, otherwise this binary will not work in your system;
  2. linux_386: This is Linux, 32 bits. Make sure the command uname -ms prints “Linux x86”, otherwise this binary will not work in your system;
  3. linux_amd64: This is Linux, 64 bits. Make sure the command uname -ms prints “Linux x86_64”, otherwise this binary will not work in your system.

Below are the links to the binaries, you can just download, extract the archive and put the binary somewhere in your PATH:

darwin_amd64

linux_386

linux_amd64

Build from source (Linux and Mac OS X)

Tsuru’s source is written in Go, so before installing tsuru from source, please make sure you have installed and configured Go.

With Go installed and configured, you can use go get to install any of tsuru’s clients:

$ go get github.com/tsuru/tsuru/cmd/tsuru
$ go get github.com/tsuru/tsuru/cmd/tsuru-admin
$ go get github.com/tsuru/tsuru/cmd/crane