Configuring tsuru¶

tsuru uses a configuration file in YAML format. This document describes what each option means, and how it should look like.

Notation¶

tsuru uses a colon to represent nesting in YAML. So, whenever this document say something like key1:key2, it refers to the value of the key2 that is nested in the block that is the value of key1. For example, database:url means:

database:
  url: <value>

tsuru configuration¶

This section describes tsuru’s core configuration. Other sections will include configuration of optional components, and finally, a full sample file.

HTTP server¶

tsuru provides a REST API, that supports HTTP and HTTP/TLS (a.k.a. HTTPS). Here are the options that affect how tsuru’s API behaves:

listen¶

listen defines in which address tsuru webserver will listen. It has the form <host>:<port>. You may omit the host (example: :8080). This setting has no default value.

use-tls¶

use-tls indicates whether tsuru should use TLS or not. This setting is optional, and defaults to “false”.

tls:cert-file¶

tls:cert-file is the path to the X.509 certificate file configured to serve the domain. This setting is optional, unless use-tls is true.

tls:key-file¶

tls:key-file is the path to private key file configured to serve the domain. This setting is optional, unless use-tls is true.

Database access¶

tsuru uses MongoDB as database manager, to store information about users, VM’s, and its components. Regarding database control, you’re able to define to which database server tsuru will connect (providing a MongoDB connection string). The database related options are listed below:

database:url¶

database:url is the database connection string. It is a mandatory setting and has no default value. Examples of strings include the basic “127.0.0.1” and the more advanced “mongodb://user@password:127.0.0.1:27017/database”. Please refer to MongoDB documentation for more details and examples of connection strings.

database:name¶

database:name is the name of the database that tsuru uses. It is a mandatory setting and has no default value. An example of value is “tsuru”.

Email configuration¶

tsuru sends email to users when they request password recovery. In order to send those emails, tsuru needs to be configured with some SMTP settings. Omitting these settings won’t break tsuru, but users would not be able to reset their password automatically.

smtp:server¶

The SMTP server to connect to. It must be in the form <host>:<port>. Example: “smtp.gmail.com:587”.

smtp:user¶

The user to authenticate with the SMTP sever. Currently, tsuru requires authenticated sessions.

smtp:password¶

The password for authentication within the SMTP server.

Git configuration¶

tsuru uses Gandalf to manage git repositories. Gandalf exposes a REST API for repositories management, and tsuru uses it. So tsuru requires information about the Gandalf HTTP server, and also its git-daemon and SSH service.

tsuru also needs to know where the git repository will be cloned and stored in units storage. Here are all options related to git repositories:

git:unit-repo¶

git:unit-repo is the path where tsuru will clone and manage the git repository in all units of an application. This is where the code of the applications will be stored in their units. Example of value: /home/application/current.

git:api-server¶

git:api-server is the address of the Gandalf API. It should define the entire address, including protocol and port. Examples of value: http://localhost:9090 and https://gandalf.tsuru.io:9595.

git:rw-host¶

git:rw-host is the host that will be used to build the push URL. For example, when the value is “tsuruhost.com”, the push URL will be something like git@tsuruhost.com:<app-name>.git.

git:ro-host¶

git:ro-host is the host that units will use to clone code from users applications. It’s used to build the read only URL of the repository. For example, when the value is “tsuruhost.com”, the read-only URL will be something like git://tsuruhost.com/<app-name>.git.

Authentication configuration¶

tsuru has support for native and oauth authentication schemes.

The default scheme is native and it supports the creation of users in tsuru’s internal database. It hashes passwords brcypt and tokens are generated during authentication, and are hashed using SHA512.

The auth section also controls whether user registration is on or off. When user registration is off, the user creation URL is not registered in the server.

auth:scheme¶

The authentication scheme to be used. The default value is native, the other supported value is oauth.

auth:user-registration¶

This flag indicates whether user registration is enabled. This setting is optional, and defaults to false.

auth:hash-cost¶

Required only with native chosen as auth:scheme.

