tsuru-feaas 0.10.0

Frontend as-a-service API for Tsuru PaaS

Deploying the API

First, let’s create an app in tsuru, from the project root, execute the following:

% tsuru app-create varnishapi python
% git remote add tsuru [e-mail]
% git push tsuru master

The push will return an error telling you that you can’t push code before the app unit is up, wait until your unit is in service, you can check with:

% tsuru app-list

When you get an output like this you can proceed to push.

+-------------+-------------------------+--------------------------------------+
| Application | Units State Summary     | Address                              |
+-------------+-------------------------+--------------------------------------+
| your-app    | 1 of 1 units in-service | your-app.sa-east-1.elb.amazonaws.com |
+-------------+-------------------------+--------------------------------------+

Now if you access our app endpoint at “/” (you can check with tsuru app-info cmd) you should get a 404, which is right, since the API does not respond through this url.

Alright, let’s configure the application, it’ll need to talk with EC2 API, and it does so by using environment variables. Here’s what you need:

% tsuru env-set EC2_ENDPOINT=https://ec2.amazonaws.com EC2_ACCESS_KEY=your-access-key EC2_SECRET_KEY=your-secret-key

In order to get Varnish running, you can provide an AMI or a list of packages to install via user data. The AMI is specified via the AMI_ID environment variable, while the packages are specified by the API_PACKAGES environment variable. Users may specify both variables.

% tsuru env-set AMI_ID=your-ami-id API_PACKAGES=varnish vim-nox

You can also use a custom user-data url via USER_DATA_URL intead of API_PACKAGES. In this case, the return content body should contain VARNISH_SECRET_KEY word which will be replaced by proper varnish secret on remote machine.

% tsuru env-set AMI_ID=your-ami-id USER_DATA_URL=http://server/custom-user-data

Users may also specify a subnet for running with VPC. You can specify the subnet ID via the SUBNET_ID environment variable.

% tsuru env-set SUBNET_ID=your-subnet-id

One more thing: this API will use MongoDB to store information about instances, the MongoDB endpoint and the database name is also controlled via environment variables:

We’re done with our API! Let’s create the service in Tsuru.

Creating the Service

First you’ll have to change the manifest.yaml file located at the project root of our application. Change the production endpoint to point to the application address, your yaml should look like this:

id: varnish
password: some123
endpoint:
  production: varnishapi-endpoint.com

Now let’s tell tsuru it needs to registrate a new service, from the project root run, using crane:

% crane create manifest.yaml

And we’re done!