Commit Graph

33 Commits

Author SHA1 Message Date
Danielle Lancashire 7d1f313091
docs: Sort keys in node response 2019-08-26 14:10:13 +02:00
Danielle Lancashire 9ab3fb0908
docs: Update /v1/node/{node-id} example response
The nodes api documentation is fairly out of date, here I've updated the
entire response based on a local dev agent, rather than explicitly
adding new fields to bring us up to the current api shape.
2019-08-26 12:27:16 +02:00
Buck Doyle 7a29fdfaf7
website: Add TOC links in page body (#6113)
This adds the “Jump to section” feature from Terraform’s documentation.
2019-08-13 08:19:01 -05:00
Charlie Voiselle 45ff97cb7a querystring -> query string 2019-05-08 15:14:31 -04:00
Charlie Voiselle ce5023ee95
Typo fixes (#5661)
* Typo fixes
* it's -> its
* plugable -> pluggable
2019-05-08 12:54:44 -04:00
Alex Dadgar 1e3c3cb287 Deprecate IOPS
IOPS have been modelled as a resource since Nomad 0.1 but has never
actually been detected and there is no plan in the short term to add
detection. This is because IOPS is a bit simplistic of a unit to define
the performance requirements from the underlying storage system. In its
current state it adds unnecessary confusion and can be removed without
impacting any users. This PR leaves IOPS defined at the jobspec parsing
level and in the api/ resources since these are the two public uses of
the field. These should be considered deprecated and only exist to allow
users to stop using them during the Nomad 0.9.x release. In the future,
there should be no expectation that the field will exist.
2018-12-06 15:09:26 -08:00
Alex Dadgar 300926552b Fix example drain API request 2018-10-08 10:06:39 -07:00
Michael Schurter c4028769ad
Merge pull request #4614 from wyattanderson/wa-eligibility-docs
Add documentation for eligibility toggle endpoint
2018-08-27 10:48:47 -07:00
Rob Genova f10155f285
Fix broken links in API docs 2018-08-25 11:35:56 -05:00
Wyatt Anderson 9dccb62489 Add documentation for eligibility toggle endpoint 2018-08-24 10:50:12 -04:00
Alex Dadgar 21c5ed850d Register events 2018-05-22 14:06:33 -07:00
Chelsea Holland Komlo d51611040f Add driver health information to node list stub 2018-05-09 11:21:54 -04:00
Michael Schurter 41d3e1f27c docs: add drain api and json jobspec 2018-04-12 11:34:01 -07:00
Chelsea Holland Komlo 33b3eca8b7 update timestamp and format api reference descriptions 2018-03-29 14:22:46 -04:00
Chelsea Holland Komlo d5a4f28868 update events in node api 2018-03-29 12:41:32 -04:00
Chelsea Holland Komlo 4019723cf5 add field reference for node events 2018-03-29 12:29:55 -04:00
Chelsea Holland Komlo 81cab6d21c add node events to documentation 2018-03-29 12:17:03 -04:00
Charlie Voiselle fb5091678b Changed `nomad.rocks` to `localhost:4646` to align with defaults
Should provide cut and paste example for most users. Advanced users should be able to correct URLs to something appropriate.
2018-01-29 11:27:52 -05:00
Michael Schurter 9fcda9c5aa Make example service name make sense
Switch from global-redis-check for the example job's service name to
redis-cache. The former name is really confusing and someone finally
called us out on it:

https://groups.google.com/d/msg/nomad-tool/3RTh6CyYkWk/vEe_Sj7lAAAJ

Also specifically mention that the `service.name` parameter is what is
advertised in Consul.
2018-01-17 14:08:30 -08:00
Shantanu Gadgil 318cec8ce6
'drain' node is a POST rather than a GET
'drain' node is a POST rather than a GET
2018-01-12 23:35:49 +05:30
Preetha Appan 4c1ef55c7d Update docs to include ModifyTime in more places where allocations are returned 2017-11-01 15:19:52 -05:00
Diptanu Choudhury 7f8d1ae858 Changed the curl command 2017-10-26 14:19:57 -07:00
Diptanu Choudhury 42e4118f81 Added docs for the purge API 2017-10-26 14:18:34 -07:00
Michael Schurter 01816af088 Node.List ACL enforcement 2017-09-14 22:01:18 -07:00
Michael Schurter aca9e337aa Node.GetAllocs ACL enforcement 2017-09-14 21:42:19 -07:00
Michael Schurter 4fc44c686c Node.GetNode ACL enforcement 2017-09-14 20:59:18 -07:00
Michael Schurter 21ee5f4720 Node.Evaluate ACL enforcement 2017-09-14 20:41:44 -07:00
Michael Schurter 0cfaaa0a4d Node.UpdateDrain ACL enforcement 2017-09-14 20:33:31 -07:00
Charlie Voiselle da14a95051 Added code block styling 2017-08-07 17:34:18 -04:00
Charlie Voiselle 37ec2e3f54 Re-added Allocations documentation
In a content reorganization, the allocations endpoint documentation was removed.  This just brings it back in and updates the output to match v0.6.0 output
2017-08-07 17:28:06 -04:00
Seth Vargo a0af9d87c1
Remove links to consistency modes 2017-05-30 21:08:23 -04:00
Seth Vargo be3c47e5a7
Remove consistency modes 2017-05-30 20:53:37 -04:00
Seth Vargo 41eaf492f9
Migrate nodes APIs 2017-05-30 20:25:09 -04:00