diff --git a/docs/index.rst b/docs/index.rst index e0b35058..ed23c925 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -322,6 +322,7 @@ Contents :maxdepth: 2 api + xpack exceptions connection transports @@ -331,7 +332,7 @@ Contents License ------- -Copyright 2013 Elasticsearch +Copyright 2018 Elasticsearch Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/docs/xpack.rst b/docs/xpack.rst new file mode 100644 index 00000000..e43599c6 --- /dev/null +++ b/docs/xpack.rst @@ -0,0 +1,97 @@ +.. _xpack: + +X-Pack APIs +=========== + +X-Pack is an Elastic Stack extension that bundles security, alerting, monitoring, +reporting, and graph capabilities into one easy-to-install package. +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 `_ +provides general info about the installed X-Pack. + +.. py:module:: elasticsearch.client.xpack + +.. autoclass:: XPackClient + :members: + + +Graph Explore +------------- +`X-Pack Graph Explore `_ +enables you to extract and summarize information about the documents and terms in your Elasticsearch index. + +.. py:module:: elasticsearch.client.xpack.graph + + +.. autoclass:: GraphClient + :members: + +Licensing API +------------- + +`Licensing API `_ +can be used to manage your licences. + + +.. py:module:: elasticsearch.client.xpack.license + + +.. autoclass:: LicenseClient + :members: + +Machine Learning APIs +--------------------- + +`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. + + +.. py:module:: elasticsearch.client.xpack.ml + + +.. autoclass:: MlClient + :members: + +Security APIs +------------- + +`Security API `_ +can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory. + +.. py:module:: elasticsearch.client.xpack.security + + +.. autoclass:: SecurityClient + :members: + +Watcher APIs +------------- + +`Watcher API `_ +can be used to notify you when certain pre-defined thresholds have happened. + +.. py:module:: elasticsearch.client.xpack.watcher + +.. autoclass:: WatcherClient + :members: + + +Migration APIs +--------------- + +`Migration API `_ +helps simplify upgrading X-Pack indices from one version to another. + +.. py:module:: elasticsearch.client.xpack.migration + +.. autoclass:: MigrationClient + :members: +