Commit Graph

40 Commits

Author SHA1 Message Date
Charlie Voiselle
8ba714e211 Return SchedulerConfig instead of SchedulerConfigResponse struct (#10799) 2021-10-13 21:23:13 -04:00
James Rasell
e8e25a2f38 docs: fix API docs node evaluate example call. 2021-09-24 10:28:22 +01:00
Andy Assareh
e74d2d991b suggest changing port number to nomad default (#11140)
i found this confusing since 8300 is associated with consul. suggest using more nomad ports
2021-09-03 20:15:32 -04:00
Isabel Suchanek
1eea499b8a events: fix wildcard namespace handling (#10935)
This fixes a bug in the event stream API where it currently interprets
namespace=* as an actual namespace, not a wildcard. When Nomad parses
incoming requests, it sets namespace to default if not specified, which
means the request namespace will never be an empty string, which is what
the event subscription was checking for. This changes the conditional
logic to check for a wildcard namespace instead of an empty one.

It also updates some event tests to include the default namespace in the
subscription to match current behavior.

Fixes #10903
2021-09-02 09:36:55 -07:00
Michael Lange
01cd1485af Mention the ndjson standard format the event stream uses
Knowing this upfront is important when looking for common libraries to help consume events.
2021-08-30 11:53:38 -07:00
Michael Schurter
734f1d7eb6 Merge pull request #10848 from ggriffiths/listsnapshot_secrets
CSI Listsnapshot secrets support
2021-08-10 15:59:33 -07:00
Ignacio Torres Masdeu
eb4ad96953 Fix allocation restart API docs example 2021-07-30 16:45:21 +02:00
Grant Griffiths
cba476eae6 CSI ListSnapshots secrets implementation
Signed-off-by: Grant Griffiths <ggriffiths@purestorage.com>
2021-07-28 11:30:29 -07:00
James Rasell
c3c50e33da docs: fixup regions API documentation path to include version. 2021-07-21 12:14:19 +02:00
Chris Baker
140e7b3aaa Node Drain Metadata (#10250) 2021-05-07 13:58:40 -04:00
Mahmood Ali
cada70dd91 annotate 1.1 beta fields 2021-05-07 10:21:16 -04:00
Mahmood Ali
1bca427855 Remove a stale note about 0.9 scheduler config 2021-05-07 10:21:16 -04:00
Mahmood Ali
de1e91987c Docs memory oversubscription (#10478)
* update docs

* document memory_oversubscription_enabled scheduler config
2021-04-30 14:07:56 -04:00
Tim Gross
88f1556279 docs: remove API doc for license PUT 2021-04-30 10:39:21 -04:00
Marcus Naughton
e2434d3527 Update libraries-and-sdks.mdx 2021-04-27 16:34:55 -04:00
Buck Doyle
0d058e5110 docs: Fix minor fuzzy search things (#10423) 2021-04-21 14:55:17 -05:00
Seth Hoenig
068fd431ad api: fuzzy search results include job name with id in scope 2021-04-16 17:03:36 -06:00
Seth Hoenig
350d9ebc40 api: implement fuzzy search API
This PR introduces the /v1/search/fuzzy API endpoint, used for fuzzy
searching objects in Nomad. The fuzzy search endpoint routes requests
to the Nomad Server leader, which implements the Search.FuzzySearch RPC
method.

Requests to the fuzzy search API are based on the api.FuzzySearchRequest
object, e.g.

{
  "Text": "ed",
  "Context": "all"
}

Responses from the fuzzy search API are based on the api.FuzzySearchResponse
object, e.g.

{
  "Index": 27,
  "KnownLeader": true,
  "LastContact": 0,
  "Matches": {
    "tasks": [
      {
        "ID": "redis",
        "Scope": [
          "default",
          "example",
          "cache"
        ]
      }
    ],
    "evals": [],
    "deployment": [],
    "volumes": [],
    "scaling_policy": [],
    "images": [
      {
        "ID": "redis:3.2",
        "Scope": [
          "default",
          "example",
          "cache",
          "redis"
        ]
      }
    ]
  },
  "Truncations": {
    "volumes": false,
    "scaling_policy": false,
    "evals": false,
    "deployment": false
  }
}

The API is tunable using the new server.search stanza, e.g.

server {
  search {
    fuzzy_enabled   = true
    limit_query     = 200
    limit_results   = 1000
    min_term_length = 5
  }
}

These values can be increased or decreased, so as to provide more
search results or to reduce load on the Nomad Server. The fuzzy search
API can be disabled entirely by setting `fuzzy_enabled` to `false`.
2021-04-16 16:36:07 -06:00
Nick Spain
8797e33438 Fix indentation of service check API documentation 2021-04-13 09:15:35 -04:00
Nick Spain
5cae8f1d84 Document usage of 'body' field 2021-04-13 09:15:35 -04:00
Michael Schurter
e35c5b5b80 docs: clarify alloc signal behavior
The API docs don't make it immediately clear that the alloc signal API signals *all* tasks in an allocation if the `Task` parameter is omitted. You have to dig all the way down into the alloc runner to discover that behavior: https://github.com/hashicorp/nomad/blob/v1.0.4/client/allocrunner/alloc_runner.go#L1189-L1213
2021-04-09 12:57:19 -07:00
Tim Gross
7681be1ccf CSI: API docs for create and snapshot workflows 2021-04-09 09:49:06 -04:00
Bryce Kalow
ee79587a67 feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
Daniel Santos
26ba3fa9d3 Update /v1/job API docs with namespace parameter 2021-03-24 09:31:39 -04:00
Drew Bailey
4484d361ee configuration and oss components for licensing (#10216)
* configuration and oss components for licensing

* vendor sync
2021-03-23 09:08:14 -04:00
Michael Schurter
927392462c docs: remove mention of api versioning
We've only ever had 1 API version, and we've broken backward
compatibility extremely rarely. Nothing changed about this with the
release of 1.0, let's just remove these sentences and save everybody
some reading.
2021-03-12 08:51:22 -08:00
Tim Gross
f9cf36d43a HTTP API support for 'nomad ui -login'
Endpoints for requesting and exchanging one-time tokens via the HTTP
API. Includes documentation updates.
2021-03-10 08:17:56 -05:00
Tim Gross
df298a44d9 docs: update website links from master to main 2021-03-09 14:42:24 -05:00
Kris Hicks
d03afe26b0 docs: Update sample JSON in Create Job API (#10108)
This is maybe a more realistic job that someone would actually submit
via the API; it more closely aligns with the example job from `nomad
job init`.

It's also been updated to use group network and service definitions.
2021-03-08 10:06:28 -08:00
Andrea Simonini
2dbb964d72 Fixed typos 2021-03-01 08:16:00 -05:00
Drew Bailey
4fd633e010 remove invalid duplicate (#9850) 2021-01-19 11:03:06 -05:00
Buck Doyle
017b47dfb4 Add documentation for exec websocket (#9679) 2021-01-08 14:01:06 -06:00
Michael Lange
590e7ca5e0 Update the page param default to 1 instead of 0 2021-01-07 09:59:09 -08:00
Michael Lange
f2d7ecd394 Typo fixes
Co-authored-by: Buck Doyle <buck@hashicorp.com>
2021-01-07 09:59:08 -08:00
Michael Lange
a6fa1eb457 Update 'Node' to 'Client' which is used throughout the UI 2021-01-07 09:59:08 -08:00
Michael Lange
f777d57f07 Add missing faceted search query params 2021-01-07 09:59:08 -08:00
Michael Lange
e965804289 Remove no longer true enteprise warning 2021-01-07 09:59:08 -08:00
Michael Lange
0642278a01 Remove version introduction
0.7 is ancient at this point. Now it's as if the UI has always existed.
2021-01-07 09:59:07 -08:00
Michael Lange
68770753f8 Add missing routes to the UI API doc 2021-01-07 09:59:07 -08:00
Jeff Escalante
0eae603a86 implement mdx remote 2021-01-05 19:02:39 -05:00