honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/cat/allocation.asciidoc

63 lines
1.8 KiB
Plaintext
Raw Normal View History

First pass at cat docs.
2013-11-14 20:14:39 -05:00
[[cat-allocation]]
[DOCS] Reformat cat API titles (#45407)
2019-08-13 08:35:08 -04:00
=== cat allocation API
++++
<titleabbrev>cat allocation</titleabbrev>
++++
First pass at cat docs.
2013-11-14 20:14:39 -05:00
[DOCS] Reformats cat allocation API (#45158)
2019-08-05 11:17:37 -04:00
Provides a snapshot of the number of shards allocated to each data node
and their disk space.
[[cat-allocation-api-request]]
==== {api-request-title}
Change `{var}` convention to `<var>` (#45904)
2019-08-23 10:57:20 -04:00
`GET /_cat/allocation/<node_id>`
[DOCS] Reformats cat allocation API (#45158)
2019-08-05 11:17:37 -04:00
[DOCS] Document `bytes` and `time` params in cat API docs (#47672) (#47854)
2019-10-10 09:48:40 -04:00
`GET /_cat/allocation`
[DOCS] Reformats cat allocation API (#45158)
2019-08-05 11:17:37 -04:00
[[cat-allocation-api-path-params]]
==== {api-path-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id]
[[cat-allocation-api-query-params]]
==== {api-query-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-allocation-api-example]]
==== {api-examples-title}
First pass at cat docs.
2013-11-14 20:14:39 -05:00
[DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) (#46502)
2019-09-09 13:38:14 -04:00
[source,console]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
GET /_cat/allocation?v
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
// TEST[s/^/PUT test\n{"settings": {"number_of_replicas": 0}}\n/]
[DOCS] Reformats cat allocation API (#45158)
2019-08-05 11:17:37 -04:00
The API returns the following response:
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160
2016-10-25 10:56:30 -04:00
[source,txt]
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
--------------------------------------------------
shards disk.indices disk.used disk.avail disk.total disk.percent host ip node
Default to one shard (#30539) This commit changes the default out-of-the-box configuration for the number of shards from five to one. We think this will help address a common problem of oversharding. For users with time-based indices that need a different default, this can be managed with index templates. For users with non-time-based indices that find they need to re-shard with the split API in place they no longer need to resort only to reindexing. Since this has the impact of changing the default number of shards used in REST tests, we want to ensure that we still have coverage for issues that could arise from multiple shards. As such, we randomize (rarely) the default number of shards in REST tests to two. This is managed via a global index template. However, some tests check the templates that are in the cluster state during the test. Since this template is randomly there, we need a way for tests to skip adding the template used to set the number of shards to two. For this we add the default_shards feature skip. To avoid having to write our docs in a complicated way because sometimes they might be behind one shard, and sometimes they might be behind two shards we apply the default_shards feature skip to all docs tests. That is, these tests will always run with the default number of shards (one).
2018-05-14 12:22:35 -04:00
1 260b 47.3gb 43.4gb 100.7gb 46 127.0.0.1 127.0.0.1 CSUXak2
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
--------------------------------------------------
[Test] Fix reference/cat/allocation/line_8 test failure In this test, 260b is replaced by the regexp \d+b but the test sometimes produces results like 1.1kb so this commit adapts the regexp to match values with decimals
2017-09-18 04:46:02 -04:00
// TESTRESPONSE[s/\d+(\.\d+)?[tgmk]?b/\\d+(\\.\\d+)?[tgmk]?b/ s/46/\\d+/]
[DOCS] Change `// TESTRESPONSE[_cat]` to `// TESTRESPONSE[non_json]` (#43006)
2019-06-10 09:33:32 -04:00
// TESTRESPONSE[s/CSUXak2/.+/ non_json]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
[DOCS] Reformats cat allocation API (#45158)
2019-08-05 11:17:37 -04:00
This response shows a single shard is allocated to the one node available.