vmpooler/docs/API.md at a1ec332ffee26951d40dda9ffb19a0ab01b8ec95

puppetlabs/vmpooler

Fork 0

mirror of https://github.com/puppetlabs/vmpooler.git synced 2026-01-26 01:58:41 -05:00

Samuel Beaulieu a34777185d (POOLER-37) Document HTTP responses

2018-10-25 11:02:57 -03:00

17 KiB

Raw Blame History

API
Token operations
VM operations
Add disks
VM snapshots
Status and metrics
Pool configuration

API

vmpooler provides a REST API for VM management. The following examples use curl for communication.

Token operations

Token-based authentication can be used when requesting or modifying VMs. The /token route can be used to create, query, or delete tokens. See the provided YAML configuration example, vmpooler.yaml.example, for information on configuring an authentication store to use when performing token operations.

GET /token

Get a list of issued tokens.

Return codes:

200 OK
401 when not authorized
404 when config:auth not found or other error

$ curl -u jdoe --url vmpooler.example.com/api/v1/token
Enter host password for user 'jdoe':

{
    "ok": true,
    "utpg2i2xswor6h8ttjhu3d47z53yy47y": {
      "created": "2015-04-28 19:17:47 -0700"
    }
}

POST /token

Generate a new authentication token.

Return codes:

200 OK
401 when not authorized
404 when config:auth not found

$ curl -X POST -u jdoe --url vmpooler.example.com/api/v1/token
Enter host password for user 'jdoe':

{
    "ok": true,
    "token": "utpg2i2xswor6h8ttjhu3d47z53yy47y"
}

GET /token/<token>

Get information about an existing token (including associated VMs).

Return codes:

200 OK
404 when config:auth or token not found

$ curl --url vmpooler.example.com/api/v1/token/utpg2i2xswor6h8ttjhu3d47z53yy47y

{
  "ok": true,
  "utpg2i2xswor6h8ttjhu3d47z53yy47y": {
    "user": "jdoe",
    "created": "2015-04-28 19:17:47 -0700",
    "last": "2015-11-04 12:28:37 -0700",
    "vms": {
      "running": [
        "dqs4914g2wjyy5w",
        "hul7ib0ssr0f4o0"
      ]
    }
  }
}

DELETE /token/<token>

Delete an authentication token.

Return codes:

200 OK
401 when not authorized
404 when config:auth not found

$ curl -X DELETE -u jdoe --url vmpooler.example.com/api/v1/token/utpg2i2xswor6h8ttjhu3d47z53yy47y
Enter host password for user 'jdoe':

{
  "ok": true
}

VM operations

GET /vm

Retrieve a list of available VM pools.

Return codes:

200 OK

$ curl --url vmpooler.example.com/api/v1/vm

[
  "debian-7-i386",
  "debian-7-x86_64"
]

POST /vm

Useful for batch operations; post JSON (see format below), get back allocated VMs.

If an authentication store is configured, an authentication token supplied via the X-AUTH-TOKEN HTTP header will modify a VM's default lifetime. See the provided YAML configuration example, vmpooler.yaml.example, and the 'token operations' section above for more information.

Return codes:

200 OK
404 when sending invalid JSON in the request body or requesting an invalid VM pool name

$ curl -d '{"debian-7-i386":"2","debian-7-x86_64":"1"}' --url vmpooler.example.com/api/v1/vm

{
  "ok": true,
  "debian-7-i386": {
    "hostname": [
      "o41xtodlvnvu5cw",
      "khirruvwfjlmx3y"
    ]
  },
  "debian-7-x86_64": {
    "hostname": "y91qbrpbfj6d13q"
  },
  "domain": "example.com"
}

NOTE: Returns either all requested VMs or no VMs.

POST /vm/<pool>

Check-out a VM or VMs.

Return codes:

200 OK
404 when sending invalid JSON in the request body or requesting an invalid VM pool name

$ curl -d --url vmpooler.example.com/api/v1/vm/debian-7-i386

{
  "ok": true,
  "debian-7-i386": {
    "hostname": "fq6qlpjlsskycq6"
  },
  "domain": "example.com"
}

Multiple VMs can be requested by using multiple query parameters in the URL:

$ curl -d --url vmpooler.example.com/api/v1/vm/debian-7-i386+debian-7-i386+debian-7-x86_64

