github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/configuration/search.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: search Stanza - Agent Configuration
     4  sidebar_title: search
     5  description: >-
     6    The "search" stanza specifies configuration for the search API provided
     7    by the Nomad servers.
     8  ---
     9  
    10  # `search` Stanza
    11  
    12  <Placement
    13    groups={[
    14      ['server', 'search'],
    15    ]}
    16  />
    17  
    18  The `search` stanza specifies configuration for the search API provided by the
    19  Nomad servers.
    20  
    21  ```hcl
    22  server {
    23    search {
    24      fuzzy_enabled   = true
    25      limit_query     = 200
    26      limit_results   = 1000
    27      min_term_length = 5
    28    }
    29  }
    30  ```
    31  
    32  ## `search` Parameters
    33  
    34  - `fuzzy_enabled` `(bool: true)` - Specifies whether the [fuzzy search API][fuzzy]
    35    is enabled. If not enabled, requests to the fuzzy search API endpoint will return
    36    an error response.
    37  
    38  - `limit_query` `(int: 20)` - Specifies the maximum number of Nomad objects to
    39    search through per context type in the Nomad server before truncating results.
    40    Setting this parameter to a high value may degrade Nomad server performance.
    41  
    42  - `limit_results` `(int: 100)` - Specifies the maximum number of matching results
    43    to accumulate per context type in the API response before truncating results.
    44    Setting this parameter to a high value may cause excessively large API response sizes.
    45  
    46  - `min_term_length` `(int: 2)` - Specifies the minimum size of the search term
    47    allowed for matching with the fuzzy search API. Setting this value higher can
    48    prevent unnecessary load on the Nomad server from broad queries.
    49  
    50  [fuzzy]: /api-docs/search#fuzzy-searching