From 2704580f7b32a77c7cd19d0532310d9a5e13b310 Mon Sep 17 00:00:00 2001 From: Seth Michael Larson Date: Mon, 9 Mar 2020 08:39:03 -0500 Subject: [PATCH] [7.x] Add documentation of all X-Pack APIs --- docs/xpack.rst | 131 ++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 119 insertions(+), 12 deletions(-) diff --git a/docs/xpack.rst b/docs/xpack.rst index 50de6e14..122ce0ec 100644 --- a/docs/xpack.rst +++ b/docs/xpack.rst @@ -9,11 +9,10 @@ While the X-Pack components are designed to work together seamlessly, you can easily enable or disable the features you want to use. - Info ---- -`X-Pack info `_ +`X-Pack info `_ provides general info about the installed X-Pack. .. py:module:: elasticsearch.client.xpack @@ -22,9 +21,10 @@ provides general info about the installed X-Pack. :members: -Graph Explore -------------- -`X-Pack Graph Explore `_ +Graph Explore APIs +------------------ + +`Graph Explore API `_ enables you to extract and summarize information about the documents and terms in your Elasticsearch index. .. py:module:: elasticsearch.client.graph @@ -33,10 +33,10 @@ enables you to extract and summarize information about the documents and terms i .. autoclass:: GraphClient :members: -Licensing API -------------- +Licensing APIs +-------------- -`Licensing API `_ +`Licensing API `_ can be used to manage your licences. @@ -49,7 +49,7 @@ can be used to manage your licences. Machine Learning APIs --------------------- -`Machine Learning `_ +`Machine Learning `_ can be useful for discovering new patterns about your data. For a more detailed explanation about X-Pack's machine learning please refer to the official documentation. @@ -63,7 +63,7 @@ about X-Pack's machine learning please refer to the official documentation. Security APIs ------------- -`Security API `_ +`Security API `_ can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory. .. py:module:: elasticsearch.client.security @@ -75,7 +75,7 @@ can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Watcher APIs ------------- -`Watcher API `_ +`Watcher API `_ can be used to notify you when certain pre-defined thresholds have happened. .. py:module:: elasticsearch.client.watcher @@ -87,7 +87,7 @@ can be used to notify you when certain pre-defined thresholds have happened. Migration APIs --------------- -`Migration API `_ +`Migration API `_ helps simplify upgrading X-Pack indices from one version to another. .. py:module:: elasticsearch.client.migration @@ -95,3 +95,110 @@ helps simplify upgrading X-Pack indices from one version to another. .. autoclass:: MigrationClient :members: + +Enrich APIs +------------ + +`Enrich API `_ +can be used to add data from your existing indices to incoming documents during ingest. + +.. py:module:: elasticsearch.client.enrich + +.. autoclass:: EnrichClient + :members: + +SQL APIs +-------- + +The `SQL REST API `_ +accepts SQL in a JSON document, executes it, and returns the results. + +.. py:module:: elasticsearch.client.sql + +.. autoclass:: SqlClient + :members: + +Cross-Cluster Replication APIs +------------------------------- + +`Cross-Cluster Replication API `_ +used to perform cross-cluster replication operations. + +.. py:module:: elasticsearch.client.ccr + +.. autoclass:: CcrClient + :members: + + +Monitoring APIs +---------------- + +`Monitoring API `_ +used to collect data from the Elasticsearch nodes, Logstash nodes, Kibana instances, and Beats in your cluster. + +.. py:module:: elasticsearch.client.monitoring + +.. autoclass:: MonitoringClient + :members: + + +Rollup APIs +------------ + +`Rollup API `_ +enables searching through rolled-up data using the standard query DSL. + +.. py:module:: elasticsearch.client.rollup + +.. autoclass:: RollupClient + :members: + + +Snapshot Lifecycle Management APIs +----------------------------------- + +`Snapshot Lifecycle Management API `_ +can be used to set up policies to automatically take snapshots and control how long they are retained. + +.. py:module:: elasticsearch.client.slm + +.. autoclass:: SlmClient + :members: + + +Index Lifecycle Management APIs +-------------------------------- + +`Index Lifecycle Management API `_ +used to set up policies to automatically manage the index lifecycle. + +.. py:module:: elasticsearch.client.ilm + +.. autoclass:: IlmClient + :members: + + +Transform APIs +--------------- + +`Transform API `_ +manages transformation operations from grabbing data from source indices, transforms it, and +saves it to a destination index. + +.. py:module:: elasticsearch.client.transform + +.. autoclass:: TransformClient + :members: + + +Deprecation APIs +----------------- + +`Deprecation API `_ +used to retrieve information about different cluster, node, and index level settings that use deprecated features +that will be removed or changed in the next major version. + +.. py:module:: elasticsearch.client.deprecation + +.. autoclass:: DeprecationClient + :members: