Skip to content

Commit c2d8986

Browse files
committed
convert include_hidden
1 parent 40f184a commit c2d8986

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/elasticsearch/client/curator/current/option_include_hidden.html
4+
---
5+
6+
# include_hidden
7+
8+
This option allows Curator to act on indices with the setting `hidden: true`,
9+
which is common with data_streams.
10+
11+
:::{important}
12+
If data_stream backing indices are matched by the `search_pattern` and/or after the filters, any attempt to delete the active backing index will result in an error code. The only way to delete all of a data_stream is via the data_stream API.
13+
:::
14+
15+
```yml
16+
action: delete_indices
17+
description: "Delete the specified indices"
18+
options:
19+
include_hidden: true
20+
filters:
21+
- filtertype: ...
22+
```
23+
24+
The value of this setting must be either `true` or `false`.
25+
26+
The default value for this setting is `false`.

docs/reference/options.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Options are settings used by [actions](/reference/actions.md).
2020
* [ignore_unavailable](/reference/option_ignore.md)
2121
* [include_aliases](/reference/option_include_aliases.md)
2222
* [include_global_state](/reference/option_include_gs.md)
23+
* [include_hidden](/reference/option_include_hidden.md)
2324
* [indices](/reference/option_indices.md)
2425
* [key](/reference/option_key.md)
2526
* [max_age](/reference/option_max_age.md)

docs/reference/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ toc:
6666
- file: option_ignore.md
6767
- file: option_include_aliases.md
6868
- file: option_include_gs.md
69+
- file: option_include_hidden.md
6970
- file: option_indices.md
7071
- file: option_key.md
7172
- file: option_max_age.md

0 commit comments

Comments
 (0)