Hello Teresa

A collection of Hello World ready to deploy on teresa PaaS.

Deploy

Some information to get your application up and running on Kubernetes with Teresa.

Port

Don't listen on a hardcoded port, but instead read the port from the environment variable PORT. For instance:

port := os.Getenv("PORT")
if port == "" {
    port = "5000"
}
http.ListenAndServe(fmt.Sprintf(":%s", port), nil)

The deploy process will set this variable

Procfile

According to Heroku's docs:

A Procfile is a mechanism for declaring what commands are run by your application’s
dynos on the Heroku platform.

Teresa follows the same principle. As an example, a Python application might have the following command on Procfile:

web: gunicorn -b 0.0.0.0:$PORT -w 3 --pythonpath src myapp.wsgi

Language detection

When you deploy an app using Teresa, you don't have to specify your application's language - it'll be automatically detected.

This step it's based on Heroku's build packs.

Golang

Teresa will detect your application as Golang if you're using one of theses depedencies managers:

If you don't need to deal with third party libs you just need to drop a simple vendor/vendor.json file in the root dir of your application, for instance:

{
  "comment": "",
  "ignore": "test",
  "package": [],
  "rootPath": "github.com/luizalabs/hello-teresa"
}

Python

To deploy a Python application on Teresa a requirements.txt file must be present in the root dir of your application.
The version of Python runtime can be specified with a runtime.txt file in the root dir, for instance:

$ cat runtime.txt
python-3.6.0

NodeJS

Teresa will detect your application as NodeJS when the application has a package.json file in the root dir.
If no Procfile is present in the root directory of your application during the build step, your web process will be started by running npm start, a script you can specify in package.json, for instance:

  "scripts": {
    "start": "node server.js"
  },

Multi-language

Teresa allows multiples deploy processes in a single one. It's useful for example, in cases that you need to transpile the project assets with webpack and run a Python server.
To deploy a multi-language application on Teresa, a .buildpacks file must be present in the root dir of your application. In this file you need to specify the buildpacks that you want to build your project.
For instance:

.buildpacks

https://github.com/heroku/heroku-buildpack-nodejs.git
https://github.com/heroku/heroku-buildpack-python.git

package.json

{
  "name": "multi-language-teresa-hello-world",
  "scripts": {
    "postinstall": "node_modules/webpack/bin/webpack.js",
    "webpack": "node_modules/webpack/bin/webpack.js --progress --colors --watch"
  },
  "dependencies": {
    "webpack": "^1.12.13"
  }
}

requirements.txt

Django==1.9.2
gunicorn==19.4.5

Procfile

web: gunicorn -b 0.0.0.0:$PORT -w 3 --pythonpath src hello_world.wsgi

Teresa will run the nodejs and python build processes in this order.

.teresaignore

A .teresaignore file specifies intentionally files that Teresa should ignore.
Each line in a .teresaignore file specifies a pattern (glob), blank lines are ignored, e.g.

.git
node_modules/

*_tests
*.pyc

teresa.yaml

Some features can be configured in a file called teresa.yaml in the the root dir of application.

Check a complete example here

Health Check

Kubernetes has two types of health checks, the Readiness and the Liveness.

Readiness: Based on the time of "boot" of application, the Kubernetes uses this configuration to know when container is ready to start accepting traffic.
Liveness: Conventional health check, the Kubernetes uses this configuration to know when to restart a container.

You can set both (readiness and liveness) for your application in section healthCheck of the teresa.yaml, for instance:

healthCheck:
    liveness:
        path: /healthcheck/
        timeoutSeconds: 5
        initialDelaySeconds: 10
        periodSeconds: 5
        failureThreshold: 5
        successThreshold: 1
    readiness:
        path: /healthcheck/
        timeoutSeconds: 2
        initialDelaySeconds: 5
        periodSeconds: 5
        failureThreshold: 2
        successThreshold: 1

Teresa only perform health check based on HTTP GET request.

path: endpoint of application than health check should hit.
timeoutSeconds: timeout to determine if the application is unhealthy.
initialDelaySeconds: delay (in seconds) to start to perform the execution of health check.
periodSeconds: delay between checks.
failureThreshold: max failure tolerance before restart the container.
successThreshold: min number of success to determina that container it's healthy.

Any code greater than or equeal to 200 and less than 400 indicates success. Any other code indicates failure.

Rolling Update

Kubernetes has the Rolling Update strategy to deal with deploys. With this strategy you can specify the max unavailable and the max surge fields to control the rolling update process.
You can set both (maxUnavailable and maxSurge) for the deploy of your application in section RollingUpdate of the teresa.yaml, for instance:

rollingUpdate:
    maxUnavailable: "30%"
    maxSurge: "2"

Max Unavailable: Specifies the maximum number of pods can be unavailable during the update process.
Max Surge: Specifies the maximyum number of pods can be created above the desired number of pods.

This field can be an absolute number (e.g. "2") or a percentage (e.g. "30%").

luizalabs / hello-teresa