2015-05-24 11:57:34 -04:00
|
|
|
["appendix",role="exclude",id="redirects"]
|
|
|
|
= Deleted pages
|
|
|
|
|
|
|
|
The following pages have moved or been deleted.
|
|
|
|
|
|
|
|
[role="exclude",id="cluster-nodes-shutdown"]
|
|
|
|
=== Nodes shutdown
|
|
|
|
|
|
|
|
The `_shutdown` API has been removed. Instead, setup Elasticsearch to run as
|
2016-04-03 10:09:24 -04:00
|
|
|
a service (see <<rpm>>, <<deb>>, or <<windows>>) or use the `-p`
|
|
|
|
command line option to <<setup-installation-daemon,write the PID to a file>>.
|
2015-05-24 11:57:34 -04:00
|
|
|
|
2016-10-11 06:38:54 -04:00
|
|
|
[role="exclude",id="indices-upgrade"]
|
|
|
|
=== Upgrade API
|
|
|
|
|
|
|
|
The `_upgrade` API is no longer useful and will be removed. Instead, see
|
|
|
|
<<reindex-upgrade>>.
|
|
|
|
|
2019-03-18 15:46:56 -04:00
|
|
|
[role="exclude",id="migration-api-assistance"]
|
|
|
|
=== Migration Assistance API
|
|
|
|
|
|
|
|
The Migration Assistance API has been replaced with the
|
|
|
|
<<migration-api-deprecation, Deprecation Info API>>.
|
|
|
|
|
|
|
|
[role="exclude",id="migration-api-upgrade"]
|
|
|
|
=== Migration Upgrade API
|
|
|
|
|
|
|
|
The Migration Upgrade API has been removed. Use the
|
|
|
|
{kibana-ref}/upgrade-assistant.html[{kib} Upgrade Assistant] or
|
|
|
|
<<reindex-upgrade,Reindex manually>> instead.
|
|
|
|
|
2015-05-24 11:57:34 -04:00
|
|
|
[role="exclude",id="docs-bulk-udp"]
|
|
|
|
=== Bulk UDP API
|
|
|
|
|
|
|
|
The Bulk UDP services has been removed. Use the standard <<docs-bulk>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="indices-delete-mapping"]
|
|
|
|
=== Delete Mapping
|
|
|
|
|
|
|
|
It is no longer possible to delete the mapping for a type. Instead you should
|
|
|
|
<<indices-delete-index,delete the index>> and recreate it with the new mappings.
|
|
|
|
|
|
|
|
[role="exclude",id="indices-status"]
|
|
|
|
=== Index Status
|
|
|
|
|
|
|
|
The index `_status` API has been replaced with the <<indices-stats>> and
|
|
|
|
<<indices-recovery>> APIs.
|
|
|
|
|
|
|
|
[role="exclude",id="mapping-analyzer-field"]
|
|
|
|
=== `_analyzer`
|
|
|
|
|
|
|
|
The `_analyzer` field in type mappings is no longer supported and will be
|
|
|
|
automatically removed from mappings when upgrading to 2.x.
|
|
|
|
|
|
|
|
[role="exclude",id="mapping-boost-field"]
|
|
|
|
=== `_boost`
|
|
|
|
|
|
|
|
The `_boost` field in type mappings is no longer supported and will be
|
|
|
|
automatically removed from mappings when upgrading to 2.x.
|
|
|
|
|
|
|
|
[role="exclude",id="mapping-conf-mappings"]
|
|
|
|
=== Config mappings
|
|
|
|
|
|
|
|
It is no longer possible to specify mappings in files in the `config`
|
|
|
|
directory. Instead, mappings should be created using the API with:
|
|
|
|
|
|
|
|
* <<indices-create-index>>
|
|
|
|
* <<indices-put-mapping>>
|
|
|
|
* <<indices-templates>>
|
|
|
|
|
2017-07-05 06:30:19 -04:00
|
|
|
[role="exclude",id="mapping-parent-field"]
|
|
|
|
=== `_parent` field
|
|
|
|
|
|
|
|
The `_parent` field has been removed in favour of the <<parent-join,`join` field>>.
|
|
|
|
|
2018-04-11 07:48:53 -04:00
|
|
|
[role="exclude",id="mapping-uid-field"]
|
|
|
|
=== `_uid` field
|
|
|
|
|
|
|
|
The `_uid` field has been removed in favour of the <<mapping-id-field,`_id` field>>.
|
|
|
|
|
2015-05-24 11:57:34 -04:00
|
|
|
[role="exclude",id="modules-memcached"]
|
|
|
|
=== memcached
|
|
|
|
|
|
|
|
The `memcached` transport is no longer supported. Instead use the REST
|
|
|
|
interface over <<modules-http,HTTP>> or the
|
2017-02-04 06:05:03 -05:00
|
|
|
{javaclient}/index.html[Java API].
|
2015-05-24 11:57:34 -04:00
|
|
|
|
|
|
|
[role="exclude",id="modules-thrift"]
|
|
|
|
=== Thrift
|
|
|
|
|
|
|
|
The `thrift` transport is no longer supported. Instead use the REST
|
|
|
|
interface over <<modules-http,HTTP>> or the
|
2017-02-04 06:05:03 -05:00
|
|
|
{javaclient}/index.html[Java API].
|
2015-05-24 11:57:34 -04:00
|
|
|
|
|
|
|
// QUERY DSL
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-queries"]
|
|
|
|
=== Queries
|
|
|
|
|
|
|
|
Queries and filters have been merged. Any query clause can now be used as a query
|
|
|
|
in ``query context'' and as a filter in ``filter context'' (see <<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-filters"]
|
|
|
|
=== Filters
|
|
|
|
|
|
|
|
Queries and filters have been merged. Any query clause can now be used as a query
|
|
|
|
in ``query context'' and as a filter in ``filter context'' (see <<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-not-filter"]
|
|
|
|
=== Not Filter
|
|
|
|
|
2017-02-13 10:23:09 -05:00
|
|
|
The `not` query has been replaced by using a `must_not` clause in a `bool` query (see <<query-dsl-bool-query>>).
|
2015-05-24 11:57:34 -04:00
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-bool-filter"]
|
|
|
|
=== Bool Filter
|
|
|
|
|
|
|
|
The `bool` filter has been replaced by the <<query-dsl-bool-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-exists-filter"]
|
|
|
|
=== Exists Filter
|
|
|
|
|
|
|
|
The `exists` filter has been replaced by the <<query-dsl-exists-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-geo-bounding-box-filter"]
|
|
|
|
=== Geo Bounding Box Filter
|
|
|
|
|
|
|
|
The `geo_bounding_box` filter has been replaced by the <<query-dsl-geo-bounding-box-query>>.
|
|
|
|
It behaves as a query in ``query context'' and as a filter in ``filter
|
|
|
|
context'' (see <<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-geo-distance-filter"]
|
|
|
|
=== Geo Distance Filter
|
|
|
|
|
|
|
|
The `geo_distance` filter has been replaced by the <<query-dsl-geo-distance-query>>.
|
|
|
|
It behaves as a query in ``query context'' and as a filter in ``filter
|
|
|
|
context'' (see <<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-geo-distance-range-filter"]
|
|
|
|
=== Geo Distance Range Filter
|
|
|
|
|
|
|
|
The `geo_distance_range` filter has been replaced by the <<query-dsl-geo-distance-range-query>>.
|
|
|
|
It behaves as a query in ``query context'' and as a filter in ``filter
|
|
|
|
context'' (see <<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-geo-polygon-filter"]
|
|
|
|
=== Geo Polygon Filter
|
|
|
|
|
|
|
|
The `geo_polygon` filter has been replaced by the <<query-dsl-geo-polygon-query>>.
|
|
|
|
It behaves as a query in ``query context'' and as a filter in ``filter
|
|
|
|
context'' (see <<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-geo-shape-filter"]
|
|
|
|
=== Geo Shape Filter
|
|
|
|
|
|
|
|
The `geo_shape` filter has been replaced by the <<query-dsl-geo-shape-query>>.
|
|
|
|
It behaves as a query in ``query context'' and as a filter in ``filter
|
|
|
|
context'' (see <<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-has-child-filter"]
|
|
|
|
=== Has Child Filter
|
|
|
|
|
|
|
|
The `has_child` filter has been replaced by the <<query-dsl-has-child-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-has-parent-filter"]
|
|
|
|
=== Has Parent Filter
|
|
|
|
|
|
|
|
The `has_parent` filter has been replaced by the <<query-dsl-has-parent-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-top-children-query"]
|
|
|
|
=== Top Children Query
|
|
|
|
|
|
|
|
The `top_children` query has been removed. Use the <<query-dsl-has-child-query>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-ids-filter"]
|
|
|
|
=== IDs Filter
|
|
|
|
|
|
|
|
The `ids` filter has been replaced by the <<query-dsl-ids-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-match-all-filter"]
|
|
|
|
=== Match All Filter
|
|
|
|
|
|
|
|
The `match_all` filter has been replaced by the <<query-dsl-match-all-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-nested-filter"]
|
|
|
|
=== Nested Filter
|
|
|
|
|
|
|
|
The `nested` filter has been replaced by the <<query-dsl-nested-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-prefix-filter"]
|
|
|
|
=== Prefix Filter
|
|
|
|
|
|
|
|
The `prefix` filter has been replaced by the <<query-dsl-prefix-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-query-filter"]
|
|
|
|
=== Query Filter
|
|
|
|
|
|
|
|
The `query` filter has been removed as queries and filters have been merged (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-range-filter"]
|
|
|
|
=== Range Filter
|
|
|
|
|
|
|
|
The `range` filter has been replaced by the <<query-dsl-range-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-regexp-filter"]
|
|
|
|
=== Regexp Filter
|
|
|
|
|
|
|
|
The `regexp` filter has been replaced by the <<query-dsl-regexp-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-script-filter"]
|
|
|
|
=== Script Filter
|
|
|
|
|
|
|
|
The `script` filter has been replaced by the <<query-dsl-script-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-term-filter"]
|
|
|
|
=== Term Filter
|
|
|
|
|
|
|
|
The `term` filter has been replaced by the <<query-dsl-term-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-terms-filter"]
|
|
|
|
=== Terms Filter
|
|
|
|
|
|
|
|
The `terms` filter has been replaced by the <<query-dsl-terms-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-type-filter"]
|
|
|
|
=== Type Filter
|
|
|
|
|
|
|
|
The `type` filter has been replaced by the <<query-dsl-type-query>>. It behaves
|
|
|
|
as a query in ``query context'' and as a filter in ``filter context'' (see
|
|
|
|
<<query-dsl>>).
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-flt-query"]
|
|
|
|
=== Fuzzy Like This Query
|
|
|
|
|
2018-05-02 05:44:53 -04:00
|
|
|
The `fuzzy_like_this`, alternatively known as `flt`, query has been removed. Instead use either
|
2015-05-24 11:57:34 -04:00
|
|
|
the <<query-dsl-match-query-fuzziness,`fuzziness`>> parameter with the
|
|
|
|
<<query-dsl-match-query,`match` query>> or the <<query-dsl-mlt-query>>.
|
|
|
|
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-flt-field-query"]
|
|
|
|
=== Fuzzy Like This Field Query
|
|
|
|
|
|
|
|
The `fuzzy_like_this_field` or `flt_field` query has been removed. Instead use
|
|
|
|
the <<query-dsl-match-query-fuzziness,`fuzziness`>> parameter with the
|
|
|
|
<<query-dsl-match-query,`match` query>> or the <<query-dsl-mlt-query>>.
|
|
|
|
|
2016-11-30 10:36:55 -05:00
|
|
|
[role="exclude",id="query-dsl-geo-distance-range-query"]
|
|
|
|
=== Geo distance range Query
|
|
|
|
|
|
|
|
The `geo_distance_range` query has been removed. Instead use the
|
|
|
|
<<query-dsl-geo-distance-query, Geo Distance Query>> with pagination
|
|
|
|
or the
|
|
|
|
<<search-aggregations-bucket-geodistance-aggregation, Geo Distance Aggregation>>
|
|
|
|
depending on your needs.
|
|
|
|
|
2016-09-13 20:37:48 -04:00
|
|
|
[role="exclude",id="query-dsl-geohash-cell-query"]
|
|
|
|
=== Geohash Cell Query
|
|
|
|
|
2016-09-20 00:12:17 -04:00
|
|
|
The `geohash_cell` query has been removed. Instead use the
|
2016-09-13 20:37:48 -04:00
|
|
|
<<query-dsl-geo-bounding-box-query, Geo Bounding Box Query>>.
|
|
|
|
|
2015-05-24 11:57:34 -04:00
|
|
|
[role="exclude",id="search-more-like-this"]
|
|
|
|
=== More Like This API
|
|
|
|
|
|
|
|
The More Like This API has been removed. Instead, use the <<query-dsl-mlt-query>>.
|
|
|
|
|
|
|
|
// FACETS
|
|
|
|
|
2015-05-24 17:34:23 -04:00
|
|
|
[role="exclude",id="search-facets"]
|
|
|
|
=== Facets
|
|
|
|
|
|
|
|
Faceted search refers to a way to explore large amounts of data by displaying
|
|
|
|
summaries about various partitions of the data and later allowing to narrow
|
|
|
|
the navigation to a specific partition.
|
|
|
|
|
|
|
|
In Elasticsearch, `facets` are also the name of a feature that allowed to
|
|
|
|
compute these summaries. `facets` have been replaced by
|
|
|
|
<<search-aggregations, aggregations>> in Elasticsearch 1.0, which are a superset
|
|
|
|
of facets.
|
|
|
|
|
2015-05-24 11:57:34 -04:00
|
|
|
[role="exclude",id="search-facets-filter-facet"]
|
|
|
|
=== Filter Facet
|
|
|
|
|
|
|
|
Facets have been removed. Use the
|
|
|
|
<<search-aggregations-bucket-filter-aggregation,`filter` aggregation>> or
|
|
|
|
<<search-aggregations-bucket-filters-aggregation,`filters` aggregation>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="search-facets-query-facet"]
|
|
|
|
=== Query Facet
|
|
|
|
|
|
|
|
Facets have been removed. Use the
|
|
|
|
<<search-aggregations-bucket-filter-aggregation,`filter` aggregation>> or
|
|
|
|
<<search-aggregations-bucket-filters-aggregation,`filters` aggregation>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="search-facets-geo-distance-facet"]
|
|
|
|
=== Geo Distance Facet
|
|
|
|
|
|
|
|
Facets have been removed. Use the
|
|
|
|
<<search-aggregations-bucket-geodistance-aggregation,`geo_distance` aggregation>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="search-facets-histogram-facet"]
|
|
|
|
=== Histogram Facet
|
|
|
|
|
|
|
|
Facets have been removed. Use the
|
|
|
|
<<search-aggregations-bucket-histogram-aggregation,`histogram` aggregation>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="search-facets-date-histogram-facet"]
|
|
|
|
=== Date Histogram Facet
|
|
|
|
|
|
|
|
Facets have been removed. Use the
|
|
|
|
<<search-aggregations-bucket-datehistogram-aggregation,`date_histogram` aggregation>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="search-facets-range-facet"]
|
|
|
|
=== Range Facet
|
|
|
|
|
|
|
|
Facets have been removed. Use the
|
|
|
|
<<search-aggregations-bucket-range-aggregation,`range` aggregation>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="search-facets-terms-facet"]
|
|
|
|
=== Terms Facet
|
|
|
|
|
|
|
|
Facets have been removed. Use the
|
|
|
|
<<search-aggregations-bucket-terms-aggregation,`terms` aggregation>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="search-facets-terms-statistical-facet"]
|
|
|
|
=== Terms Stats Facet
|
|
|
|
|
|
|
|
Facets have been removed. Use the
|
|
|
|
<<search-aggregations-bucket-terms-aggregation,`terms` aggregation>>
|
|
|
|
with the <<search-aggregations-metrics-stats-aggregation,`stats` aggregation>>
|
|
|
|
or the <<search-aggregations-metrics-extendedstats-aggregation,`extended_stats` aggregation>>
|
|
|
|
instead.
|
|
|
|
|
|
|
|
[role="exclude",id="search-facets-statistical-facet"]
|
|
|
|
=== Statistical Facet
|
|
|
|
|
|
|
|
Facets have been removed. Use the
|
|
|
|
<<search-aggregations-metrics-stats-aggregation,`stats` aggregation>>
|
|
|
|
or the <<search-aggregations-metrics-extendedstats-aggregation,`extended_stats` aggregation>> instead.
|
|
|
|
|
|
|
|
[role="exclude",id="search-facets-migrating-to-aggs"]
|
|
|
|
=== Migrating from facets to aggregations
|
|
|
|
|
|
|
|
Facets have been removed. Use <<search-aggregations>> instead.
|
|
|
|
|
2015-06-26 10:31:38 -04:00
|
|
|
// CACHES
|
2015-05-24 11:57:34 -04:00
|
|
|
|
2015-06-26 10:31:38 -04:00
|
|
|
[role="exclude",id="shard-query-cache"]
|
|
|
|
=== Shard request cache
|
2015-05-24 11:57:34 -04:00
|
|
|
|
2015-06-26 10:31:38 -04:00
|
|
|
The shard query cache has been renamed <<shard-request-cache>>.
|
2015-05-24 11:57:34 -04:00
|
|
|
|
2015-06-26 10:31:38 -04:00
|
|
|
[role="exclude",id="filter-cache"]
|
|
|
|
=== Query cache
|
2015-05-24 11:57:34 -04:00
|
|
|
|
2015-06-26 10:31:38 -04:00
|
|
|
The filter cache has been renamed <<query-cache>>.
|
2015-09-11 04:35:56 -04:00
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-filtered-query"]
|
|
|
|
=== Filtered query
|
|
|
|
|
2015-10-26 07:18:36 -04:00
|
|
|
The `filtered` query is replaced by the <<query-dsl-bool-query,bool>> query. Instead of
|
2015-09-11 04:35:56 -04:00
|
|
|
the following:
|
|
|
|
|
|
|
|
[source,js]
|
|
|
|
-------------------------
|
2017-07-14 05:44:46 -04:00
|
|
|
## INCORRECT - DEPRECATED SYNTAX, DO NOT USE
|
2015-09-11 04:35:56 -04:00
|
|
|
GET _search
|
|
|
|
{
|
|
|
|
"query": {
|
|
|
|
"filtered": {
|
|
|
|
"query": {
|
|
|
|
"match": {
|
|
|
|
"text": "quick brown fox"
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"filter": {
|
|
|
|
"term": {
|
|
|
|
"status": "published"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
-------------------------
|
2016-09-20 00:12:17 -04:00
|
|
|
// NOTCONSOLE
|
2015-09-11 04:35:56 -04:00
|
|
|
|
|
|
|
move the query and filter to the `must` and `filter` parameters in the `bool`
|
|
|
|
query:
|
|
|
|
|
2019-09-09 12:35:50 -04:00
|
|
|
[source,console]
|
2015-09-11 04:35:56 -04:00
|
|
|
-------------------------
|
|
|
|
GET _search
|
|
|
|
{
|
|
|
|
"query": {
|
|
|
|
"bool": {
|
|
|
|
"must": {
|
|
|
|
"match": {
|
|
|
|
"text": "quick brown fox"
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"filter": {
|
|
|
|
"term": {
|
|
|
|
"status": "published"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
-------------------------
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-or-query"]
|
|
|
|
=== Or query
|
|
|
|
|
|
|
|
The `or` query is replaced in favour of the <<query-dsl-bool-query,bool>> query.
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-or-filter"]
|
|
|
|
=== Or filter
|
|
|
|
|
|
|
|
The `or` filter is replaced in favour of the <<query-dsl-bool-query,bool>> query.
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-and-query"]
|
|
|
|
=== And query
|
|
|
|
|
|
|
|
The `and` query is replaced in favour of the <<query-dsl-bool-query,bool>> query.
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-and-filter"]
|
|
|
|
=== And filter
|
|
|
|
|
|
|
|
The `and` filter is replaced in favour of the <<query-dsl-bool-query,bool>> query.
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-limit-query"]
|
|
|
|
=== Limit query
|
|
|
|
|
|
|
|
The `limit` query is replaced in favour of the <<search-request-body,terminate_after>>
|
|
|
|
parameter of search requests.
|
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-limit-filter"]
|
|
|
|
=== Limit filter
|
|
|
|
|
|
|
|
The `limit` filter is replaced in favour of the <<search-request-body,terminate_after>>
|
|
|
|
parameter of search requests.
|
2015-10-20 15:53:41 -04:00
|
|
|
|
|
|
|
[role="exclude",id="query-dsl-not-query"]
|
|
|
|
=== Not query
|
|
|
|
|
|
|
|
The `not` query has been replaced by using a `mustNot` clause in a Boolean query.
|
2015-10-30 05:31:40 -04:00
|
|
|
|
|
|
|
[role="exclude",id="mapping-nested-type"]
|
|
|
|
=== Nested type
|
|
|
|
|
|
|
|
The docs for the `nested` field datatype have moved to <<nested>>.
|
2015-12-22 11:08:35 -05:00
|
|
|
|
|
|
|
[role="exclude",id="indices-warmers"]
|
|
|
|
=== Warmers
|
|
|
|
|
|
|
|
Warmers have been removed. There have been significant improvements to the
|
|
|
|
index that make warmers not necessary anymore.
|
2016-03-02 04:51:47 -05:00
|
|
|
|
|
|
|
[role="exclude",id="index-boost"]
|
|
|
|
=== Index time boosting
|
|
|
|
|
|
|
|
The index time boost mapping has been replaced with query time boost (see <<mapping-boost>>).
|
2017-05-11 15:15:16 -04:00
|
|
|
|
|
|
|
[role="exclude",id="modules-scripting-native"]
|
2017-07-05 06:30:19 -04:00
|
|
|
=== Native scripting
|
2017-05-11 15:15:16 -04:00
|
|
|
|
|
|
|
Native scripts have been replaced with writing custom `ScriptEngine` backends (see <<modules-scripting-engine>>).
|
|
|
|
|
|
|
|
[role="exclude",id="modules-advanced-scripting"]
|
|
|
|
=== Advanced scripting
|
|
|
|
|
|
|
|
Using `_index` in scripts has been replaced with writing `ScriptEngine` backends (see <<modules-scripting-engine>>).
|
2017-05-02 17:37:45 -04:00
|
|
|
|
|
|
|
[role="exclude",id="modules-scripting-painless-syntax"]
|
|
|
|
=== Painless Syntax
|
|
|
|
|
|
|
|
See the
|
2018-04-17 15:16:08 -04:00
|
|
|
{painless}/painless-lang-spec.html[Painless Language Specification]
|
2017-07-07 23:15:42 -04:00
|
|
|
in the guide to the {painless}/index.html[Painless Scripting Language].
|
2017-05-02 17:37:45 -04:00
|
|
|
|
|
|
|
[role="exclude",id="modules-scripting-painless-debugging"]
|
|
|
|
=== Painless Debugging
|
|
|
|
|
2017-07-07 23:15:42 -04:00
|
|
|
See {painless}/painless-debugging.html[Painless Debugging] in the
|
|
|
|
guide to the {painless}/index.html[Painless Scripting Language].
|
2017-05-02 17:37:45 -04:00
|
|
|
|
|
|
|
[role="exclude",id="painless-api-reference"]
|
2019-04-23 12:10:47 -04:00
|
|
|
=== Painless Contexts API Reference
|
2017-05-02 17:37:45 -04:00
|
|
|
|
2019-04-23 12:10:47 -04:00
|
|
|
See the {painless}/painless-api-reference.html[Painless Contexts API Reference]
|
|
|
|
in the guide to the {painless}/index.html[Painless Scripting Language].
|
2018-08-18 00:39:21 -04:00
|
|
|
|
|
|
|
[role="exclude", id="security-api-roles"]
|
|
|
|
=== Role management APIs
|
|
|
|
|
|
|
|
You can use the following APIs to add, remove, and retrieve roles in the native realm:
|
|
|
|
|
|
|
|
* <<security-api-put-role,Create role>>, <<security-api-delete-role,Delete role>>
|
|
|
|
* <<security-api-clear-role-cache,Clear roles cache>>
|
2018-08-18 01:22:09 -04:00
|
|
|
* <<security-api-get-role,Get roles>>
|
|
|
|
|
|
|
|
[role="exclude",id="security-api-tokens"]
|
|
|
|
=== Token management APIs
|
|
|
|
|
|
|
|
You can use the following APIs to create and invalidate bearer tokens for access
|
|
|
|
without requiring basic authentication:
|
|
|
|
|
|
|
|
* <<security-api-get-token,Get token>>, <<security-api-invalidate-token,Invalidate token>>
|
2018-08-18 02:17:33 -04:00
|
|
|
|
|
|
|
[role="exclude",id="security-api-users"]
|
|
|
|
=== User Management APIs
|
|
|
|
|
|
|
|
You can use the following APIs to create, read, update, and delete users from the
|
|
|
|
native realm:
|
|
|
|
|
|
|
|
* <<security-api-put-user,Create users>>, <<security-api-delete-user,Delete users>>
|
|
|
|
* <<security-api-enable-user,Enable users>>, <<security-api-disable-user,Disable users>>
|
|
|
|
* <<security-api-change-password,Change passwords>>
|
|
|
|
* <<security-api-get-user,Get users>>
|
2018-08-20 17:30:42 -04:00
|
|
|
|
|
|
|
[role="exclude",id="security-api-role-mapping"]
|
|
|
|
=== Role mapping APIs
|
|
|
|
|
|
|
|
You can use the following APIs to add, remove, and retrieve role mappings:
|
|
|
|
|
|
|
|
* <<security-api-put-role-mapping,Add role mappings>>, <<security-api-delete-role-mapping,Delete role mappings>>
|
2018-08-23 21:04:02 -04:00
|
|
|
* <<security-api-get-role-mapping,Get role mappings>>
|
|
|
|
|
|
|
|
[role="exclude",id="security-api-privileges"]
|
|
|
|
=== Privilege APIs
|
|
|
|
|
|
|
|
See <<security-api-has-privileges>>.
|
2018-08-31 13:11:58 -04:00
|
|
|
|
|
|
|
[role="exclude",id="xpack-commands"]
|
|
|
|
=== X-Pack commands
|
|
|
|
|
2019-08-14 13:59:17 -04:00
|
|
|
See <<commands>>.
|
2018-08-31 19:49:24 -04:00
|
|
|
|
|
|
|
[role="exclude",id="ml-api-definitions"]
|
|
|
|
=== Machine learning API definitions
|
|
|
|
|
|
|
|
See <<api-definitions>>.
|
|
|
|
|
2018-09-06 08:42:06 -04:00
|
|
|
[role="exclude",id="analysis-standard-tokenfilter"]
|
|
|
|
=== Standard filter removed
|
|
|
|
|
|
|
|
The standard token filter has been removed.
|
|
|
|
|
2018-12-20 08:02:44 -05:00
|
|
|
[role="exclude",id="modules-discovery-azure-classic"]
|
|
|
|
|
|
|
|
See <<azure-classic-hosts-provider>>.
|
|
|
|
|
|
|
|
[role="exclude",id="modules-discovery-ec2"]
|
|
|
|
|
|
|
|
See <<ec2-hosts-provider>>.
|
|
|
|
|
|
|
|
[role="exclude",id="modules-discovery-gce"]
|
|
|
|
|
|
|
|
See <<gce-hosts-provider>>.
|
|
|
|
|
|
|
|
[role="exclude",id="modules-discovery-zen"]
|
|
|
|
|
|
|
|
Zen discovery is replaced by the <<modules-discovery,discovery and cluster
|
|
|
|
formation module>>.
|
2019-03-14 17:22:06 -04:00
|
|
|
|
|
|
|
[role="exclude",id="settings-xpack"]
|
|
|
|
=== {xpack} settings in {es}
|
|
|
|
|
|
|
|
include::{asciidoc-dir}/../../shared/settings.asciidoc[]
|
2019-04-25 15:06:35 -04:00
|
|
|
|
|
|
|
[role="exclude",id="_faster_phrase_queries_with_literal_index_phrases_literal"]
|
|
|
|
|
|
|
|
See <<faster-phrase-queries>>.
|
|
|
|
|
|
|
|
[role="exclude",id="_faster_prefix_queries_with_literal_index_prefixes_literal.html"]
|
|
|
|
|
2019-06-26 13:44:33 -04:00
|
|
|
See <<faster-prefix-queries>>.
|
|
|
|
|
|
|
|
[role="exclude",id="xpack-api"]
|
|
|
|
=== X-Pack APIs
|
|
|
|
|
2019-08-14 13:59:17 -04:00
|
|
|
{es} {xpack} APIs are now documented in <<rest-apis, REST APIs>>.
|
2019-07-15 12:44:57 -04:00
|
|
|
|
|
|
|
[role="exclude",id="ml-calendar-resource"]]
|
|
|
|
=== Calendar resources
|
|
|
|
|
2019-08-14 13:59:17 -04:00
|
|
|
See <<ml-get-calendar>> and
|
2019-07-15 12:44:57 -04:00
|
|
|
{stack-ov}/ml-calendars.html[Calendars and scheduled events].
|
|
|
|
|
|
|
|
[role="exclude",id="ml-filter-resource"]
|
|
|
|
=== Filter resources
|
|
|
|
|
|
|
|
See <<ml-get-filter>> and
|
|
|
|
{stack-ov}/ml-rules.html[Machine learning custom rules].
|
|
|
|
|
|
|
|
[role="exclude",id="ml-event-resource"]
|
|
|
|
=== Scheduled event resources
|
|
|
|
|
2019-08-14 13:59:17 -04:00
|
|
|
See <<ml-get-calendar-event>> and
|
2019-07-15 12:44:57 -04:00
|
|
|
{stack-ov}/ml-calendars.html[Calendars and scheduled events].
|
|
|
|
|
2019-07-17 08:49:22 -04:00
|
|
|
[role="exclude",id="index-apis"]
|
|
|
|
=== Index APIs
|
|
|
|
{es} index APIs are now documented in <<indices>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-docvalue-fields"]
|
|
|
|
=== Doc value fields parameter for request body search API
|
|
|
|
See <<request-body-search-docvalue-fields>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-explain"]
|
|
|
|
=== Explain parameter for request body search API
|
|
|
|
See <<request-body-search-explain>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-collapse"]
|
|
|
|
=== Collapse parameter for request body search API
|
|
|
|
See <<request-body-search-collapse>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-from-size"]
|
|
|
|
=== From and size parameters for request body search API
|
|
|
|
See <<request-body-search-from-size>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-highlighting"]
|
|
|
|
=== Highlight parameter for request body search API
|
|
|
|
See <<request-body-search-highlighting>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-index-boost"]
|
|
|
|
=== Index boost parameter for request body search API
|
|
|
|
See <<request-body-search-index-boost>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-inner-hits"]
|
|
|
|
=== Inner hits parameter for request body search API
|
|
|
|
See <<request-body-search-inner-hits>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-min-score"]
|
|
|
|
=== Minimum score parameter for request body search API
|
|
|
|
See <<request-body-search-min-score>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-named-queries-and-filters"]
|
|
|
|
=== Named query parameter for request body search API
|
|
|
|
See <<request-body-search-queries-and-filters>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-post-filter"]
|
|
|
|
=== Post filter parameter for request body search API
|
|
|
|
See <<request-body-search-post-filter>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-preference"]
|
|
|
|
=== Preference parameter for request body search API
|
|
|
|
See <<request-body-search-preference>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-query"]
|
|
|
|
=== Query parameter for request body search API
|
|
|
|
See <<request-body-search-query>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-rescore"]
|
|
|
|
=== Rescoring parameter for request body search API
|
|
|
|
See <<request-body-search-rescore>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-script-fields"]
|
|
|
|
=== Script fields parameter for request body search API
|
|
|
|
See <<request-body-search-script-fields>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-scroll"]
|
|
|
|
=== Scroll parameter for request body search API
|
|
|
|
See <<request-body-search-scroll>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-search-after"]
|
|
|
|
=== Search after parameter for request body search API
|
|
|
|
See <<request-body-search-search-after>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-search-type"]
|
|
|
|
=== Search type parameter for request body search API
|
|
|
|
See <<request-body-search-search-type>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-seq-no-primary-term"]
|
|
|
|
=== Sequence numbers and primary terms parameter for request body search API
|
|
|
|
See <<request-body-search-search-type>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-sort"]
|
|
|
|
=== Sort parameter for request body search API
|
|
|
|
See <<request-body-search-sort>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-source-filtering"]
|
|
|
|
=== Source filtering parameter for request body search API
|
|
|
|
See <<request-body-search-source-filtering>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-stored-fields"]
|
|
|
|
=== Stored fields parameter for request body search API
|
|
|
|
See <<request-body-search-stored-fields>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-track-total-hits"]
|
|
|
|
=== Track total hits parameter for request body search API
|
|
|
|
See <<request-body-search-track-total-hits>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-request-version"]
|
|
|
|
=== Version parameter for request body search API
|
|
|
|
See <<request-body-search-version>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-suggesters-term"]
|
|
|
|
=== Term suggester
|
|
|
|
See <<term-suggester>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-suggesters-phrase"]
|
|
|
|
=== Phrase suggester
|
|
|
|
See <<phrase-suggester>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-suggesters-completion"]
|
|
|
|
=== Completion suggester
|
|
|
|
See <<completion-suggester>>.
|
|
|
|
|
|
|
|
[role="exclude",id="suggester-context"]
|
|
|
|
=== Context suggester
|
|
|
|
See <<context-suggester>>.
|
|
|
|
|
|
|
|
[role="exclude",id="returning-suggesters-type"]
|
|
|
|
=== Return suggester type
|
|
|
|
See <<return-suggesters-type>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-profile-queries"]
|
|
|
|
=== Profiling queries
|
|
|
|
See <<profiling-queries>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-profile-aggregations"]
|
|
|
|
=== Profiling aggregations
|
|
|
|
See <<profiling-aggregations>>.
|
|
|
|
|
|
|
|
[role="exclude",id="search-profile-considerations"]
|
|
|
|
=== Profiling considerations
|
|
|
|
See <<profiling-considerations>>.
|
|
|
|
|
|
|
|
[role="exclude",id="_explain_analyze"]
|
|
|
|
=== Explain analyze API
|
|
|
|
See <<explain-analyze-api>>.
|
|
|
|
|
|
|
|
[role="exclude",id="indices-synced-flush"]
|
|
|
|
=== Synced flush API
|
2019-09-30 08:42:52 -04:00
|
|
|
See <<indices-synced-flush-api>>.
|
2019-07-17 08:49:22 -04:00
|
|
|
|
[7.x] Add Snapshot Lifecycle Management (#44382)
* Add Snapshot Lifecycle Management (#43934)
* Add SnapshotLifecycleService and related CRUD APIs
This commit adds `SnapshotLifecycleService` as a new service under the ilm
plugin. This service handles snapshot lifecycle policies by scheduling based on
the policies defined schedule.
This also includes the get, put, and delete APIs for these policies
Relates to #38461
* Make scheduledJobIds return an immutable set
* Use Object.equals for SnapshotLifecyclePolicy
* Remove unneeded TODO
* Implement ToXContentFragment on SnapshotLifecyclePolicyItem
* Copy contents of the scheduledJobIds
* Handle snapshot lifecycle policy updates and deletions (#40062)
(Note this is a PR against the `snapshot-lifecycle-management` feature branch)
This adds logic to `SnapshotLifecycleService` to handle updates and deletes for
snapshot policies. Policies with incremented versions have the old policy
cancelled and the new one scheduled. Deleted policies have their schedules
cancelled when they are no longer present in the cluster state metadata.
Relates to #38461
* Take a snapshot for the policy when the SLM policy is triggered (#40383)
(This is a PR for the `snapshot-lifecycle-management` branch)
This commit fills in `SnapshotLifecycleTask` to actually perform the
snapshotting when the policy is triggered. Currently there is no handling of the
results (other than logging) as that will be added in subsequent work.
This also adds unit tests and an integration test that schedules a policy and
ensures that a snapshot is correctly taken.
Relates to #38461
* Record most recent snapshot policy success/failure (#40619)
Keeping a record of the results of the successes and failures will aid
troubleshooting of policies and make users more confident that their
snapshots are being taken as expected.
This is the first step toward writing history in a more permanent
fashion.
* Validate snapshot lifecycle policies (#40654)
(This is a PR against the `snapshot-lifecycle-management` branch)
With the commit, we now validate the content of snapshot lifecycle policies when
the policy is being created or updated. This checks for the validity of the id,
name, schedule, and repository. Additionally, cluster state is checked to ensure
that the repository exists prior to the lifecycle being added to the cluster
state.
Part of #38461
* Hook SLM into ILM's start and stop APIs (#40871)
(This pull request is for the `snapshot-lifecycle-management` branch)
This change allows the existing `/_ilm/stop` and `/_ilm/start` APIs to also
manage snapshot lifecycle scheduling. When ILM is stopped all scheduled jobs are
cancelled.
Relates to #38461
* Add tests for SnapshotLifecyclePolicyItem (#40912)
Adds serialization tests for SnapshotLifecyclePolicyItem.
* Fix improper import in build.gradle after master merge
* Add human readable version of modified date for snapshot lifecycle policy (#41035)
* Add human readable version of modified date for snapshot lifecycle policy
This small change changes it from:
```
...
"modified_date": 1554843903242,
...
```
To
```
...
"modified_date" : "2019-04-09T21:05:03.242Z",
"modified_date_millis" : 1554843903242,
...
```
Including the `"modified_date"` field when the `?human` field is used.
Relates to #38461
* Fix test
* Add API to execute SLM policy on demand (#41038)
This commit adds the ability to perform a snapshot on demand for a policy. This
can be useful to take a snapshot immediately prior to performing some sort of
maintenance.
```json
PUT /_ilm/snapshot/<policy>/_execute
```
And it returns the response with the generated snapshot name:
```json
{
"snapshot_name" : "production-snap-2019.04.09-rfyv3j9qreixkdbnfuw0ug"
}
```
Note that this does not allow waiting for the snapshot, and the snapshot could
still fail. It *does* record this information into the cluster state similar to
a regularly trigged SLM job.
Relates to #38461
* Add next_execution to SLM policy metadata (#41221)
* Add next_execution to SLM policy metadata
This adds the next time a snapshot lifecycle policy will be executed when
retriving a policy's metadata, for example:
```json
GET /_ilm/snapshot?human
{
"production" : {
"version" : 1,
"modified_date" : "2019-04-15T21:16:21.865Z",
"modified_date_millis" : 1555362981865,
"policy" : {
"name" : "<production-snap-{now/d}>",
"schedule" : "*/30 * * * * ?",
"repository" : "repo",
"config" : {
"indices" : [
"foo-*",
"important"
],
"ignore_unavailable" : true,
"include_global_state" : false
}
},
"next_execution" : "2019-04-15T21:16:30.000Z",
"next_execution_millis" : 1555362990000
},
"other" : {
"version" : 1,
"modified_date" : "2019-04-15T21:12:19.959Z",
"modified_date_millis" : 1555362739959,
"policy" : {
"name" : "<other-snap-{now/d}>",
"schedule" : "0 30 2 * * ?",
"repository" : "repo",
"config" : {
"indices" : [
"other"
],
"ignore_unavailable" : false,
"include_global_state" : true
}
},
"next_execution" : "2019-04-16T02:30:00.000Z",
"next_execution_millis" : 1555381800000
}
}
```
Relates to #38461
* Fix and enhance tests
* Figured out how to Cron
* Change SLM endpoint from /_ilm/* to /_slm/* (#41320)
This commit changes the endpoint for snapshot lifecycle management from:
```
GET /_ilm/snapshot/<policy>
```
to:
```
GET /_slm/policy/<policy>
```
It mimics the ILM path only using `slm` instead of `ilm`.
Relates to #38461
* Add initial documentation for SLM (#41510)
* Add initial documentation for SLM
This adds the initial documentation for snapshot lifecycle management.
It also includes the REST spec API json files since they're sort of
documentation.
Relates to #38461
* Add `manage_slm` and `read_slm` roles (#41607)
* Add `manage_slm` and `read_slm` roles
This adds two more built in roles -
`manage_slm` which has permission to perform any of the SLM actions, as well as
stopping, starting, and retrieving the operation status of ILM.
`read_slm` which has permission to retrieve snapshot lifecycle policies as well
as retrieving the operation status of ILM.
Relates to #38461
* Add execute to the test
* Fix ilm -> slm typo in test
* Record SLM history into an index (#41707)
It is useful to have a record of the actions that Snapshot Lifecycle
Management takes, especially for the purposes of alerting when a
snapshot fails or has not been taken successfully for a certain amount of
time.
This adds the infrastructure to record SLM actions into an index that
can be queried at leisure, along with a lifecycle policy so that this
history does not grow without bound.
Additionally,
SLM automatically setting up an index + lifecycle policy leads to
`index_lifecycle` custom metadata in the cluster state, which some of
the ML tests don't know how to deal with due to setting up custom
`NamedXContentRegistry`s. Watcher would cause the same problem, but it
is already disabled (for the same reason).
* High Level Rest Client support for SLM (#41767)
* High Level Rest Client support for SLM
This commit add HLRC support for SLM.
Relates to #38461
* Fill out documentation tests with tags
* Add more callouts and asciidoc for HLRC
* Update javadoc links to real locations
* Add security test testing SLM cluster privileges (#42678)
* Add security test testing SLM cluster privileges
This adds a test to `PermissionsIT` that uses the `manage_slm` and `read_slm`
cluster privileges.
Relates to #38461
* Don't redefine vars
* Add Getting Started Guide for SLM (#42878)
This commit adds a basic Getting Started Guide for SLM.
* Include SLM policy name in Snapshot metadata (#43132)
Keep track of which SLM policy in the metadata field of the Snapshots
taken by SLM. This allows users to more easily understand where the
snapshot came from, and will enable future SLM features such as
retention policies.
* Fix compilation after master merge
* [TEST] Move exception wrapping for devious exception throwing
Fixes an issue where an exception was created from one line and thrown in another.
* Fix SLM for the change to AcknowledgedResponse
* Add Snapshot Lifecycle Management Package Docs (#43535)
* Fix compilation for transport actions now that task is required
* Add a note mentioning the privileges needed for SLM (#43708)
* Add a note mentioning the privileges needed for SLM
This adds a note to the top of the "getting started with SLM"
documentation mentioning that there are two built-in privileges to
assist with creating roles for SLM users and administrators.
Relates to #38461
* Mention that you can create snapshots for indices you can't read
* Fix REST tests for new number of cluster privileges
* Mute testThatNonExistingTemplatesAreAddedImmediately (#43951)
* Fix SnapshotHistoryStoreTests after merge
* Remove overridden newResponse functions that have been removed
* Fix compilation for backport
* Fix get snapshot output parsing in test
* [DOCS] Add redirects for removed autogen anchors (#44380)
* Switch <tt>...</tt> in javadocs for {@code ...}
2019-07-16 09:37:13 -04:00
|
|
|
[role="exclude",id="_repositories"]
|
|
|
|
=== Snapshot repositories
|
|
|
|
See <<snapshots-repositories>>.
|
|
|
|
|
|
|
|
[role="exclude",id="_snapshot"]
|
|
|
|
=== Snapshot
|
|
|
|
See <<snapshots-take-snapshot>>.
|
2019-08-14 13:59:17 -04:00
|
|
|
|
|
|
|
[role="exclude",id="getting-started-explore"]
|
|
|
|
=== Exploring your cluster
|
|
|
|
See <<cat>>.
|
|
|
|
|
|
|
|
[role="exclude",id="getting-started-cluster-health"]
|
|
|
|
=== Cluster health
|
|
|
|
See <<cat-health>>.
|
|
|
|
|
|
|
|
[role="exclude", id="getting-started-list-indices"]
|
|
|
|
=== List all indices
|
|
|
|
See <<cat-indices>>.
|
|
|
|
|
|
|
|
[role="exclude", id="getting-started-create-index"]
|
|
|
|
=== Create an index
|
|
|
|
See <<indices-create-index>>.
|
|
|
|
|
|
|
|
[role="exclude", id="getting-started-query-document"]
|
|
|
|
=== Index and query a document
|
|
|
|
See <<getting-started-index>>.
|
|
|
|
|
|
|
|
[role="exclude", id="getting-started-delete-index"]
|
|
|
|
=== Delete an index
|
|
|
|
See <<indices-delete-index>>.
|
|
|
|
|
|
|
|
[role="exclude", id="getting-started-modify-data"]
|
|
|
|
== Modifying your data
|
|
|
|
See <<docs-update>>.
|
|
|
|
|
|
|
|
[role="exclude", id="indexing-replacing-documents"]
|
|
|
|
=== Indexing/replacing documents
|
|
|
|
See <<docs-index_>>.
|
|
|
|
|
|
|
|
[role="exclude", id="getting-started-explore-data"]
|
|
|
|
=== Exploring your data
|
|
|
|
See <<getting-started-search>>.
|
|
|
|
|
|
|
|
[role="exclude", id="getting-started-search-API"]
|
|
|
|
=== Search API
|
|
|
|
See <<getting-started-search>>.
|
|
|
|
|
|
|
|
[role="exclude", id="getting-started-conclusion"]
|
|
|
|
=== Conclusion
|
|
|
|
See <<getting-started-next-steps>>.
|
2019-08-15 10:59:58 -04:00
|
|
|
|
|
|
|
[role="exclude",id="ccs-reduction"]
|
|
|
|
=== {ccs-cap} reduction
|
2019-09-17 14:25:46 -04:00
|
|
|
See <<ccs-works>>.
|
|
|
|
|
|
|
|
[role="exclude",id="administer-elasticsearch"]
|
|
|
|
=== Administering {es}
|
2019-09-20 18:57:43 -04:00
|
|
|
See <<high-availability>>.
|
|
|
|
|
2019-09-27 11:05:55 -04:00
|
|
|
[role="exclude",id="slm-api"]
|
|
|
|
=== Snapshot lifecycle management API
|
|
|
|
See <<snapshot-lifecycle-management-api>>.
|
|
|
|
|
2019-09-20 18:57:43 -04:00
|
|
|
[role="exclude",id="delete-data-frame-transform"]
|
|
|
|
=== Delete {transforms} API
|
|
|
|
|
|
|
|
See <<delete-transform>>.
|
|
|
|
|
|
|
|
[role="exclude",id="get-data-frame-transform-stats"]
|
|
|
|
=== Get {transform} statistics API
|
|
|
|
|
|
|
|
See <<get-transform-stats>>.
|
|
|
|
|
|
|
|
[role="exclude",id="get-data-frame-transform"]
|
|
|
|
=== Get {transforms} API
|
|
|
|
|
|
|
|
See <<get-transform>>.
|
|
|
|
|
|
|
|
[role="exclude",id="preview-data-frame-transform"]
|
|
|
|
=== Preview {transforms} API
|
|
|
|
|
|
|
|
See <<preview-transform>>.
|
|
|
|
|
|
|
|
[role="exclude",id="put-data-frame-transform"]
|
|
|
|
=== Create {transforms} API
|
|
|
|
|
|
|
|
See <<put-transform>>.
|
|
|
|
|
|
|
|
[role="exclude",id="start-data-frame-transform"]
|
|
|
|
=== Start {transforms} API
|
|
|
|
|
|
|
|
See <<start-transform>>.
|
|
|
|
|
|
|
|
[role="exclude",id="stop-data-frame-transform"]
|
|
|
|
=== Stop {transforms} API
|
|
|
|
|
|
|
|
See <<stop-transform>>.
|
|
|
|
|
|
|
|
[role="exclude",id="update-data-frame-transform"]
|
|
|
|
=== Update {transforms} API
|
|
|
|
|
|
|
|
See <<update-transform>>.
|
|
|
|
|
|
|
|
[role="exclude",id="data-frame-apis"]
|
|
|
|
=== {transform-cap} APIs
|
|
|
|
|
|
|
|
See <<transform-apis>>.
|
|
|
|
|
|
|
|
[role="exclude",id="data-frame-transform-resource"]
|
|
|
|
=== {transform-cap} resources
|
|
|
|
|
|
|
|
See <<transform-resource>>.
|
|
|
|
|
|
|
|
[role="exclude",id="data-frame-transform-dest"]
|
|
|
|
=== Dest objects
|
|
|
|
|
|
|
|
See <<transform-dest>>.
|
|
|
|
|
|
|
|
[role="exclude",id="data-frame-transform-source"]
|
|
|
|
==== Source objects
|
|
|
|
|
|
|
|
See <<transform-source>>.
|
|
|
|
|
|
|
|
[role="exclude",id="data-frame-transform-pivot"]
|
|
|
|
==== Pivot objects
|
|
|
|
|
|
|
|
See <<transform-pivot>>.
|
2019-09-24 13:35:06 -04:00
|
|
|
|
|
|
|
[role="exclude",id="configuring-monitoring"]
|
|
|
|
=== Configuring monitoring
|
|
|
|
|
|
|
|
See <<monitoring-overview>>.
|
|
|
|
|
|
|
|
[role="exclude",id="es-monitoring"]
|
|
|
|
=== Monitoring {es}
|
|
|
|
|
|
|
|
See <<monitor-elasticsearch-cluster>>.
|
|
|
|
|
2019-10-31 21:04:07 -04:00
|
|
|
[role="exclude",id="docker-cli-run"]
|
|
|
|
|
|
|
|
See <<docker-cli-run-dev-mode>>.
|
2019-11-13 09:35:00 -05:00
|
|
|
|
|
|
|
[role="exclude",id="analysis-compound-word-tokenfilter"]
|
|
|
|
=== Compound word token filters
|
|
|
|
|
|
|
|
See <<analysis-dict-decomp-tokenfilter>> and
|
|
|
|
<<analysis-hyp-decomp-tokenfilter>>.
|
2019-11-15 18:33:12 -05:00
|
|
|
|
|
|
|
[role="exclude",id="configuring-native-realm"]
|
|
|
|
=== Configuring a native realm
|
|
|
|
|
|
|
|
See <<native-realm-configuration>>.
|
|
|
|
|
|
|
|
[role="exclude",id="native-settings"]
|
|
|
|
==== Native realm settings
|
|
|
|
|
|
|
|
See <<ref-native-settings>>.
|
|
|
|
|
2019-11-18 12:58:47 -05:00
|
|
|
[role="exclude",id="configuring-saml-realm"]
|
|
|
|
=== Configuring a SAML realm
|
|
|
|
|
|
|
|
See <<saml-guide>>.
|
|
|
|
|
|
|
|
[role="exclude",id="saml-settings"]
|
|
|
|
==== SAML realm settings
|
|
|
|
|
|
|
|
See <<ref-saml-settings>>.
|
|
|
|
|
|
|
|
[role="exclude",id="_saml_realm_signing_settings"]
|
|
|
|
==== SAML realm signing settings
|
|
|
|
|
|
|
|
See <<ref-saml-signing-settings>>.
|
|
|
|
|
|
|
|
[role="exclude",id="_saml_realm_encryption_settings"]
|
|
|
|
==== SAML realm encryption settings
|
|
|
|
|
|
|
|
See <<ref-saml-encryption-settings>>.
|
|
|
|
|
|
|
|
[role="exclude",id="_saml_realm_ssl_settings"]
|
|
|
|
==== SAML realm SSL settings
|
|
|
|
|
|
|
|
See <<ref-saml-ssl-settings>>.
|
|
|
|
|
2019-11-18 14:51:02 -05:00
|
|
|
[role="exclude",id="configuring-file-realm"]
|
|
|
|
=== Configuring a file realm
|
|
|
|
|
|
|
|
See <<file-realm-configuration>>.
|
2019-11-18 16:29:51 -05:00
|
|
|
|
|
|
|
[role="exclude",id="ldap-user-search"]
|
|
|
|
=== User search mode and user DN templates mode
|
|
|
|
|
|
|
|
See <<ldap-realm-configuration>>.
|
|
|
|
|
|
|
|
[role="exclude",id="configuring-ldap-realm"]
|
|
|
|
=== Configuring an LDAP realm
|
|
|
|
|
|
|
|
See <<ldap-realm-configuration>>.
|
|
|
|
|
|
|
|
[role="exclude",id="ldap-settings"]
|
|
|
|
=== LDAP realm settings
|
|
|
|
|
|
|
|
See <<ref-ldap-settings>>.
|
|
|
|
|
|
|
|
[role="exclude",id="ldap-ssl"]
|
|
|
|
=== Setting up SSL between Elasticsearch and LDAP
|
|
|
|
|
|
|
|
See <<tls-ldap>>.
|
2019-11-18 18:19:13 -05:00
|
|
|
|
|
|
|
[role="exclude",id="configuring-kerberos-realm"]
|
|
|
|
=== Configuring a Kerberos realm
|
|
|
|
|
|
|
|
See <<kerberos-realm-configuration>>.
|
|
|
|
|
2019-11-19 12:08:36 -05:00
|
|
|
[role="exclude",id="beats"]
|
|
|
|
=== Beats and Security
|
|
|
|
|
|
|
|
See:
|
|
|
|
* {auditbeat-ref}/securing-beats.html[{auditbeat}]
|
|
|
|
* {filebeat-ref}/securing-beats.html[{filebeat}]
|
|
|
|
* {heartbeat-ref}/securing-beats.html[{heartbeat}]
|
|
|
|
* {metricbeat-ref}/securing-beats.html[{metricbeat}]
|
|
|
|
* {packetbeat-ref}/securing-beats.html[{packetbeat}]
|
|
|
|
* {winlogbeat-ref}/securing-beats.html[{winlogbeat}]
|
|
|
|
|
|
|
|
|