This number indicates how many CPU time you’re willing to give to hashing calculation. It is an absolute number, between 4 and 31, where 4 is faster and less secure, while 31 is very secure and very slow.

auth:token-expire-days¶

Required only with native chosen as auth:scheme.

Whenever a user logs in, tsuru generates a token for him/her, and the user may store the token. auth:token-expire-days setting defines the amount of days that the token will be valid. This setting is optional, and defaults to “7”.

auth:max-simultaneous-sessions¶

tsuru can limit the number of simultaneous sessions per user. This setting is optional, and defaults to “unlimited”.

auth:oauth¶

Every config entry inside auth:oauth are used when the auth:scheme is set to “oauth”. Please check rfc6749 for more details.

auth:oauth:client-id¶

The client id provided by your OAuth server.

auth:oauth:client-secret¶

The client secret provided by your OAuth server.

auth:oauth:scope¶

The scope for your authentication request.

auth:oauth:auth-url¶

The URL used in the authorization step of the OAuth flow. tsuru CLI will receive this URL and trigger the opening a browser on this URL with the necessary parameters.

During the authorization step, tsuru CLI will start a server locally and set the callback to http://localhost:<port>, if auth:oauth:callback-port is set tsuru CLI will use its value as <port>. If auth:oauth:callback-port isn’t present tsuru CLI will automatically choose an open port.

The callback URL should be registered on your OAuth server.

If the chosen server requires the callback URL to match the same host and port as the registered one you should register “http://localhost:<chosen port>” and set the auth:oauth:callback-port accordingly.

If the chosen server is more lenient and allows a different port to be used you should register simply “http://localhost” and leave auth:oauth:callback-port empty.

auth:oauth:token-url¶

The URL used in the exchange token step of the OAuth flow.

auth:oauth:info-url¶

The URL used to fetch information about the authenticated user. tsuru expects a json response containing a field called email.

tsuru will also make call this URL on every request to the API to make sure the token is still valid and hasn’t been revoked.

auth:oauth:collection¶

The database collection used to store valid access tokens. Defaults to “oauth_tokens”.

auth:oauth:callback-port¶

The port used in the callback URL during the authorization step. Check docs for auth:oauth:auth-url for more details.

queue configuration¶

tsuru uses a work queue for asynchronous tasks.

Currently, tsuru supports only redis as queue backend. Creating a new queue provider is as easy as implementing an interface.

queue¶

queue is the name of the queue implementation that tsuru will use. This setting defaults to redis.

redis-queue:host¶

redis-queue:host is the host of the Redis server to be used for the working queue. This settings is optional and defaults to “localhost”.

redis-queue:port¶

redis-queue:port is the port of the Redis server to be used for the working queue. This settings is optional and defaults to 6379.

redis-queue:password¶

redis-queue:password is the password of the Redis server to be used for the working queue. This settings is optional and defaults to “”, indicating that the Redis server is not authenticated.

redis-queue:db¶

redis-queue:db is the database number of the Redis server to be used for the working queue. This settings is optional and defaults to 3.

Admin users¶

tsuru has a very simple way to identify admin users: an admin user is a user that is the member of the admin team, and the admin team is defined in the configuration file, using the admin-team setting.

admin-team¶

admin-team is the name of the administration team for the current tsuru installation. All members of the administration team is able to use the tsuru-admin command.

Quota management¶

tsuru can, optionally, manage quotas. Currently, there are two available quotas: apps per user and units per app.

tsuru administrators can control the default quota for new users and new apps in the configuration file, and use tsuru-admin command to change quotas for users or apps. Quota management is disabled by default, to enable it, just set the desired quota to a positive integer.

quota:units-per-app¶

quota:units-per-app is the default value for units per-app quota. All new apps will have at most the number of units specified by this setting. This setting is optional, and defaults to “unlimited”.

quota:apps-per-user¶

quota:apps-per-user is the default value for apps per-user quota. All new users will have at most the number of apps specified by this setting. This setting is optional, and defaults to “unlimited”.

Log¶

debug¶

