Metadata format

Syntax

Configuration file uses YAML syntax.

Distribution specific settings, currently only list of packages to install can be configured here.
< id > is the id of the distribution same as output of lsb_release -si command.
os:
  < id >:
    packages:
      - < package name >
Configuration for interpreter used in application.
type can be any supported type (python, ruby, php).
You can provide list of interpreter versions supported by your application, highest supported version will be used.
settings key allows to pass interpreter specific options, uPaaS administator should document what options are avilable here.
By default only module option for python interpreter can be set under settings key, uPaaS administrator might add support for more options.
interpreter:
  type: < type >
  versions:
    - < version >
    - < version >
  settings:
    < interpreter settings >

Configuration for repository life cycle management:

  • clone - how to clone repository, allowed variables: %destination% - path where application should be cloned to
  • update - how to fetch updates
  • info - how to obtain informations about this repository (latest commit), not used yet
  • changelog - how to generate list of changes since last commit, allowed variables - %old%, %new% - id of old and new commit id, not used yet
repository:
  clone: < command to clone application repository >
  update:
    - < command >
    - < command >
  info: < command >
  changelog: < command >

List of environment variables that should be set for this application, optional.

env:
  MYENV: value

After cloning repository multiple actions needs to be executed in order to deploy application, see Package building internals for details.

actions:
  setup:
    main:
      - < command >
      - < command >

List of files to create after cloning app repository.

files:
  < path>: < content >
Under uwsgi key you can pass additional settings to uWSGI.
uPaaS administrator might limit options that can be set here, unsupported options will be ignored.
uwsgi:
  settings:
    - "option = value"

Example

See Example metadata

Read the Docs v: v0.2.1
Versions
latest
v0.2.1
v0.2.0
v0.1
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.