• Getting started
  • With EC2
  • With Rackspace
  • With Eucalyptus
  • With OpenStack
  • With OVH/OpenStack
  • With Docker
  • With Xen/KVM/VMWare
  • With bare-metal using gPXE
• Tutorials
  • Writing an application template
  • Using the command-line interface
• User Guide
  • Introduction
  • Fundamental Concepts
  • Architecture
• API
  • Overview
  • Interactions
  • Resources
  • Services
  • Template Rendering
  • Schemas
  • Python Library
• Other
  • Frequently Asked Questions
  • Support

Settings

A setting represents a particular value to set to a variable. In particular, template variables.

Settings may be associated to an organization, an environment, a host, a platform, a distribution, an application context, a distribution context, and a platform context.

The value of a setting may be a string or a more complex object (array, dictionary, etc.) that can be represented using JSON.

Updating, deleting or removing a setting may trigger operations on host instances. The operations are described by application handlers.

Representation

The following elements are defined as part of a setting:

• key: The name of target variable.
• value: The value of simple setting.

Example

Simple setting

{
    "key": "httpd_port",
    "value": "8080"
}

Complex value setting

{
    "key": "employees",
    "value": [
        {
            "name" : "Gérard Dethier",
            "function" : "Software engineer"
        }
    ]
}

Methods

Settings are part of a sub-collection, below URLs are therefore relative.

Collection

settings

• GET: returns the list of settings.
• POST: adds a new setting.

Entity

settings/{setting_key}

• GET: returns the setting.
• PUT: updates the setting.
• DELETE: removes the setting.