false is the default value, so you won’t see any noises on logs, to turn it on set it to true, e.g.: debug: true

log:file¶

Use this to specify a path to a log file. By default tsuru logs to syslog. If this is set, make sure tsuru has permissions to write to this file

Hipache¶

hipache:redis-server¶

Redis server used by Hipache router. This same server (or a redis slave of it), must be configured in your hipache.conf file.

hipache:domain¶

The domain of the server running your hipache server. Applications created with tsuru will have a address of http://<app-name>.<hipache:domain>

Defining the provisioner¶

tsuru has extensible support for provisioners. A provisioner is a Go type that satisfies the provision.Provisioner interface. By default, tsuru will use DockerProvisioner (identified by the string “docker”), and now that’s the only supported provisioner (Ubuntu Juju was supported in the past but its support has been removed from tsuru).

provisioner¶

provisioner is the string the name of the provisioner that will be used by tsuru. This setting is optional and defaults to “docker”.

Docker provisioner configuration¶

docker:collection¶

Database collection name used to store containers information.

docker:registry¶

For tsuru to work with multiple docker nodes, you will need a docker-registry. This should be in the form of hostname:port.

docker:repository-namespace¶

Docker repository namespace to be used for application and platform images. Images will be tagged in docker as <docker:repository-namespace>/<platform-name> and <docker:repository-namespace>/<app-name>

docker:router¶

Router to be used to distribute requests to units. Right now only hipache is supported.

docker:deploy-cmd¶

The command that will be called in your platform when a new deploy happens. The default value for platforms supported in tsuru’s basebuilder repository is /var/lib/tsuru/deploy.

docker:segregate¶

Enable segregate scheduler. See Segregate Scheduler for details.

docker:scheduler:total-memory-metadata¶

Only valid if docker:segregate is true. This value describes which metadata key will describe the total amount of memory, in bytes, available to a docker node.

docker:scheduler:max-used-memory¶

Only valid if docker:segregate is true. This should be a value between 0.0 and 1.0 which describes which fraction of the total amount of memory available to a server should be reserved for app units.

The amount of memory available is found based on the node metadata described by docker:scheduler:total-memory-metadata config setting.

If this value is set, tsuru will only allow the creation of new units if there is at least one server with enough unreserved memory to fit the amount of memory needed by the unit, based on which plan was used to create the application.

docker:cluster:storage¶

This setting has been removed. You shouldn’t define it anymore, the only storage available for the docker cluster is now mongodb.

docker:cluster:mongo-url¶

Connection URL to the mongodb server used to store information about the docker cluster.

docker:cluster:mongo-database¶

Database name to be used to store information about the docker cluster.

docker:run-cmd:bin¶

The command that will be called on the application image to start the application. The default value for platforms supported in tsuru’s basebuilder repository is /var/lib/tsuru/start.

docker:run-cmd:port¶

The tcp port that will be exported by the container to the node network. The default value expected by platforms defined in tsuru’s basebuilder repository is 8888.

docker:ssh:add-key-cmd¶

The command that will be called with the ssh public key created for the application. This allows us to connect directly to a running container using ssh. The value expected for basebuilder platforms is /var/lib/tsuru/add-key.

docker:ssh:public-key¶

Deprecated. You shouldn’t set this value anymore.

docker:ssh:user¶

The user used to connect via ssh to running containers. The value expected for basebuilder platforms is ubuntu.

docker:healing:heal-nodes¶

Boolean value that indicates whether tsuru should try to heal nodes that have failed a specified number of times. Healing nodes is only available if the node was created by tsuru itself using the IaaS configuration. Defaults to false.

docker:healing:active-monitoring-interval¶

Number of seconds between calls to <server>/_ping in each one of the docker nodes. If this value is 0 or unset tsuru will never call the ping URL. Defaults to 0.

docker:healing:disabled-time¶

Number of seconds tsuru disables a node after a failure. This setting is only valid if heal-nodes is set to true. Defaults to 30 seconds.

docker:healing:max-failures¶

