Commit graph

258 commits

Author SHA1 Message Date
Michael Schurter 237dc52acc Fix missing fields in json jobspec docs 2017-12-19 16:19:40 -08:00
Kyle Havlovitz 2455a205de Add autopilot docs 2017-12-18 14:29:41 -08:00
Kyle Havlovitz f088446d48
Add missing exist checks and doc line 2017-12-12 10:17:16 -06:00
Thomas Bartelmess 9acfa166c0
Changed Superset to only return the resource name
The Superset method on Resources used to return a string in the format of “[resource name] exhausted”.
This was leading to the output in plan/create job API DimensionExhausted to return keys like
```
"DimensionExhausted": {"cpu exhausted": 1}
```
This was not anywhere documented, however, one of the examples on the website showed it like this.

The other side effect of this is that the CLI formats the strings from the name of the key leading to output like
```
* Dimension "cpu exhausted" exhausted on 1 nodes
```
2017-11-28 23:16:08 -05:00
Chelsea Komlo fc8f670b02
Merge pull request #3583 from neojin/update-docs-api-regions
update API docs for /regions endpoint
2017-11-28 10:00:31 -05:00
Chelsea Komlo bf389ed3f3
Merge pull request #3584 from neojin/update-api-docs-client-gc
API docs: /client/gc returns text/plain, not json
2017-11-28 09:59:12 -05:00
Iurii Skliar 71718db753 Fix Website Docs for Periodic jobs TimeZone 2017-11-27 18:06:26 +01:00
Jin Lee d669eb6b5c /client/gc returns text/plain, not json 2017-11-23 10:15:33 -08:00
Jin Lee 903fc6560d update API docs for /regions endpoint 2017-11-23 09:24:40 -08:00
Jin Lee 8b94d235d9 update API docs for /agent/self from POST to GET 2017-11-18 19:03:33 -08:00
Preetha Appan 1378ebee01 Update deployments API documentation to add clarifying sentence about rollbacks triggering only when job spec is different. 2017-11-04 09:28:27 -05:00
Preetha Appan 4c1ef55c7d Update docs to include ModifyTime in more places where allocations are returned 2017-11-01 15:19:52 -05:00
Preetha Appan 7116487a96 Document modify time in a bunch of places 2017-11-01 15:16:38 -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
Alex Dadgar fd5be6de76 Merge pull request #3395 from hashicorp/d-quota
Document Quotas
2017-10-16 12:41:05 -07:00
Alex Dadgar 12ff9e5da1 review feedback 2017-10-16 12:40:41 -07:00
Alex Dadgar 5172073db2 Merge branch 'master' into f-acl-cli 2017-10-16 11:29:48 -07:00
Alex Dadgar b940175933 Update acl-tokens.html.md 2017-10-16 11:29:08 -07:00
Alex Dadgar 49248b11ef guide 2017-10-16 11:23:18 -07:00
Michael Schurter 916682f8a0 Merge pull request #3387 from hashicorp/f-aclless-health
Agent Health Endpoint
2017-10-16 11:05:09 -07:00
Alex Dadgar 8540be6964 api 2017-10-15 21:15:14 -07:00
Alex Dadgar e961e36046 quota api 2017-10-15 16:41:24 -07:00
Alex Dadgar 96ef879c24 Self token lookup 2017-10-13 16:31:46 -07:00
Alex Dadgar 377e63dc60 ListPolicies and GetPolicy work w/o management token 2017-10-13 16:31:46 -07:00
Alex Dadgar bf88fd8dd1 quota command docs 2017-10-13 16:16:36 -07:00
Michael Schurter c53aac9eea Agent Health Endpoint 2017-10-13 15:37:44 -07:00
Alex Dadgar dd3920d681 Self token lookup 2017-10-13 13:12:20 -07:00
Alex Dadgar 5d4f467519 ListPolicies and GetPolicy work w/o management token 2017-10-13 13:12:20 -07:00
Michael Schurter e9c17c56d1 Merge pull request #3353 from hashicorp/f-acl-prefix-search
Prefix Search ACL enforcement
2017-10-11 20:26:03 -07:00
Michael Schurter be69374ecd Prefix Search ACL enforcement 2017-10-11 17:00:12 -07:00
Michael Schurter d82db5ab45 Merge pull request #3351 from hashicorp/f-acl-system
System ACL enforcement
2017-10-11 16:32:50 -07:00
Michael Schurter 8c1a97765e Merge pull request #3339 from hashicorp/f-acl-force-periodic
Force Periodic ACL enforcement
2017-10-11 16:26:29 -07:00
Michael Lange b3d012a9f2 List query params on the API UI docs page 2017-10-11 15:49:18 -07:00
Michael Schurter 0d27053aab Operator ACL enforcement 2017-10-10 15:18:19 -07:00
Michael Schurter 0cf7a3950b Force Periodic ACL enforcement 2017-10-10 15:16:41 -07:00
Michael Schurter 4e005d4753 System ACL enforcement
Enforce ACL for System.GarbageCollect and System.ReconcileJobSummaries
RPC endpoints.
2017-10-10 10:53:10 -07:00
Michael Schurter 492c861419 /v1/client/agent/* ACL enforcement 2017-10-09 12:18:54 -07:00
Michael Schurter 04adc987ed /v1/client/allocation/./{stats,gc} ACL enforcement 2017-10-09 12:13:52 -07:00
Michael Schurter 40e5a56036 Merge pull request #3329 from hashicorp/f-acl-client-stats
/v1/client/stats ACL enforcement
2017-10-09 12:06:43 -07:00
Michael Schurter 84d82d79bb /v1/client/stats ACL enforcement 2017-10-09 12:02:32 -07:00
Michael Schurter 289f7d76bc Merge pull request #3343 from hashicorp/docs-client-gc
Document /v1/client/gc endpoint
2017-10-09 11:49:07 -07:00
Michael Schurter dce2479147 Document /v1/client/gc endpoint 2017-10-09 11:27:28 -07:00
Michael Schurter a7450c8633 FS HTTP API ACL enforcement
ACL enforcement for the filesystem HTTP APIs on clients.
2017-10-09 11:06:34 -07:00
Chelsea Komlo 7c8a5228d4 Merge pull request #3290 from hashicorp/f-acl-job-dispatch
Add ACL for dispatch job
2017-10-06 13:33:21 -04:00
Michael Schurter 22169a7cd4 Eval.Allocations ACL enforcement 2017-10-03 14:57:47 -07:00
Michael Schurter b3db8f41fd Eval.List ACL enforcement 2017-10-03 14:57:47 -07:00
Michael Schurter fae1be5ab2 Eval.GetEval ACL enforcement 2017-10-03 14:57:47 -07:00
Michael Schurter bd6418aa27 Deployment.Allocations ACL enforcement 2017-10-02 15:23:29 -07:00
Michael Schurter 08c82eb00f Deployment.List ACL enforcement 2017-10-02 15:13:56 -07:00
Michael Schurter 60a7dc3c83 Deployment.SetAllocHealth ACL enforcement 2017-10-02 15:02:18 -07:00
Michael Schurter c9d2c62d0b Deployment.Promote ACL enforcement 2017-10-02 14:31:58 -07:00
Michael Schurter 0409a54f19 Deployment.Pause ACL enforcement 2017-10-02 14:25:32 -07:00
Michael Schurter b888e49df4 Deployment.Fail ACL enforcement 2017-10-02 14:23:33 -07:00
Chelsea Komlo 97e34725e1 Merge pull request #3278 from hashicorp/f-acl-job-getjob
Add ACL for GetJob
2017-09-29 17:44:31 -04:00
Chelsea Komlo 388cdaa2e8 Merge pull request #3272 from hashicorp/f-acl-job-stable
Add ACL endpoint for Job Stable
2017-09-29 17:44:09 -04:00
Alex Dadgar b772fb650e Merge pull request #3293 from hashicorp/f-self-token
Allow querying self token
2017-09-29 10:54:37 -07:00
Chelsea Komlo 3a015016cc Merge pull request #3294 from hashicorp/f-acl-job-deregister
Add ACL for job deregister
2017-09-28 10:57:51 -04:00
Chelsea Komlo c54a4f7c91 Merge pull request #3291 from hashicorp/f-acl-get-job-versions
Add ACL for job endpoint GetJobVersions
2017-09-28 10:35:19 -04:00
Chelsea Holland Komlo c242ac1431 job dispatch should have dispatch policy 2017-09-28 14:28:28 +00:00
Chelsea Komlo 77ae328fbe Merge pull request #3276 from hashicorp/f-acl-job-evaluate
Add read job permissions to evaluate endpoint
2017-09-27 18:01:15 -04:00
Chelsea Holland Komlo 09cd8b2792 add documnetation 2017-09-27 21:06:13 +00:00
Chelsea Komlo d3d1bc6498 Merge pull request #3279 from hashicorp/f-acl-job-allocations
Add ACL to job allocations endpoint
2017-09-27 16:57:04 -04:00
Chelsea Komlo 8f1c89c721 Merge pull request #3283 from hashicorp/f-acl-job-latest-deployment
Add ACL to latest job api
2017-09-27 16:54:44 -04:00
Alex Dadgar 765b030bec Fixes 2017-09-27 13:42:56 -07:00
Chelsea Holland Komlo 41c30183ee add documentation 2017-09-27 20:23:06 +00:00
Chelsea Holland Komlo fe226a8f87 add documentation 2017-09-27 20:20:04 +00:00
Chelsea Holland Komlo aa026e708a add documentation 2017-09-27 20:17:58 +00:00
Chelsea Holland Komlo 4e18d060b0 add documentation 2017-09-27 20:12:49 +00:00
Alex Dadgar 14e6026938 Allow querying self token
This PR allows querying self ACL token when the SecretID is for the
AccessorID in question.
2017-09-27 13:00:58 -07:00
Alex Dadgar bed56cbb1e Merge pull request #3292 from hashicorp/f-lint-website
Spell check website
2017-09-27 12:56:13 -07:00
Chelsea Holland Komlo 1bab53c9fd acl for job deregister 2017-09-27 19:21:10 +00:00
Chelsea Komlo b40de659a7 Merge pull request #3281 from hashicorp/f-acl-job-evaluations
Add ACL for Job Evaluations endpoint
2017-09-27 15:15:35 -04:00
Alex Dadgar 60111b5af7 Spell check website 2017-09-27 11:14:37 -07:00
Chelsea Holland Komlo 0db1367d43 add acl for dispatch job 2017-09-27 16:33:49 +00:00
Chelsea Holland Komlo 55c4ca187e add acl for job deployments endpoint 2017-09-26 20:33:03 +00:00
Chelsea Holland Komlo a7b7b3f6c6 add acl for Job Evaluations endpoint 2017-09-26 20:12:37 +00:00
Chelsea Holland Komlo 2fb7772c2c add acl to job allocations endpoint 2017-09-26 18:01:23 +00:00
Wim Fournier aa1a47f03c Update metrics.html.md
Fix typo
2017-09-26 13:06:59 +02:00
Chelsea Holland Komlo 021dae5452 add acl documentation 2017-09-25 21:53:32 +00:00
Chelsea Holland Komlo d9ac59f6b0 add acl for job validate endpoint 2017-09-25 17:34:02 +00:00
Alex Dadgar e5ec915ac3 sync 2017-09-19 10:08:23 -05:00
Michael Lange b85f15ead1 Merge pull request #3232 from hashicorp/d-ui-api-doc
Document each route in the UI for the API docs
2017-09-18 19:52:04 -05:00
Michael Schurter f92ffe5af5 Merge pull request #3105 from hashicorp/f-876-restart-unhealthy
Restart unhealthy tasks
2017-09-17 19:38:32 -07:00
Michael Lange c6e2d1722a Document each route in the UI for the API docs 2017-09-17 18:12:15 -05:00
Chelsea Komlo 16ef183ddf Merge pull request #3219 from hashicorp/f-acl-job-list
Add job list ACL
2017-09-15 19:32:34 -04:00
Chelsea Holland Komlo 6ca7a5f4db add documentation for job list acl 2017-09-15 21:26:27 +00: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
Michael Schurter aca3bebb0a Alloc.GetAlloc ACL enforcement 2017-09-14 17:44:57 -07:00
Michael Schurter f5faf97650 Alloc.List ACL enforcement 2017-09-14 17:43:17 -07:00
Michael Schurter 95c6077435 Document new check_restart stanza 2017-09-14 16:46:54 -07:00
Chelsea Holland Komlo 3eff2a06c5 add job endpoint ACL 2017-09-14 18:17:35 +00:00
Alex Dadgar fa2dd57071 Merge pull request #3205 from hashicorp/f-deployment-acl
Deployment.GetDeployment ACL enforcement
2017-09-14 10:50:17 -07:00
Chelsea Holland Komlo e0f9cd4a0f add documentation for prometheus config option 2017-09-13 19:21:21 +00:00
Alex Dadgar 4b947222a8 Deployment.GetDeployment ACL enforcement 2017-09-13 11:44:23 -07:00
Armon Dadgar c234e09d9e website: document ACL bootstrap reset process 2017-09-10 16:18:39 -07:00
Chelsea Holland Komlo 66fa05405a tagged metrics config options should be on telemetry config
better api example, add telemetry documentation
2017-09-06 15:25:36 +00:00
Chelsea Holland Komlo 11a676c901 add documentation for new HTTP metrics endpoint 2017-09-06 13:51:19 +00:00
Armon Dadgar 8956f665a7 website: pointing to ACL guide 2017-09-04 13:07:44 -07:00
Armon Dadgar a712a83f1b website: Document ACL APIs and configuration 2017-09-04 13:07:44 -07:00
Alex Dadgar feace39196 Clarify all_at_once parameter
Fixes https://github.com/hashicorp/nomad/issues/3125
2017-08-29 16:20:28 -07:00
Alex Dadgar cff1c5ca08 Merge pull request #3107 from hashicorp/b-migrate-context-all
All context should use string context "all"
2017-08-28 12:38:54 -07:00
Alex Dadgar 88908410ef Merge pull request #3096 from hashicorp/d-all-allocs
Describe the all parameter when listing job allocs
2017-08-28 12:25:24 -07:00
Chelsea Holland Komlo 6243690899 migrate all context 2017-08-28 05:29:38 +00:00
Chelsea Holland Komlo 83cc71aed9 alignment and fixups from code review 2017-08-25 14:12:23 +00:00
Chelsea Holland Komlo f8e2a4c54c add HTTP documentation for search api 2017-08-25 00:14:04 +00:00
Alex Dadgar 8eb3db6e98 Describe the all parameter when listing job allocs
Fixes https://github.com/hashicorp/nomad/issues/3092
2017-08-24 17:01:24 -07:00
Alex Dadgar 876c0e4cc7 clarify deployment api docs 2017-08-23 10:35:29 -07:00
Michael Schurter b1fa005656 Document check header and method 2017-08-17 16:49:14 -07:00
Michael Schurter 188e89c77f Add ShutdownDelay to JSON Job docs 2017-08-17 11:30:29 -07:00
Hynek Schlawack a6326c92d5 Off by one! 2017-08-12 16:06:20 +02:00
Nicolae Vlădescu cb46b6ca91 Fix navigation highlight for JSON Jobs 2017-08-11 11:37:40 +03:00
Nicolae Vlădescu 8c8cd3b312 Fix documentation bug
Fix documentation bug: distinct_host -> distinct_hosts
2017-08-11 11:29:53 +03:00
Alex Dadgar 8973c01315 Merge pull request #2980 from hashicorp/b-doc-missing-node-allocations
Re-added Allocations documentation
2017-08-08 10:23:02 -07:00
James Rasell 07e3bed923 Update job.html read most recent deployment sample
The sample request incorrectly used `https://nomad.rocks/v1/job/my-job/deployments` which listed all deployments for the specified job. The sample request has therefore been updated to use the correct endpoint which returns only the jobs most recent deployment.
2017-08-08 10:47:24 +01:00
Alex Dadgar 79d25b7db9 Merge pull request #2947 from hashicorp/f-vault-grace
Allow template to set Vault grace
2017-08-07 16:29:53 -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
Jonathan Cross c5b107d916 fix wording 2017-08-02 13:54:49 -04:00
Jonathan Cross 65b4141f91 add third party client library link for python 2017-08-02 13:51:37 -04:00
Alex Dadgar 80f41d2389 Merge pull request #2931 from zsluedem/master
add job creating json sample in jobs api doc
2017-08-01 14:21:45 -07:00
Alex Dadgar 9ad1f3ac4f Merge pull request #2942 from hashicorp/f-distinct-count
Distinct Property supports arbitrary limit
2017-08-01 14:19:09 -07:00
Alex Dadgar 067a638478 Allow template to set Vault grace
This PR allows a template to specify the Vault grace duration.

Fixes https://github.com/hashicorp/nomad/issues/2922
2017-08-01 14:14:08 -07:00
Alex Dadgar 2650bb1d12 Distinct Property supports arbitrary limit
This PR enhances the distinct_property constraint such that a limit can
be specified in the RTarget/value parameter. This allows constraints
such as:

```
constraint {
  distinct_property = "${meta.rack}"
  value = "2"
}
```

This restricts any given rack from running more than 2 allocations from
the task group.

Fixes https://github.com/hashicorp/nomad/issues/1146
2017-07-31 16:52:13 -07:00
Alex Dadgar 08e98e1de4 Document Purge parameter on deregister request
This PR documents the purge parameter when deregistering a job.
2017-07-31 14:03:35 -07:00
Will 489d635de2 add job creating json sample in jobs api doc 2017-07-29 09:04:30 +08:00
Alex Dadgar a883b325ff Example JSON is submitable
This PR makes the example JSON job submitable via the HTTP API.
2017-07-28 09:02:15 -07:00
Alex Dadgar fac2567521 Update API and JSON Job Documentation
This PR updates the api documentation to reflect 0.6 HTTP API and the
JSON job specification as well.
2017-07-25 17:18:15 -07:00
Seth Vargo a293b81b2b
Use a subdirectory for operator commands 2017-07-25 15:55:35 -04:00
Charlie Voiselle 3cff38ff94 Spellcheck sweep of website directory
Caught some typos.  Made units separate from the numbers 1GHz -> 1 GHz
after talking to Nick about questions of style (this has the side effect of making future spell checking easier).
2017-07-17 14:41:50 -04:00
Michael Schurter 73ec282529 an user -> a user 2017-07-07 12:12:48 -07:00
Alex Dadgar 461e36584e events 2017-07-07 12:12:48 -07:00
Alex Dadgar 867012b9cb add to docs 2017-07-07 12:10:04 -07:00
Alex Dadgar a7fdc74bd4 feedback 2017-07-07 12:10:04 -07:00
Alex Dadgar d4bdc866f0 HTTP API docs for job 2017-07-07 12:10:04 -07:00
Alex Dadgar 6d90c5c780 Deployments HTTP docs 2017-07-07 12:03:11 -07:00
Rob Genova 5d8298290e Remove Atlas references from docs 2017-06-05 23:05:43 +00: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 df31b83468
Cleanup links to limit redirects 2017-05-30 20:25:11 -04:00
Seth Vargo 08cd843c5f
Migrate API index 2017-05-30 20:25:10 -04:00
Seth Vargo 80e296bbc5
Migrate validate APIs 2017-05-30 20:25:10 -04:00
Seth Vargo d3c5863cb5
Migrate system APIs 2017-05-30 20:25:10 -04:00
Seth Vargo 916d965e81
Migrate status APIs 2017-05-30 20:25:10 -04:00
Seth Vargo 4df34e95bd
Migrate regions APIs 2017-05-30 20:25:09 -04:00
Seth Vargo e090b716f7
Migrate operator APIs 2017-05-30 20:25:09 -04:00