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
Links:
- Landing page: https://tsuru.io
- Full Documentation: https://docs.tsuru.io/main/
- 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
Popular platforms supported:
Quick Start
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
Install Guides
Testing
If everything's gone well you have the tsuru running in a Kubernetes Cluster.
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 hc provides a basic type for generic checks.
|
Package hc provides a basic type for generic checks. |
|
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. |
|
kubernetes/pkg/apis/tsuru/v1
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
|
kubernetes/pkg/client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
kubernetes/pkg/client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
kubernetes/pkg/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
kubernetes/pkg/client/clientset/versioned/typed/tsuru/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
kubernetes/pkg/client/clientset/versioned/typed/tsuru/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
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. |
|
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.