Resources Models Clients

Ionroller API 0.0.1-dev

History | Watch

Software Delivery System for Docker Images

  • Contact: N/A
  • License: N/A

Resources

service

Operations

Method and Path Description
GET /services

Lists all services
GET /services/:serviceName

Returns service state (current and desired)
PUT /services/:serviceName/config

Creates or updates service configuration
GET /services/:serviceName/config

Returns service configuration
POST /services/:serviceName/release

Requests a new release
POST /services/:serviceName/drop

Drops a release
POST /services/:serviceName/reset

Reset state (no environments required)

Headers

No headers

Imports

No imports

Enums

No enums

Interfaces

No interfaces

Models

eb_config

Example Json: Minimal | Full

Interfaces: None

Elastic Beanstalk configuration including deployment bucket, stack name and option settings

Field Type Required? Default Description
deployment_bucket string Yes -

Deployment bucket used to deploy Elastic Beanstalk applications
stack string No -

Solution stack name (i.e. 64bit Amazon Linux 2014.09 v1.0.10 running Docker 1.3.2)
settings [option_setting] Yes -

Elastic Beanstalk configuration option settings, see http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html

environment

Example Json: Minimal | Full

Interfaces: None

Elastic Beanstalk Environment running in AWS

Field Type Required? Default Description
release release Yes -

Details of the release present in the environment
health string Yes -

Health of environment

option_setting

Example Json: Minimal | Full

Interfaces: None

Elastic Beanstalk configuration option setting

Field Type Required? Default Description
Namespace string Yes -

OptionName string Yes -

Value string Yes -

port_mapping

Example Json: Minimal | Full

Interfaces: None

Mapping from port in Docker container to external host port

Field Type Required? Default Description
internal integer Yes -

Port to be forwarded from Docker container
external integer Yes -

Port to be mapped to on external hosts

release

Example Json: Minimal | Full

Interfaces: None

A release of a particular tag of a Docker image

Field Type Required? Default Description
image string Yes -

The Docker repository and name of images to be released
tag string Yes -

The tag for the image to be released

rollout

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
next release Yes -

percentage integer Yes -

service

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string Yes -

state service_state Yes -

service_config

Example Json: Minimal | Full

Interfaces: None

Configuration used by a service

Field Type Required? Default Description
url string Yes -

URL of endpoint pointing at service
hosted_zone_id string Yes -

Hosted Zone ID for DNS entry
ionroller_role_arn string No -

Role used to manage (deploy) this service
service_role string No -

Role used to run this service; specifies policy for accessing S3, RDS, DynamoDb etc.
image string Yes -

Docker image details used in deployments
port_mappings [port_mapping] Yes -

List of port mappings configured for use by Docker image
run_args [string] Yes -

Arguments passed to running Docker image
eb eb_config Yes -

Elastic Beanstalk configuration including deployment bucket, stack name and option settings like env variables, vpc, security groups etc.
remove_unused_after_minutes long No -

When an environment becomes unused, remove it after the specified number of minutes

service_current_state

Example Json: Minimal | Full

Interfaces: None

Current state of service environments

Field Type Required? Default Description
environments [environment] Yes -

List of environments and their current status

service_desired_state

Example Json: Minimal | Full

Interfaces: None

Desired future state of service

Field Type Required? Default Description
current release Yes -

Current release of software
rollout rollout No -

Details of desired rollout

service_state

Example Json: Minimal | Full

Interfaces: None

State of service environments

Field Type Required? Default Description
current service_current_state Yes -

List of environments and their current status
desired service_desired_state No -

List of environments and their desired status

Unions

No unions

Annotations

No annotations