Commit graph

72 commits

Author SHA1 Message Date
Tim Gross 4e79ddea45
csi/api: populate ReadAllocs/WriteAllocs fields (#9377)
The API is missing values for `ReadAllocs` and `WriteAllocs` fields, resulting
in allocation claims not being populated in the web UI. These fields mirror
the fields in `nomad/structs.CSIVolume`. Returning a separate list of stubs
for read and write would be ideal, but this can't be done without either
bloating the API response with repeated full `Allocation` data, or causing a
panic in previous versions of the CLI.

The `nomad/structs` fields are persisted with nil values and are populated
during RPC, so we'll do the same in the HTTP API and populate the `ReadAllocs`
and `WriteAllocs` fields with a map of allocation IDs, but with null
values. The web UI will then create its `ReadAllocations` and
`WriteAllocations` fields by mapping from those IDs to the values in
`Allocations`, instead of flattening the map into a list.
2020-11-25 16:44:06 -05:00
Tim Gross 2139e029ec docs: make dispatch payload size limit unambiguous 2020-11-19 12:06:49 -05:00
Chris Baker c8364656e6 document api.Allocation.Job field, to address issue from #9386 2020-11-18 15:00:52 +00:00
James Rasell f9480ca147
docs: move Ruby SDK to unsupported listing. 2020-11-16 11:38:27 +01:00
Mahmood Ali be11f735c2
Merge pull request #9205 from hashicorp/b-gh-7703
Repurpose dispatch-job capability to dispatch periodic jobs
2020-11-02 13:11:58 -05:00
Kris Hicks 1da9e7fc67
Add event sink API and CLI commands (#9226)
Co-authored-by: Drew Bailey <2614075+drewbailey@users.noreply.github.com>
2020-11-02 09:57:35 -08:00
Mahmood Ali a3755d526c update docs and changelog 2020-11-02 12:44:03 -05:00
James Rasell 6b9e47773c
Merge pull request #9187 from barakb/master
A non-blocking Kotlin SDK
2020-11-02 08:53:01 +01:00
James Rasell 9f980a9599
Merge pull request #9193 from hashicorp/f-dynamic-app-sizing-oss-docs-merge
docs: DAS related documentation updates
2020-10-27 17:32:00 +01:00
James Rasell 7c28880bd3
docs: update scaling policy API docs based on DAS update.
Includes removal of the beta tag from the scaling polices API
endpoints. \o/
2020-10-27 16:24:38 +01:00
James Rasell 2ccf69ac01
docs: add recommendations API documentation. 2020-10-27 16:23:38 +01:00
Drew Bailey 19fe9a8f83
event sink api docs (#9190) 2020-10-27 10:46:55 -04:00
Barak Bar Orion a61f261568
Update libraries-and-sdks.mdx
Add a third-party library, nomad-client is a fully non-blocking Kotlin nomad client with minimal dependencies.
2020-10-27 14:32:46 +02:00
Michael Schurter 2c78d6cb5d docs: namespaces are oss in Nomad 1.0 2020-10-22 15:26:32 -07:00
davidr912 3319269964
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 ea6fcf5f4e
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 7c3029b5e6 docs: document #9055 2020-10-14 10:41:32 -07:00
Ryan Oaks 536aab271d Format docs website code and mdx 2020-10-02 13:31:40 -04:00
José Maia 9e14dc90f9
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 9d85195361
[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 4515e89d8c
Fix sample JSON payload when updating a Volume (#8880)
Fixes #8879
2020-09-14 09:24:26 -04:00
Lang Martin 07ea822c6a
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 443fdaa86b
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 af446cec10 Update Reason to Message in the job scale docs 2020-07-30 09:06:08 -07:00
James Rasell 29fbc15bb5
docs: add Namespace field to scale status GET example. 2020-07-24 14:45:50 +02:00
Rémi Lapeyre 8f183abfd9
Fix typo in volume HTTP API documentation (#8396) 2020-07-09 08:33:45 -04:00
Nick Ethier 119ece09a0
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 111038513c
correcting CSI Plugins API sample response
neither `structs.CSIPlugin` nor `api.CSIPlugin` contain `topologies`
2020-07-07 16:17:23 -05:00
Chris Baker 4c20c5833e
Update plugins.mdx
bad example JSON response
2020-07-05 16:46:44 -05:00
Lang Martin ebfffbca20
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 68ec45dd0f document namespace=* in relevant APIs 2020-07-01 15:20:57 -04:00
Tim Gross 23be116da0
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 95a231551d
docs: add link to golang api GoDoc webpage (#7174) 2020-06-26 09:14:49 -04:00
Mahmood Ali c469afde93 document snapshot api endpoints 2020-06-19 10:37:00 -04:00
Luiz Aoqui ee204746bc
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 2f2527efd8
docs: update operator license API 2020-06-18 20:17:45 -04:00
Mahmood Ali 38a01c050e
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 63ae10f0d0
docs: multiregion deployment feature (#8185) 2020-06-18 08:41:22 -04:00
Mahmood Ali e784fe331a 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 1d40ab23b7 docs: updated website to this change 2020-06-17 17:44:58 +00:00
Drew Bailey 34c3a8674a
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 a73cd01a00
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 30cb844581 docs: preemption is no longer an Enterprise feature 2020-05-27 15:05:52 -04:00
James Rasell 779d58397a
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 d5fc981636
Merge branch 'master' into patch-3 2020-05-20 00:16:43 +05:30
Charlie Voiselle e63346560c
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 42d5a4136d docs: update snippet to include summary namespace 2020-05-19 10:06:53 -04:00
James Rasell 7bd35dd11c
docs: update CSI PUT operation blocking query support yes->no. 2020-05-19 08:42:48 +02:00
Jeff Escalante 636f174f48
fix shell-session snippet error 2020-05-18 16:53:06 -04:00
Mahmood Ali 5ab2d52e27 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