Number of consecutive failures a node should have before triggering a healing operation. Only valid if heal-nodes is set to true. Defaults to 5.

docker:healing:wait-new-time¶

Number of seconds tsuru should wait for the creation of a new node during the healing process. Only valid if heal-nodes is set to true. Defaults to 300 seconds (5 minutes).

docker:healing:heal-containers-timeout¶

Number of seconds a container should be unresponsive before triggering the recreation of the container. A container is deemed unresponsive if it doesn’t call the set unit status URL (/apps/{app}/units/{unit}) with a started status. If this value is 0 or unset tsuru will never try to heal unresponsive containers. Defaults to 0.

docker:healing:events_collection¶

Collection name in mongodb used to store information about triggered healing events. Defaults to healing_events.

docker:healthcheck:max-time¶

Maximum time in seconds to wait for deployment time health check to be successful. Defaults to 120 seconds.

IaaS configuration¶

tsuru uses IaaS configuration to automatically create new docker nodes and adding them to your cluster when using docker-node-add command. See adding nodes for more details about how to use this command.

General settings¶

iaas:default¶

The default IaaS tsuru will use when calling docker-node-add without specifying iaas=<iaas_name> as a metadata. Defaults to ec2.

iaas:node-protocol¶

Which protocol to use when accessing the docker api in the created node. Defaults to http.

iaas:node-port¶

In which port the docker API will be accessible in the created node. Defaults to 2375.

iaas:collection¶

Collection name on database containing information about created machines. Defaults to iaas_machines.

EC2 IaaS¶

iaas:ec2:key-id¶

Your AWS key id.

iaas:ec2:secret-key¶

Your AWS secret key.

iaas:ec2:user-data¶

A url for which the response body will be sent to ec2 as user-data. Defaults to a script which will run tsuru now installation.

iaas:ec2:wait-timeout¶

Number of seconds to wait for the machine to be created. Defaults to 300 (5 minutes).

CloudStack IaaS¶

iaas:cloudstack:api-key¶

Your api key.

iaas:cloudstack:secret-key¶

Your secret key.

iaas:cloudstack:url¶

The url for the cloudstack api.

iaas:cloudstack:user-data¶

A url for which the response body will be sent to cloudstack as user-data. Defaults to a script which will run tsuru now installation.

Custom IaaS¶

You can define a custom IaaS based on an existing provider. Any configuration keys with the format iaas:custom:<name> will create a new IaaS with name.

iaas:custom:<name>:provider¶

The base provider name, it can be one of the supported providers: cloudstack or ec2.

iaas:custom:<name>:<any_other_option>¶

This will overwrite the value of iaas:<provider>:<any_other_option> for this IaaS. As an example, having the configuration bellow would allow you to call tsuru-admin docker-node-add iaas=region1_cloudstack ...:

iaas:
    custom:
        region1_cloudstack:
            provider: cloudstack
            url: http://region1.url/
            secret-key: mysecretkey
    cloudstack:
        api-key: myapikey

Sample file¶

Here is a complete example:

listen: "0.0.0.0:8080"
debug: true
host: http://<machine-public-addr>:8080 # This port must be the same as in the "listen" conf
admin-team: admin
auth:
    user-registration: true
    scheme: native
database:
    url: <your-mongodb-server>:27017
    name: tsurudb
queue: redis
redis-queue:
    host: <your-redis-server>
    port: 6379
git:
    unit-repo: /home/application/current
    api-server: http://<your-gandalf-server>:8000
provisioner: docker
docker:
    segregate: false
    router: hipache
    collection: docker_containers
    repository-namespace: tsuru
    deploy-cmd: /var/lib/tsuru/deploy
    cluster:
        storage: mongodb
        mongo-url: <your-mongodb-server>:27017
        mongo-database: cluster
    run-cmd:
        bin: /var/lib/tsuru/start
        port: "8888"
    ssh:
        add-key-cmd: /var/lib/tsuru/add-key
        user: ubuntu
hipache:
    domain: <your-hipache-server-ip>.xip.io
    redis-server: <your-redis-server-with-port>