puppetlabs/vmpooler
2
0
Fork 0
mirror of https://github.com/puppetlabs/vmpooler.git synced 2026-01-26 01:58:41 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updating docs to include 'tag' in /summary

Browse source
This commit is contained in:
Scott Schneider 2015-05-07 17:11:07 -07:00
parent 4cfc078684
commit 726de893ec
1 changed files with 44 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -79,14 +79,14 @@ Token-based authentication can be used when requesting or modifying VMs. The `/
Get information about an existing token. Get information about an existing token.
``` ```
$ curl -u sschneid --url vmpooler.company.com/token/utpg2i2xswor6h8ttjhu3d47z53yy47y $ curl -u jdoe --url vmpooler.company.com/token/utpg2i2xswor6h8ttjhu3d47z53yy47y
Enter host password for user 'sschneid': Enter host password for user 'jdoe':
``` ```
```json ```json
{ {
"ok": true, "ok": true,
"utpg2i2xswor6h8ttjhu3d47z53yy47y": { "utpg2i2xswor6h8ttjhu3d47z53yy47y": {
"user": "sschneid", "user": "jdoe",
"timestamp": "2015-04-28 19:17:47 -0700" "timestamp": "2015-04-28 19:17:47 -0700"
} }
} }
@ -97,8 +97,8 @@ Enter host password for user 'sschneid':
Generate a new authentication token. Generate a new authentication token.
``` ```
$ curl -X POST -u sschneid --url vmpooler.company.com/token $ curl -X POST -u jdoe --url vmpooler.company.com/token
Enter host password for user 'sschneid': Enter host password for user 'jdoe':
``` ```
```json ```json
{ {
@ -112,8 +112,8 @@ Enter host password for user 'sschneid':
Delete an authentication token. Delete an authentication token.
``` ```
$ curl -X DELETE -u sschneid --url vmpooler.company.com/token/utpg2i2xswor6h8ttjhu3d47z53yy47y $ curl -X DELETE -u jdoe --url vmpooler.company.com/token/utpg2i2xswor6h8ttjhu3d47z53yy47y
Enter host password for user 'sschneid': Enter host password for user 'jdoe':
``` ```
```json ```json
{ {
@ -213,6 +213,10 @@ $ curl --url vmpooler.company.com/vm/pxpmtoonx7fiqg6
"lifetime": 12, "lifetime": 12,
"running": 3.1, "running": 3.1,
"state": "running", "state": "running",
"tags": {
"department": "engineering",
"user": "jdoe"
},
"domain": "company.com" "domain": "company.com"
} }
} }
@ -243,7 +247,7 @@ $ curl -X PUT -d '{"lifetime":"2"}' --url vmpooler.company.com/vm/fq6qlpjlsskycq
``` ```
``` ```
$ curl -X PUT -d '{"tags":{"department":"engineering","user":"sschneid"}}' --url vmpooler.company.com/vm/fq6qlpjlsskycq6 $ curl -X PUT -d '{"tags":{"department":"engineering","user":"jdoe"}}' --url vmpooler.company.com/vm/fq6qlpjlsskycq6
``` ```
```json ```json
{ {
@ -361,6 +365,20 @@ $ curl --url vmpooler.company.com/summary
"total": 14, "total": 14,
} }
}, },
"tag": {
"department": {
"engineering": 14,
"help desk": 10,
"IT": 44,
"total": 68
},
"user": {
"arodgers": 54,
"cmatthews": 10,
"jnelson": 4,
"total": 68
}
},
"daily": [ "daily": [
{ {
"date": "2015-03-11", "date": "2015-03-11",
@ -385,6 +403,20 @@ $ curl --url vmpooler.company.com/summary
"count": { "count": {
"total": 14 "total": 14
} }
},
"tag": {
"department": {
"engineering": 14,
"help desk": 10,
"IT": 44,
"total": 68
},
"user": {
"arodgers": 54,
"cmatthews": 10,
"jnelson": 4,
"total": 68
}
} }
} }
] ]
@ -422,7 +454,8 @@ $ curl -G -d 'from=2015-03-10' -d 'to=2015-03-11' --url vmpooler.company.com/sum
"count": { "count": {
"total": 0 "total": 0
} }
} },
"tag": { }
}, },
{ {
"date": "2015-03-11", "date": "2015-03-11",
@ -447,7 +480,8 @@ $ curl -G -d 'from=2015-03-10' -d 'to=2015-03-11' --url vmpooler.company.com/sum
"count": { "count": {
"total": 14 "total": 14
} }
} },
"tag": { }
} }
] ]
} }