Commit Graph

58 Commits

Author SHA1 Message Date
davidr912
ca1cb4b484 Update job/plan documentation (#9145)
Updated to reflect plan expects the job definition as JSON object and not as the string form of the JSON
2020-10-22 10:17:47 -04:00
Drew Bailey
e49bd2e33e Events/docs (#9100)
* /v1/event/stream docs

* events sidebar

* wip server config

* make ids match

* fix typo

* add server config opts

* Update website/pages/api-docs/events.mdx

Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>

* Update website/pages/api-docs/events.mdx

Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>

* address feedback

Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>
2020-10-16 11:23:47 -04:00
Michael Schurter
276be8604a docs: document #9055 2020-10-14 10:41:32 -07:00
Ryan Oaks
0e0f23210e Format docs website code and mdx 2020-10-02 13:31:40 -04:00
José Maia
c8bc8517e8 Fix docs on API for volume detaching (#9002)
`nomad volume detach volume-id 00000000-0000-0000-0000-000000000000` produces an API call containing the UUID as part of the query string. This is the only way the API accepts the request correctly - if you pass it in the payload you get `detach requires node ID`
2020-10-01 11:01:13 -04:00
Charlie Voiselle
fee792d2ad [docs] Update redirects and links for learn.hashicorp.com (#8598)
* Fix links to ACL guides
* Managing Nomad guide links; links in jsx pages
* job updates guide URLS
* node-drain guide URLS
* outage recovery guide links
* fix guide links - sentinel
* fix guide links - namespaces
* fix guide links - quotas
* fix guide links - autopilot
* more guide links.
* more guide links - continued.
* Updating redirects for learn
* Getting Started
* Load Balancing Guides
* update redirects for ui guide
* Consolidate spark redirects to point to GH repo
* operating job update part 1
* finish operating job links; operations guides links.
* finish guide redirects
* coalesce EOL redirects for spark guides.
* one last link
* Checked links and found a few more stray links
* Found more .htmls
* Fixup links for new HC websites
* Post-merge fixups
* linkcheck caught missing ids
2020-09-29 12:48:32 -04:00
José Maia
57e07772bd Fix sample JSON payload when updating a Volume (#8880)
Fixes #8879
2020-09-14 09:24:26 -04:00
Lang Martin
b5ef217c90 nomad debug renamed to nomad operator debug (#8602)
* renamed: command/debug.go -> command/operator_debug.go
* website: rename debug -> operator debug
* website/pages/api-docs/agent: name in api docs
2020-08-11 15:39:44 -04:00
Tim Gross
fbefdb98c3 csi: nomad volume detach command (#8584)
The soundness guarantees of the CSI specification leave a little to be desired
in our ability to provide a 100% reliable automated solution for managing
volumes. This changeset provides a new command to bridge this gap by providing
the operator the ability to intervene.

The command doesn't take an allocation ID so that the operator doesn't have to
keep track of alloc IDs that may have been GC'd. Handle this case in the
unpublish RPC by sending the client RPC for all the terminal/nil allocs on the
selected node.
2020-08-11 10:18:54 -04:00
Michael Lange
8829123702 Update Reason to Message in the job scale docs 2020-07-30 09:06:08 -07:00
James Rasell
49fddb14dc docs: add Namespace field to scale status GET example. 2020-07-24 14:45:50 +02:00
Rémi Lapeyre
f7a3e9e0a3 Fix typo in volume HTTP API documentation (#8396) 2020-07-09 08:33:45 -04:00
Nick Ethier
3367f6d94a docs: add CNI and host_network docs (#8391)
Co-authored-by: Seth Hoenig <shoenig@hashicorp.com>
2020-07-08 15:45:04 -04:00
Chris Baker
dbafdc3889 correcting CSI Plugins API sample response
neither `structs.CSIPlugin` nor `api.CSIPlugin` contain `topologies`
2020-07-07 16:17:23 -05:00
Chris Baker
c231267fa8 Update plugins.mdx
bad example JSON response
2020-07-05 16:46:44 -05:00
Lang Martin
0980539582 doc: add api docs to agent page (#8339)
* doc: add api docs to agent page

* docs: add a sentence about redaction
2020-07-02 11:04:55 -04:00
Mahmood Ali
7286f8ef84 document namespace=* in relevant APIs 2020-07-01 15:20:57 -04:00
Tim Gross
95799663b8 csi: add -force flag to volume deregister (#8295)
The `nomad volume deregister` command currently returns an error if the volume
has any claims, but in cases where the claims can't be dropped because of
plugin errors, providing a `-force` flag gives the operator an escape hatch.

If the volume has no allocations or if they are all terminal, this flag
deletes the volume from the state store, immediately and implicitly dropping
all claims without further CSI RPCs. Note that this will not also
unmount/detach the volume, which we'll make the responsibility of a separate
`nomad volume detach` command.
2020-07-01 12:17:51 -04:00
Sam Gluck
ffa1275ad9 docs: add link to golang api GoDoc webpage (#7174) 2020-06-26 09:14:49 -04:00
Mahmood Ali
8363c2ca0b document snapshot api endpoints 2020-06-19 10:37:00 -04:00
Luiz Aoqui
6bdceed391 Merge pull request #8206 from hashicorp/docs-fix-license-api
docs: update operator license API
2020-06-18 21:24:13 -04:00
Luiz Aoqui
aeb32e7ae2 docs: update operator license API 2020-06-18 20:17:45 -04:00
Mahmood Ali
9c2c03724b Merge pull request #8192 from hashicorp/f-status-allnamespaces-2
CLI Allow querying all namespaces for jobs and allocations - Try 2
2020-06-18 20:16:52 -04:00
Tim Gross
6fd4f3e985 docs: multiregion deployment feature (#8185) 2020-06-18 08:41:22 -04:00
Mahmood Ali
2f9fc04e05 use '*' to indicate all namespaces
This reverts the introduction of AllNamespaces parameter that was merged
earlier but never got released.
2020-06-17 16:27:43 -04:00
Chris Baker
50be177602 docs: updated website to this change 2020-06-17 17:44:58 +00:00
Drew Bailey
13f26183f5 Docs/license (#8076)
* license cli documentation

license docs

backout doc change

more docs

* license api endpoint documentation
2020-06-01 10:55:03 -04:00
Mahmood Ali
65937ffd21 Merge pull request #8001 from hashicorp/f-jobs-list-across-nses
endpoint to expose all jobs across all namespaces
2020-05-31 21:28:03 -04:00
Mahmood Ali
379a85c8f0 docs: preemption is no longer an Enterprise feature 2020-05-27 15:05:52 -04:00
James Rasell
041e25152c Merge pull request #8007 from hashicorp/volumes-docs-csi-put-blocking
docs: update CSI PUT operation blocking query support yes->no.
2020-05-20 09:38:38 +02:00
Shantanu Gadgil
f3f1467278 Merge branch 'master' into patch-3 2020-05-20 00:16:43 +05:30
Charlie Voiselle
27c12a6e70 Interlinking API, FAQ, and Config
Creating a FAQ question to provide a home for additional context around
bootstrapping. Linking from API page to `default_server_config`
attribute. Added sample API response to to discuss "Updated: false"
2020-05-19 13:51:47 -04:00
Mahmood Ali
11e550661e docs: update snippet to include summary namespace 2020-05-19 10:06:53 -04:00
James Rasell
8c217f27a4 docs: update CSI PUT operation blocking query support yes->no. 2020-05-19 08:42:48 +02:00
Jeff Escalante
e69fc1f459 fix shell-session snippet error 2020-05-18 16:53:06 -04:00
Mahmood Ali
9813a55d44 endpoint to expose all jobs across all namespaces
Allow a `/v1/jobs?all_namespaces=true` to list all jobs across all
namespaces.  The returned list is to contain a `Namespace` field
indicating the job namespace.

If ACL is enabled, the request token needs to be a management token or
have `namespace:list-jobs` capability on all existing namespaces.
2020-05-18 13:50:46 -04:00
Mahmood Ali
e9fe8a98df Document scheduler algorithm 2020-05-09 12:12:38 -04:00
Jeff Escalante
6f3a00b2ce fix some highlighting issues 2020-05-06 16:12:34 -04:00
Charlie Voiselle
738f3cb0ac Adding API homepage to sidebar. 2020-04-27 13:41:11 -04:00
Buck Doyle
dd2e387074 Docs: correct search API (#7756)
This closes #7718. It corrects some inaccuracies and adds
an explanation of the truncations block.
2020-04-21 07:33:24 -05:00
Chris Baker
a8ed119496 documents the scaling block in the JSON Job docs (#7706)
* documents the scaling block in the JSON Job docs

resolves #7656

* add task-specific restart to JSON Job docs

companion to #7603

* [docs] improved and corrected scaling docs

* Update website/pages/api-docs/json-jobs.mdx

Co-Authored-By: Michael Schurter <mschurter@hashicorp.com>

Co-authored-by: Michael Schurter <mschurter@hashicorp.com>
2020-04-13 16:33:49 -05:00
Michael Schurter
a2d17783d0 docs: remove 0.11 from scaling docs
Keep beta label for now.
2020-04-07 11:22:13 -07:00
Charlie Voiselle
747c6f0ab9 fix search and replace error 2020-03-27 11:39:03 -04:00
Charlie Voiselle
c006652e82 Fixed pages with new changes 2020-03-26 19:58:26 -04:00
Charlie Voiselle
2a01a36cd7 more links
(cherry picked from commit 0e39e2e49b0371c246dc1a9b4bb20af0b2f642a0)
2020-03-26 19:27:55 -04:00
Charlie Voiselle
837912a8f1 fixing links
(cherry picked from commit 575f22e970e2429b8f9871f11b8c3e0924c82dc2)
2020-03-26 19:27:05 -04:00
Charlie Voiselle
ce4c91dd9a link-fixup; move navigation 2020-03-26 19:26:38 -04:00
Jeff Escalante
c320055223 Anchor Link Fixes (#7287) 2020-03-26 16:21:24 -04:00
Chris Baker
f4b01e5036 Update website/pages/api-docs/jobs.mdx
Co-Authored-By: James Rasell <jrasell@users.noreply.github.com>
2020-03-25 07:51:25 -05:00
Chris Baker
80cb81b8f5 added documentation for scaling stanza 2020-03-24 22:36:27 +00:00