README
¶
tsuru
What is tsuru?
tsuru is an extensible and open source Platform as a Service (PaaS) that makes application deployments faster and easier. With tsuru, you don’t need to think about servers at all. As an application developer, you can:
- Write apps in the programming language of your choice
- Back apps with add-on resources such as SQL and NoSQL databases, including memcached, Redis, and many others
- Manage apps using the
tsurucommand-line tool - Deploy apps using the Git version control system
Links:
- Full Documentation: https://docs.tsuru.io
- How to Contribute: https://docs.tsuru.io/stable/contributing/
- Repository & Issue Tracker: https://github.com/tsuru/tsuru
- Talk to us on Gitter: https://gitter.im/tsuru/tsuru
Quick Start
With the purpose of testing tsuru and/or for development, you can use the installer to have tsuru up and running. The installer is an experimental feature.
From Binary
Getting tsuru-client
Download the latest release for your platform at: https://github.com/tsuru/tsuru-client/releases/
Example for release 1.1.1 and OS X.
$ curl -sSL https://github.com/tsuru/tsuru-client/releases/download/1.1.1/tsuru-1.1.1-darwin_amd64.tar.gz | tar xz
Call tsuru installer
$ tsuru install create
From Source
Getting tsuru-client
You need to have Go properly installed on your machine.
$ git clone github.com/tsuru/tsuru-client $GOPATH/src/github.com/tsuru/tsuru-client
$ cd $GOPATH/src/github.com/tsuru/tsuru-client
$ make install
Create an installer config
Create the tsuru installer config files with:
$ tsuru install config init
Replace the tsuru API image tag with the latest tag in install-compose.yml:
$ sed -i'' -e 's/api:v1/api:latest/g' install-compose.yml
Call tsuru installer
$ $GOPATH/bin/tsuru install create -c install-config.yml -e install-compose.yml
Testing
If everything's gone well you have the tsuru running in a VirtualBox VM.
Call app-list to see tsuru working, this command needs to return one app called tsuru-dashboard.
$ tsuru app-list
Directories
¶
| Path | Synopsis |
|---|---|
|
Package action implements atomic pipeline execution of actions.
|
Package action implements atomic pipeline execution of actions. |
|
Package api implements the REST api for tsuru.
|
Package api implements the REST api for tsuru. |
|
apitest
Package testing provides test helpers for various actions.
|
Package testing provides test helpers for various actions. |
|
bind
Package bind provides interfaces and types for use when binding an app to a service.
|
Package bind provides interfaces and types for use when binding an app to a service. |
|
Package db encapsulates tsuru connection with MongoDB.
|
Package db encapsulates tsuru connection with MongoDB. |
|
dbtest
Package dbtest provides utilities test functions and types for interacting with the database during tests.
|
Package dbtest provides utilities test functions and types for interacting with the database during tests. |
|
Package errors provides facilities with error handling.
|
Package errors provides facilities with error handling. |
|
Package exec provides a interface to run external commands as an abstraction layer.
|
Package exec provides a interface to run external commands as an abstraction layer. |
|
exectest
Package exectest provides fake implementations of the exec package.
|
Package exectest provides fake implementations of the exec package. |
|
Package fs provides types and methods for interacting with the filesystem, as an abstraction layer.
|
Package fs provides types and methods for interacting with the filesystem, as an abstraction layer. |
|
fstest
Package fstest provides fake implementations of the fs package.
|
Package fstest provides fake implementations of the fs package. |
|
Package git provides types and utilities for dealing with Git repositories.
|
Package git provides types and utilities for dealing with Git repositories. |
|
Package hc provides a basic type for generic checks.
|
Package hc provides a basic type for generic checks. |
|
Package iaas provides interfaces that need to be satisfied in order to implement a new iaas on tsuru.
|
Package iaas provides interfaces that need to be satisfied in order to implement a new iaas on tsuru. |
|
testapps/https-healthcheck
Generate a self-signed X.509 certificate for a TLS server.
|
Generate a self-signed X.509 certificate for a TLS server. |
|
Package log provides logging utility.
|
Package log provides logging utility. |
|
Package migration provides a "micro-framework" for migration management: each migration is a simple function that returns an error.
|
Package migration provides a "micro-framework" for migration management: each migration is a simple function that returns an error. |
|
Package provision provides interfaces that need to be satisfied in order to implement a new provisioner on tsuru.
|
Package provision provides interfaces that need to be satisfied in order to implement a new provisioner on tsuru. |
|
docker
Package docker provides a provisioner implementation that use Docker containers.
|
Package docker provides a provisioner implementation that use Docker containers. |
|
Package queue implements a Pub/Sub channel in tsuru.
|
Package queue implements a Pub/Sub channel in tsuru. |
|
Package quota provides primitives for quota management in tsuru.
|
Package quota provides primitives for quota management in tsuru. |
|
Package repository contains types and functions for git repository interaction.
|
Package repository contains types and functions for git repository interaction. |
|
gandalf
Package gandalf provides an implementation of the RepositoryManager, that uses Gandalf (https://github.com/tsuru/gandalf).
|
Package gandalf provides an implementation of the RepositoryManager, that uses Gandalf (https://github.com/tsuru/gandalf). |
|
repositorytest
Package repositorytest provides a fake repository manager for use in tests.
|
Package repositorytest provides a fake repository manager for use in tests. |
|
Package router provides interfaces that need to be satisfied in order to implement a new router on tsuru.
|
Package router provides interfaces that need to be satisfied in order to implement a new router on tsuru. |
|
hipache
Package hipache provides a router implementation that store routes in Redis, as specified by Hipache (https://github.com/dotcloud/hipache).
|
Package hipache provides a router implementation that store routes in Redis, as specified by Hipache (https://github.com/dotcloud/hipache). |
|
Package safe provides some thread safe types, wrapping builtin types.
|
Package safe provides some thread safe types, wrapping builtin types. |
|
Package tsurutest provides test utilities used across tsuru code base.
|
Package tsurutest provides test utilities used across tsuru code base. |
|
types
|
|
|
Package validation provide utilities functions for data validation.
|
Package validation provide utilities functions for data validation. |
Click to show internal directories.
Click to hide internal directories.