{
  "ok": true,
  "debian-7-i386": {
    "hostname": [
      "sc0o4xqtodlul5w",
      "4m4dkhqiufnjmxy"
    ]
  },
  "debian-7-x86_64": {
    "hostname": "zb91y9qbrbf6d3q"
  },
  "domain": "example.com"
}

NOTE: Returns either all requested VMs or no VMs.

GET /vm/<hostname>

Query metadata information for a checked-out VM.

Return codes:

200 OK
404 when requesting an invalid VM hostname

$ curl --url vmpooler.example.com/api/v1/vm/pxpmtoonx7fiqg6

{
  "ok": true,
  "pxpmtoonx7fiqg6": {
    "template": "centos-6-x86_64",
    "lifetime": 12,
    "running": 3,
    "remaining": 9, 
    "state": "running",
    "tags": {
      "department": "engineering",
      "user": "jdoe"
    },
    "ip": "192.168.0.1",
    "domain": "example.com"
  }
}

PUT /vm/<hostname>

Modify a checked-out VM.

The following are valid PUT parameters and their required data structures:

parameter	description	required structure
lifetime	VM TTL (in hours)	integer
tags	free-form VM tagging	hash

Any modifications can be verified using the GET /vm/<hostname> endpoint.

If an authentication store is configured, an authentication token is required (via the X-AUTH-TOKEN HTTP header) to access this route. See the provided YAML configuration example, vmpooler.yaml.example, and the 'token operations' section above for more information.

Return codes:

200 OK
401 when you need an auth token
404 when requesting an invalid VM hostname
400 when supplied PUT parameters fail validation

$ curl -X PUT -d '{"lifetime":"2"}' --url vmpooler.example.com/api/v1/vm/fq6qlpjlsskycq6

{
  "ok": true
}

$ curl -X PUT -d '{"tags":{"department":"engineering","user":"jdoe"}}' --url vmpooler.example.com/api/v1/vm/fq6qlpjlsskycq6

{
  "ok": true
}

DELETE /vm/<hostname>

Schedule a checked-out VM for deletion.

Return codes:

200 OK
401 when you need an auth token
404 when requesting an invalid VM hostname

$ curl -X DELETE --url vmpooler.example.com/api/v1/vm/fq6qlpjlsskycq6

{
  "ok": true
}

Adding additional disk(s)

POST /vm/<hostname>/disk/<size>

Add an additional disk to a running VM.

Return codes:

202 OK
401 when you need an auth token
404 when requesting an invalid VM hostname or size is not an integer

$ curl -X POST -H X-AUTH-TOKEN:a9znth9dn01t416hrguu56ze37t790bl --url vmpooler.example.com/api/v1/vm/fq6qlpjlsskycq6/disk/8

{
  "ok": true,
  "fq6qlpjlsskycq6": {
    "disk": "+8gb"
  }
}

Provisioning and attaching disks can take a moment, but once the task completes it will be reflected in a GET /vm/<hostname> query:

$ curl --url vmpooler.example.com/api/v1/vm/fq6qlpjlsskycq6

{
  "ok": true,
  "fq6qlpjlsskycq6": {
    "template": "debian-7-x86_64",
    "lifetime": 2,
    "running": 0.08,
    "state": "running",
    "disk": [
      "+8gb"
    ],
    "domain": "delivery.puppetlabs.net"
  }
}

VM snapshots

POST /vm/<hostname>/snapshot

Create a snapshot of a running VM.

Return codes:

202 OK
401 when you need an auth token
404 when requesting an invalid VM hostname

$ curl -X POST -H X-AUTH-TOKEN:a9znth9dn01t416hrguu56ze37t790bl --url vmpooler.example.com/api/v1/vm/fq6qlpjlsskycq6/snapshot

{
  "ok": true,
  "fq6qlpjlsskycq6": {
    "snapshot": "n4eb4kdtp7rwv4x158366vd9jhac8btq"
  }
}

Snapshotting a live VM can take a moment, but once the snapshot task completes it will be reflected in a GET /vm/<hostname> query:

$ curl --url vmpooler.example.com/api/v1/vm/fq6qlpjlsskycq6

{
  "ok": true,
  "fq6qlpjlsskycq6": {
    "template": "debian-7-x86_64",
    "lifetime": 2,
    "running": 0.08,
    "state": "running",
    "snapshots": [
      "n4eb4kdtp7rwv4x158366vd9jhac8btq"
    ],
    "domain": "delivery.puppetlabs.net"
  }
}

POST /vm/<hostname>/snapshot/<snapshot>

Revert a VM back to a snapshot.

Return codes:

202 OK
401 when you need an auth token
404 when requesting an invalid VM hostname or snapshot is not valid

$ curl X POST -H X-AUTH-TOKEN:a9znth9dn01t416hrguu56ze37t790bl --url vmpooler.example.com/api/v1/vm/fq6qlpjlsskycq6/snapshot/n4eb4kdtp7rwv4x158366vd9jhac8btq

{
  "ok": true
}

Status and metrics

GET /status

A "live" status endpoint, representing the current state of the service.

$ curl --url vmpooler.example.com/api/v1/status

{
  "capacity": {
    "current": 716,
    "total": 717,
    "percent": 99.9
  },
  "clone": {
    "duration": {
      "average": 8.8,
      "min": 2.79,
      "max": 69.76
    },
    "count": {
      "total": 1779
    }
  },
  "queue": {
    "pending": 1,
    "cloning": 0,
    "booting": 1,
    "ready": 716,
    "running": 142,
    "completed": 0,
    "total": 859
  },
  "status": {
    "ok": true,
    "message": "Battle station fully armed and operational."
  }
}

If there are empty pools, the "status" section will convey this:

  "status": {
    "ok": false,
    "message": "Found 2 empty pools.",
    "empty": [
      "centos-6-x86_64",
      "debian-7-x86_64"
    ]
  }

The top level sections are: "capacity", "queue", "clone", "boot", "pools" and "status". If the query parameter 'view' is provided, it will be used to select which top level element to compute and return. Select them by specifying which one you want in a comma separated list. For example vmpooler.example.com/api/v1/status?view=capacity,boot

GET /summary[?from=YYYY-MM-DD[&to=YYYY-MM-DD]]

Returns a summary, or report, for the timespan between from and to (inclusive) parameters. The response includes both an overall and daily view of tracked metrics, such as boot and cloning durations.

Any omitted query parameter will default to now/today. A request without any parameters will result in the current day's summary.

Return codes:

200 OK
400 Invalid date format or range

$ curl --url vmpooler.example.com/api/v1/summary

{
  "boot": {
    "duration": {
      "average": 106.6,
      "min": 83.09,
      "max": 121.06,
      "total": 639.36,
    },
    "count": {
      "average": 6,
      "min": 6,
      "max": 6,
      "total": 6,
    }
  },
  "clone": {
    "duration": {
      "average": 4.6,
      "min": 2.78,
      "max": 8.1,
      "total": 63.94,
    },
    "count": {
      "average": 14,
      "min": 14,
      "max": 14,
      "total": 14,
    }
  },
  "tag": {
    "department": {
      "engineering": 14,
      "help desk": 10,
      "IT": 44,
      "total": 68
    },
    "user": {
      "arodgers": 54,
      "cmatthews": 10,
      "jnelson": 4,
      "total": 68
    }
  },
  "daily": [
    {
      "date": "2015-03-11",
      "boot": {
        "duration": {
          "average": 106.6,
          "min": 83.09,
          "max": 121.06,
          "total": 639.36
        },
        "count": {
          "total": 6
        }
      },
      "clone": {
        "duration": {
          "average": 4.6,
          "min": 2.78,
          "max": 8.1,
          "total": 63.94
        },
        "count": {
          "total": 14
        }
      },
      "tag": {
        "department": {
          "engineering": 14,
          "help desk": 10,
          "IT": 44,
          "total": 68
        },
        "user": {
          "arodgers": 54,
          "cmatthews": 10,
          "jnelson": 4,
          "total": 68
        }
      }
    }
  ]
}

$ curl -G -d 'from=2015-03-10' -d 'to=2015-03-11' --url vmpooler.example.com/api/v1/summary

{
  "boot": {...},
  "clone": {...},
  "daily": [
    {
      "date": "2015-03-10",
      "boot": {
        "duration": {
          "average": 0,
          "min": 0,
          "max": 0,
          "total": 0
        },
        "count": {
          "total": 0
        }
      },
      "clone": {
        "duration": {
          "average": 0,
          "min": 0,
          "max": 0,
          "total": 0
        },
        "count": {
          "total": 0
        }
      },
      "tag": { }
    },
    {
      "date": "2015-03-11",
      "boot": {
        "duration": {
          "average": 106.6,
          "min": 83.09,
          "max": 121.06,
          "total": 639.36
        },
        "count": {
          "total": 6
        }
      },
      "clone": {
        "duration": {
          "average": 4.6,
          "min": 2.78,
          "max": 8.1,
          "total": 63.94
        },
        "count": {
          "total": 14
        }
      },
      "tag": { }
    }
  ]
}

You can also query only the specific top level section you want by including it after summary/. The valid sections are "boot", "clone" or "tag" eg. vmpooler.example.com/api/v1/summary/boot/. You can further drill-down the data by specifying the second level parameter to query eg vmpooler.example.com/api/v1/summary/tag/created_by

Managing pool configuration via API

GET /config

Returns the running pool configuration

Return codes

200 OK
400 No configuration found

$ curl https://vmpooler.example.com/api/v1/config

{
  "pool_configuration": [
    {
      "name": "redhat-7-x86_64",
      "template": "templates/redhat-7.2-x86_64-0.0.3",
      "folder": "vmpooler/redhat-7-x86_64",
      "datastore": "stor1",
      "size": 1,
      "datacenter": "dc1",
      "provider": "vsphere",
      "capacity": 1,
      "major": "redhat",
      "template_ready": true
    }
  ],
  "status": {
    "ok": true
  }
}

Note: to enable poolsize and pooltemplate config endpoints it is necessary to set 'experimental_features: true' in your vmpooler configuration. A 405 is returned when you attempt to interact with these endpoints when this configuration option is not set.

POST /config/poolsize

Change pool size without having to restart the service.

All pool template changes requested must be for pools that exist in the vmpooler configuration running, or a 404 code will be returned

When a pool size is changed due to the configuration posted a 201 status will be returned. When the pool configuration is valid, but will not result in any changes, 200 is returned.

Pool size configuration changes persist through application restarts, and take precedence over a pool size value configured in the pool configuration provided when the application starts. This persistence is dependent on redis. So, if the redis data is lost then the configuration updates revert to those provided at startup at the next application start.

An authentication token is required in order to change pool configuration when authentication is configured. Responses:

200 - No changes required
201 - Changes made on at least one pool with changes requested
400 - An invalid configuration was provided causing requested changes to fail
404 - An unknown error occurred
405 - The endpoint is disabled because experimental features are disabled

$ curl -X POST -H "Content-Type: application/json" -d '{"debian-7-i386":"2","debian-7-x86_64":"1"}' --url https://vmpooler.example.com/api/v1/config/poolsize

{
  "ok": true
}

POST /config/pooltemplate

Change the template configured for a pool, and replenish the pool with instances built from the new template.

All pool template changes requested must be for pools that exist in the vmpooler configuration running, or a 404 code will be returned

When a pool template is changed due to the configuration posted a 201 status will be returned. When the pool configuration is valid, but will not result in any changes, 200 is returned.

A pool template being updated will cause the following actions, which are logged in vmpooler.log:

Destroy all instances for the pool template being updated that are in the ready and pending state
Halt repopulating the pool while creating template deltas for the newly configured template
Unblock pool population and let the pool replenish with instances based on the newly configured template

Pool template changes persist through application restarts, and take precedence over a pool template configured in the pool configuration provided when the application starts. This persistence is dependent on redis. As a result, if the redis data is lost then the configuration values revert to those provided at startup at the next application start.

An authentication token is required in order to change pool configuration when authentication is configured.

Responses:

200 - No changes required
201 - Changes made on at least one pool with changes requested
400 - An invalid configuration was provided causing requested changes to fail
404 - An unknown error occurred
405 - The endpoint is disabled because experimental features are disabled

$ curl -X POST -H "Content-Type: application/json" -d '{"debian-7-i386":"templates/debian-7-i386"}' --url https://vmpooler.example.com/api/v1/config/pooltemplate

{
  "ok": true
}

17 KiB Raw Blame History

Table of contents

API

Token operations

GET /token

POST /token

GET /token/<token>

DELETE /token/<token>

VM operations

GET /vm

POST /vm

POST /vm/<pool>

GET /vm/<hostname>

PUT /vm/<hostname>

DELETE /vm/<hostname>

Adding additional disk(s)

POST /vm/<hostname>/disk/<size>

VM snapshots

POST /vm/<hostname>/snapshot

POST /vm/<hostname>/snapshot/<snapshot>

Status and metrics

GET /status

GET /summary[?from=YYYY-MM-DD[&to=YYYY-MM-DD]]

Managing pool configuration via API

GET /config

POST /config/poolsize

POST /config/pooltemplate

17 KiB

Raw Blame History