OpenSearch/docs/reference/cat/allocation.asciidoc

[[cat-allocation]]
== cat allocation

`allocation` provides a snapshot of how many shards are allocated to each data node
and how much disk space they are using.

[source,js]
--------------------------------------------------
GET /_cat/allocation?v
--------------------------------------------------
// CONSOLE
// TEST[s/^/PUT test\n{"settings": {"number_of_replicas": 0}}\n/]

Might respond with:

[source,js]
--------------------------------------------------
shards disk.indices disk.used disk.avail disk.total disk.percent host      ip        node
     5         260b    47.3gb     43.4gb    100.7gb           46 127.0.0.1 127.0.0.1 CSUXak2
--------------------------------------------------
// TESTRESPONSE[s/260b/\\d+b/ s/\d+(\.\d+)?[tgmk]?b/\\d+(\\.\\d+)?[tgmk]?b/ s/46/\\d+/]
// TESTRESPONSE[s/CSUXak2/.+/ _cat]

Here we can see that each node has been allocated a single shard and
that they're all using about the same amount of space.
First pass at cat docs. 2013-11-14 20:14:39 -05:00			`[[cat-allocation]]`
[DOCS] Renamed the "cat" chapters to be more searchable 2014-05-16 15:43:35 -04:00			`== cat allocation`
First pass at cat docs. 2013-11-14 20:14:39 -05:00
Filtered out non data-nodes in relevant cat api Closes #9214 Closes #9287 2015-02-06 01:31:17 -05:00			`allocation` provides a snapshot of how many shards are allocated to each data node
			`and how much disk space they are using.`
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			`[source,js]`
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			`// CONSOLE`
			`// TEST[s/^/PUT test\n{"settings": {"number_of_replicas": 0}}\n/]`

			`Might respond with:`

			`[source,js]`
			`--------------------------------------------------`
			`shards disk.indices disk.used disk.avail disk.total disk.percent host ip node`
Fix broken regex in doc tests Regexes are hard. 2016-10-06 13:52:39 -04:00			`5 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			`--------------------------------------------------`
Fix broken regex in doc tests Regexes are hard. 2016-10-06 13:52:39 -04:00			`// TESTRESPONSE[s/260b/\\d+b/ s/\d+(\.\d+)?[tgmk]?b/\\d+(\\.\\d+)?[tgmk]?b/ s/46/\\d+/]`
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			`// TESTRESPONSE[s/CSUXak2/.+/ _cat]`
First pass at cat docs. 2013-11-14 20:14:39 -05:00
			`Here we can see that each node has been allocated a single shard and`
			`that they're all using about the same amount of space.`