Skip to content

[docs] Fix various syntax and rendering errors #1760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Before creating a filtered alias, first ensure that the fields already exist in
::::


Learn more about adding filtering and routing to aliases in the [Elasticsearch Alias API documentation](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-aliases.md).
Learn more about adding filtering and routing to aliases in the [Elasticsearch Alias API documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases).

## Required settings [_required_settings]

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Empty values and commented lines will result in the default value, if any, being

This action changes the shard routing allocation for the selected indices.

See [http://www.elastic.co/guide/en/elasticsearch/reference/8.15/shard-allocation-filtering.html](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/shard-allocation-filtering.html) for more information.
See [Index-level shard allocation](docs-content://deploy-manage/distributed-architecture/shard-allocation-relocation-recovery/index-level-shard-allocation.md) for more information.

You can optionally set `wait_for_completion` to `True` to have Curator wait for the shard routing to complete before continuing:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cluster_routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Empty values and commented lines will result in the default value, if any, being

This action changes the shard routing allocation for the selected indices.

See [http://www.elastic.co/guide/en/elasticsearch/reference/8.15/shards-allocation.html](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/shards-allocation.md) for more information.
See [Cluster-level shard allocation settings](elasticsearch://reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings.md#cluster-shard-allocation-settings) for more information.

You can optionally set `wait_for_completion` to `True` to have Curator wait for the shard routing to complete before continuing:

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cold2frozen.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This action migrates the selected non-ILM indices from the cold tier to the froz

Settings that should be added to the index when it is mounted. This should be a YAML dictionary containing anything under what would normally appear in `settings`.

See [http://www.elastic.co/guide/en/elasticsearch/reference/8.15/searchable-snapshots-api-mount-snapshot.html](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/searchable-snapshots-api-mount-snapshot.md)
See the [Elasticsearch Searchable snapshots API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-mount).

```yaml
action: cold2frozen
Expand All @@ -59,7 +59,7 @@ If unset, the default behavior is to ensure that the `_tier_preference` is `data

This should be a YAML list of index settings the migrated index should ignore after mount.

See [http://www.elastic.co/guide/en/elasticsearch/reference/8.15/searchable-snapshots-api-mount-snapshot.html](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/searchable-snapshots-api-mount-snapshot.md)
See the [Elasticsearch Searchable snapshots API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-mount).

```yaml
action: cold2frozen
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/create_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ options:
# ...
```

For the `create_index` action, the [name](/reference/option_name.md) option can be in Elasticsearch [date math](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/api-conventions.md#api-date-math-index-names) format. This allows index names containing dates to use deterministic math to set a date name in the past or the future.
For the `create_index` action, the [name](/reference/option_name.md) option can be in Elasticsearch [date math](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#api-date-math-index-names) format. This allows index names containing dates to use deterministic math to set a date name in the past or the future.

For example, if today’s date were 2017-03-27, the name `<logstash-{now/d}>` will create an index named `logstash-2017.03.27`. If you wanted to create *tomorrow’s* index, you would use the name `<logstash-{now/d+1d}>`, which adds 1 day. This pattern creates an index named `logstash-2017.03.28`. For many more configuration options, read the Elasticsearch [date math](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/api-conventions.md#api-date-math-index-names) documentation.
For example, if today’s date were 2017-03-27, the name `<logstash-{now/d}>` will create an index named `logstash-2017.03.27`. If you wanted to create *tomorrow’s* index, you would use the name `<logstash-{now/d+1d}>`, which adds 1 day. This pattern creates an index named `logstash-2017.03.28`. For many more configuration options, read the Elasticsearch [date math](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#api-date-math-index-names) documentation.


## Extra Settings [_extra_settings]
Expand Down Expand Up @@ -90,7 +90,7 @@ options:

## Optional settings [_optional_settings_6]

* [extra_settings](/reference/option_extra_settings.md) No default value. You can add any acceptable index settings and mappings as nested YAML. See the [Elasticsearch Create Index API documentation](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-create-index.md) for more information.
* [extra_settings](/reference/option_extra_settings.md) No default value. You can add any acceptable index settings and mappings as nested YAML. See the [Elasticsearch Create Index API documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create) for more information.
* [timeout_override](/reference/option_timeout_override.md)
* [continue_if_exception](/reference/option_continue.md)
* [disable_action](/reference/option_disable.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/curator-ilm.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ mapped_pages:

# Curator and index lifecycle management [ilm]

Beginning with Elasticsearch version 6.6, Elasticsearch has provided [Index Lifecycle Management](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/index-lifecycle-management.md) (ILM) to users with at least a Basic license. ILM provides users with many of the most common index management features as a matter of policy, rather than execution time analysis (which is how Curator works).
Beginning with Elasticsearch version 6.6, Elasticsearch has provided [Index Lifecycle Management](docs-content://manage-data/lifecycle/index-lifecycle-management.md) (ILM) to users with at least a Basic license. ILM provides users with many of the most common index management features as a matter of policy, rather than execution time analysis (which is how Curator works).

2 changes: 1 addition & 1 deletion docs/reference/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Curator is periodically published to Docker Hub at [`untergeek/curator`](https:/

Download Curator Docker image:

```
```sh subs=true
docker pull untergeek/curator:{{curator_version}}
```

5 changes: 2 additions & 3 deletions docs/reference/faq_partial_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ While it may be desirable to have different life-cycles for your data, sometimes

#### Post-script: [_post_script]

Even though it is neither recommended <sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>(http://blog.mikemccandless.com/2011/02/visualizing-lucenes-segment-merges.md) and watch what happens to your segments when you delete data.], nor best practices, it is still possible to perform these search & delete operations yourself, using the [Delete-by-Query API](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/docs-delete-by-query.md). Curator will not be modified to perform operations such as these, however. Curator is meant to manage at the index level, rather than the data level.

<hr>
Even though it is neither recommended[¹](#footnote-1), nor best practices, it is still possible to perform these search & delete operations yourself, using the [Delete-by-Query API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query). Curator will not be modified to perform operations such as these, however. Curator is meant to manage at the index level, rather than the data level.

¹ $$$footnote-1$$$ There are reasons Elasticsearch does not recommend this, particularly for time-series data. For more information read [http://blog.mikemccandless.com/2011/02/visualizing-lucenes-segment-merges.html](http://blog.mikemccandless.com/2011/02/visualizing-lucenes-segment-merges.html) and watch what happens to your segments when you delete data.
2 changes: 1 addition & 1 deletion docs/reference/fe_allocation_type.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This setting is used only when using the [allocated](/reference/filtertype_alloc

The value of this setting must be one of `require`, `include`, or `exclude`.

Read more about these settings in the [Elasticsearch documentation](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/shard-allocation-filtering.html).
Read more about these settings in [Index-level shard allocation](docs-content://deploy-manage/distributed-architecture/shard-allocation-relocation-recovery/index-level-shard-allocation.md).

The default value for this setting is `require`.

2 changes: 1 addition & 1 deletion docs/reference/fe_pattern.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This particular example will match indices following the basic rollover pattern

For example, given indices `a-000001`, `a-000002`, `a-000003` and `b-000006`, and `b-000007`, the indices will would be matched are `a-000003` and `b-000007`. Indices that do not match the regular expression in `pattern` will be automatically excluded.

This is particularly useful with indices created and managed using the [Rollover API](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-rollover-index.md), as you can select only the active indices with the above example ([`exclude`](/reference/fe_exclude.md) defaults to `False`). Setting [`exclude`](/reference/fe_exclude.md) to `True` with the above example will *remove* the active rollover indices, leaving only those which have been rolled-over.
This is particularly useful with indices created and managed using the [Rollover API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover), as you can select only the active indices with the above example ([`exclude`](/reference/fe_exclude.md) defaults to `False`). Setting [`exclude`](/reference/fe_exclude.md) to `True` with the above example will *remove* the active rollover indices, leaving only those which have been rolled-over.

While this is perhaps most useful for the aforementioned scenario, it can also be used with age-based indices as well.

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/fe_unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ point_of_reference = epoch - ((number of seconds in unit) * unit_count)
| --- | --- | --- |
| `seconds` | `1` | One second |
| `minutes` | `60` | Calculated as 60 seconds |
| `hours` | `3600` | Calculated as 60 minutes (60*60) |
| `days` | `86400` | Calculated as 24 hours (24*60*60) |
| `weeks` | `604800` | Calculated as 7 days (7*24*60*60) |
| `months` | `2592000` | Calculated as 30 days (30*24*60*60) |
| `years` | `31536000` | Calculated as 365 days (365*24*60*60) |
| `hours` | `3600` | Calculated as 60 minutes (`60 * 60`) |
| `days` | `86400` | Calculated as 24 hours (`24 * 60 * 60`) |
| `weeks` | `604800` | Calculated as 7 days (`7 * 24 * 60 * 60`) |
| `months` | `2592000` | Calculated as 30 days (`30 * 24 * 60 * 60`) |
| `years` | `31536000` | Calculated as 365 days (`365 * 24 * 60 * 60`) |

If [epoch](/reference/fe_epoch.md) is unset, the current time is used. It is possible to set a point of reference in the future by using a negative value for [unit_count](/reference/fe_unit_count.md).

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/fe_unit_count.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ point_of_reference = epoch - ((number of seconds in unit) * unit_count)
| --- | --- | --- |
| `seconds` | `1` | One second |
| `minutes` | `60` | Calculated as 60 seconds |
| `hours` | `3600` | Calculated as 60 minutes (60*60) |
| `days` | `86400` | Calculated as 24 hours (24*60*60) |
| `weeks` | `604800` | Calculated as 7 days (7*24*60*60) |
| `months` | `2592000` | Calculated as 30 days (30*24*60*60) |
| `years` | `31536000` | Calculated as 365 days (365*24*60*60) |
| `hours` | `3600` | Calculated as 60 minutes (`60 * 60`) |
| `days` | `86400` | Calculated as 24 hours (`24 * 60 * 60`) |
| `weeks` | `604800` | Calculated as 7 days (`7 * 24 * 60 * 60`) |
| `months` | `2592000` | Calculated as 30 days (`30 * 24 * 60 * 60`) |
| `years` | `31536000` | Calculated as 365 days (`365 * 24 * 60 * 60`) |

If [epoch](/reference/fe_epoch.md) is unset, the current time is used. It is possible to set a point of reference in the future by using a negative value for unit_count.

Expand Down
12 changes: 6 additions & 6 deletions docs/reference/filtertype_age.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ This [filtertype](/reference/filtertype.md) will iterate over the actionable lis
| --- | --- | --- |
| `seconds` | `1` | One second |
| `minutes` | `60` | Calculated as 60 seconds |
| `hours` | `3600` | Calculated as 60 minutes (60*60) |
| `days` | `86400` | Calculated as 24 hours (24*60*60) |
| `weeks` | `604800` | Calculated as 7 days (7*24*60*60) |
| `months` | `2592000` | Calculated as 30 days (30*24*60*60) |
| `years` | `31536000` | Calculated as 365 days (365*24*60*60) |
| `hours` | `3600` | Calculated as 60 minutes (`60 * 60`) |
| `days` | `86400` | Calculated as 24 hours (`24 * 60 * 60`) |
| `weeks` | `604800` | Calculated as 7 days (`7 * 24 * 60 * 60`) |
| `months` | `2592000` | Calculated as 30 days (`30 * 24 * 60 * 60`) |
| `years` | `31536000` | Calculated as 365 days (`365 * 24 * 60 * 60`) |

All calculations are in epoch time, which is the number of seconds elapsed since 1 Jan 1970. If no [`epoch`](/reference/fe_epoch.md) is specified in the filter, then the current epoch time-which is always UTC-is used as the basis for comparison.

Expand All @@ -44,7 +44,7 @@ For example, if the time at execution were 2017-04-07T15:00:00Z (UTC), then the

The time differential would be `3*24*60*60` seconds, which is `259200` seconds. Subtracting this value from `1491577200` gives us `1491318000`, which is 2017-04-04T15:00:00Z (UTC), exactly 3 days in the past. The `creation_date` of indices or snapshots is compared to this timestamp. If it is `older`, it stays in the actionable list, otherwise it is removed from the actionable list.

::::{admonition} `age` filter vs. `period` filter
::::{admonition} age filter vs. period filter
:class: important

The time differential means of calculation can lead to frustration.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/filtertype_count.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This particular example will match indices following the basic rollover pattern

For example, given indices `a-000001`, `a-000002`, `a-000003` and `b-000006`, and `b-000007`, the indices will would be matched are `a-000003` and `b-000007`. Indices that do not match the regular expression in `pattern` will be automatically excluded.

This is particularly useful with indices created and managed using the [Rollover API](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-rollover-index.md), as you can select only the active indices with the above example ([`exclude`](/reference/fe_exclude.md) defaults to `False`). Setting [`exclude`](/reference/fe_exclude.md) to `True` with the above example will *remove* the active rollover indices, leaving only those which have been rolled-over.
This is particularly useful with indices created and managed using the [Rollover API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover), as you can select only the active indices with the above example ([`exclude`](/reference/fe_exclude.md) defaults to `False`). Setting [`exclude`](/reference/fe_exclude.md) to `True` with the above example will *remove* the active rollover indices, leaving only those which have been rolled-over.

While this is perhaps most useful for the aforementioned scenario, it can also be used with age-based indices as well.

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/filtertype_period.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,11 @@ The period filter is smart enough to calculate `months` and `years` properly. *
| --- | --- | --- |
| `seconds` | `1` | One second |
| `minutes` | `60` | Calculated as 60 seconds |
| `hours` | `3600` | Calculated as 60 minutes (60*60) |
| `days` | `86400` | Calculated as 24 hours (24*60*60) |
| `weeks` | `604800` | Calculated as 7 days (7*24*60*60) |
| `months` | `2592000` | Calculated as 30 days (30*24*60*60) |
| `years` | `31536000` | Calculated as 365 days (365*24*60*60) |
| `hours` | `3600` | Calculated as 60 minutes (`60 * 60`) |
| `days` | `86400` | Calculated as 24 hours (`24 * 60 * 60`) |
| `weeks` | `604800` | Calculated as 7 days (`7 * 24 * 60 * 60`) |
| `months` | `2592000` | Calculated as 30 days (`30 * 24 * 60 * 60`) |
| `years` | `31536000` | Calculated as 365 days (`365 * 24 * 60 * 60`) |

::::

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/forcemerge.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Empty values and commented lines will result in the default value, if any, being
This action performs a forceMerge on the selected indices, merging them to [max_num_segments](/reference/option_mns.md) per shard.

::::{warning}
A [`forcemerge`](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-forcemerge.md#indices-forcemerge) should never be executed on an index that is actively receiving data. It should only ever be performed on indices where no more documents are ever anticipated to be added in the future.
A [`forcemerge`](https://www.elastic.co/docs/api/doc/elasticsearch/) should never be executed on an index that is actively receiving data. It should only ever be performed on indices where no more documents are ever anticipated to be added in the future.
::::


Expand Down
16 changes: 8 additions & 8 deletions docs/reference/ilm-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ ILM applies policy actions as indices enter time-oriented phases:

The policy actions include:

* [Set Priority](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-set-priority.md)
* [Rollover](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-rollover.md)
* [Unfollow](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-unfollow.md)
* [Allocate](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-allocate.md)
* [Read-Only](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-readonly.md)
* [Force Merge](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-forcemerge.md)
* [Shrink](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-shrink.md)
* [Delete](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/ilm-delete.md)
* [Set Priority](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-set-priority.md)
* [Rollover](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-rollover.md)
* [Unfollow](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-unfollow.md)
* [Allocate](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-allocate.md)
* [Read-Only](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-readonly.md)
* [Force Merge](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-forcemerge.md)
* [Shrink](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-shrink.md)
* [Delete](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-delete.md)

2 changes: 1 addition & 1 deletion docs/reference/ilm-and-curator.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Curator and ILM *can* coexist. However, to prevent Curator from accidentally int

Curator can be configured to work with ILM-enabled indices by setting the [`allow_ilm_indices`](/reference/option_allow_ilm.md) option to `true` for any action.

Learn more about Index Lifecycle Management [here](http://www.elastic.co/guide/en/elasticsearch/reference/8.15/index-lifecycle-management.md).
Learn more in [Index lifecycle management](docs-content://manage-data/lifecycle/index-lifecycle-management.md).

Loading