Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
321 lines (166 sloc) 5.73 KB

Waitron

Templates for server provisioning

Table of Contents

  1. Put the server in build mode
  2. Removes the server from build mode
  3. List machines handled by waitron
  4. Build status of the server
  5. Renders either the finish or the preseed template
  6. Dictionary with kernel, intrd(s) and commandline for pixiecore

build

Specification Value
Resource Path /build
API Version
BasePath for the API {{.}}
Consumes
Produces

Operations

Resource Path Operation Description
build/{hostname} PUT Put the server in build mode

API: build/{hostname} (PUT)

Put the server in build mode

Param Name Param Type Data Type Description Required?
hostname path string Hostname Yes
Code Type Model Message
200 object string OK
500 object string Unable to find host definition for hostname
500 object string Failed to set build mode on hostname

Models

done

Specification Value
Resource Path /done
API Version
BasePath for the API {{.}}
Consumes
Produces

Operations

Resource Path Operation Description
/done/{hostname}/{token} GET Removes the server from build mode

API: /done/{hostname}/{token} (GET)

Removes the server from build mode

Param Name Param Type Data Type Description Required?
hostname path string Hostname Yes
token path string Token Yes
Code Type Model Message
200 object string OK
500 object string Unable to find host definition for hostname
500 object string Failed to cancel build mode
401 object string Invalid token

Models

list

Specification Value
Resource Path /list
API Version
BasePath for the API {{.}}
Consumes
Produces

Operations

Resource Path Operation Description
/list GET List machines handled by waitron

API: /list (GET)

List machines handled by waitron

Code Type Model Message
200 array string List of machines
500 object string Unable to list machines

Models

status

Specification Value
Resource Path /status
API Version
BasePath for the API {{.}}
Consumes
Produces

Operations

Resource Path Operation Description
/status/{hostname} GET Build status of the server
/status GET Dictionary with machines and its status

API: /status/{hostname} (GET)

Build status of the server

Param Name Param Type Data Type Description Required?
hostname path string Hostname Yes
Code Type Model Message
200 object string The status: (installing or installed)
500 object string Unknown state

API: /status (GET)

Dictionary with machines and its status

Code Type Model Message
200 object string Dictionary with machines and its status

Models

template

Specification Value
Resource Path /template
API Version
BasePath for the API {{.}}
Consumes
Produces

Operations

Resource Path Operation Description
/template/{template}/{hostname}/{token} GET Renders either the finish or the preseed template

API: /template/{template}/{hostname}/{token} (GET)

Renders either the finish or the preseed template

Param Name Param Type Data Type Description Required?
hostname path string Hostname Yes
template path string The template to be rendered Yes
token path string Token Yes
Code Type Model Message
200 object string Rendered template
400 object string Unable to find host definition for hostname
400 object string Unable to render template
401 object string Invalid token

Models

v1

Specification Value
Resource Path /v1
API Version
BasePath for the API {{.}}
Consumes
Produces

Operations

Resource Path Operation Description
/v1/boot/{macaddr} GET Dictionary with kernel, intrd(s) and commandline for pixiecore

API: /v1/boot/{macaddr} (GET)

Dictionary with kernel, intrd(s) and commandline for pixiecore

Param Name Param Type Data Type Description Required?
macaddr path string MacAddress Yes
Code Type Model Message
200 object string Dictionary with kernel, intrd(s) and commandline for pixiecore
404 object string Not in build mode
500 object string Unable to find host definition for hostname

Models