Repository: metron Updated Branches: refs/heads/master e22479e62 -> 7b68f1881
METRON-1450 Add REST endpoint docs for index topology split (MohanDV via nickwallen) closes apache/metron#936 Project: http://git-wip-us.apache.org/repos/asf/metron/repo Commit: http://git-wip-us.apache.org/repos/asf/metron/commit/7b68f188 Tree: http://git-wip-us.apache.org/repos/asf/metron/tree/7b68f188 Diff: http://git-wip-us.apache.org/repos/asf/metron/diff/7b68f188 Branch: refs/heads/master Commit: 7b68f188185b0eb6b3b0b70f98ce6b36bb22c46f Parents: e22479e Author: MohanDV <mvenkatesha...@hortonworks.com> Authored: Tue Mar 6 10:30:29 2018 -0500 Committer: nickallen <nickal...@apache.org> Committed: Tue Mar 6 10:30:29 2018 -0500 ---------------------------------------------------------------------- metron-interface/metron-rest/README.md | 63 ++++++++++++++++++++------ metron-platform/metron-indexing/README.md | 18 ++++++++ 2 files changed, 66 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/metron/blob/7b68f188/metron-interface/metron-rest/README.md ---------------------------------------------------------------------- diff --git a/metron-interface/metron-rest/README.md b/metron-interface/metron-rest/README.md index 25e112e..08cd6be 100644 --- a/metron-interface/metron-rest/README.md +++ b/metron-interface/metron-rest/README.md @@ -273,11 +273,16 @@ Request and Response objects are JSON formatted. The JSON schemas are available | [ `GET /api/v1/storm/enrichment/deactivate`](#get-apiv1stormenrichmentdeactivate)| | [ `GET /api/v1/storm/enrichment/start`](#get-apiv1stormenrichmentstart)| | [ `GET /api/v1/storm/enrichment/stop`](#get-apiv1stormenrichmentstop)| -| [ `GET /api/v1/storm/indexing`](#get-apiv1stormindexing)| -| [ `GET /api/v1/storm/indexing/activate`](#get-apiv1stormindexingactivate)| -| [ `GET /api/v1/storm/indexing/deactivate`](#get-apiv1stormindexingdeactivate)| -| [ `GET /api/v1/storm/indexing/start`](#get-apiv1stormindexingstart)| -| [ `GET /api/v1/storm/indexing/stop`](#get-apiv1stormindexingstop)| +| [ `GET /api/v1/storm/indexing/batch`](#get-apiv1stormindexingbatch)| +| [ `GET /api/v1/storm/indexing/batch/activate`](#get-apiv1stormindexingbatchactivate)| +| [ `GET /api/v1/storm/indexing/batch/deactivate`](#get-apiv1stormindexingbatchdeactivate)| +| [ `GET /api/v1/storm/indexing/batch/start`](#get-apiv1stormindexingbatchstart)| +| [ `GET /api/v1/storm/indexing/batch/stop`](#get-apiv1stormindexingbatchstop)| +| [ `GET /api/v1/storm/indexing/randomaccess`](#get-apiv1stormindexingrandomaccess)| +| [ `GET /api/v1/storm/indexing/randomaccess/activate`](#get-apiv1stormindexingrandomaccessactivate)| +| [ `GET /api/v1/storm/indexing/randomaccess/deactivate`](#get-apiv1stormindexingrandomaccessdeactivate)| +| [ `GET /api/v1/storm/indexing/randomaccess/start`](#get-apiv1stormindexingrandomaccessstart)| +| [ `GET /api/v1/storm/indexing/randomaccess/stop`](#get-apiv1stormindexingrandomaccessstop)| | [ `GET /api/v1/storm/parser/activate/{name}`](#get-apiv1stormparseractivatename)| | [ `GET /api/v1/storm/parser/deactivate/{name}`](#get-apiv1stormparserdeactivatename)| | [ `GET /api/v1/storm/parser/start/{name}`](#get-apiv1stormparserstartname)| @@ -704,29 +709,57 @@ Request and Response objects are JSON formatted. The JSON schemas are available * Returns: * 200 - Returns stop response message -### `GET /api/v1/storm/indexing` - * Description: Retrieves the status of the Storm indexing topology +### `GET /api/v1/storm/indexing/batch` + * Description: Retrieves the status of the Storm batch indexing topology * Returns: * 200 - Returns topology status information * 404 - Topology is missing -### `GET /api/v1/storm/indexing/activate` - * Description: Activates a Storm indexing topology +### `GET /api/v1/storm/indexing/batch/activate` + * Description: Activates a Storm batch indexing topology * Returns: * 200 - Returns activate response message -### `GET /api/v1/storm/indexing/deactivate` - * Description: Deactivates a Storm indexing topology +### `GET /api/v1/storm/indexing/batch/deactivate` + * Description: Deactivates a Storm batch indexing topology * Returns: * 200 - Returns deactivate response message -### `GET /api/v1/storm/indexing/start` - * Description: Starts a Storm indexing topology +### `GET /api/v1/storm/indexing/batch/start` + * Description: Starts a Storm batch indexing topology * Returns: * 200 - Returns start response message -### `GET /api/v1/storm/indexing/stop` - * Description: Stops a Storm enrichment topology +### `GET /api/v1/storm/indexing/batch/stop` + * Description: Stops a Storm batch indexing topology + * Input: + * stopNow - Stop the topology immediately + * Returns: + * 200 - Returns stop response message + +### `GET /api/v1/storm/indexing/randomaccess` + * Description: Retrieves the status of the Storm randomaccess indexing topology + * Returns: + * 200 - Returns topology status information + * 404 - Topology is missing + +### `GET /api/v1/storm/indexing/randomaccess/activate` + * Description: Activates a Storm randomaccess indexing topology + * Returns: + * 200 - Returns activate response message + +### `GET /api/v1/storm/indexing/randomaccess/deactivate` + * Description: Deactivates a Storm randomaccess indexing topology + * Returns: + * 200 - Returns deactivate response message + +### `GET /api/v1/storm/indexing/randomaccess/start` + * Description: Starts a Storm randomaccess indexing topology + * Returns: + * 200 - Returns start response message + +### `GET /api/v1/storm/indexing/randomaccess/stop` + * Description: Stops a Storm randomaccess indexing topology * Input: * stopNow - Stop the topology immediately * Returns: http://git-wip-us.apache.org/repos/asf/metron/blob/7b68f188/metron-platform/metron-indexing/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-indexing/README.md b/metron-platform/metron-indexing/README.md index e7f1e4f..d351d7c 100644 --- a/metron-platform/metron-indexing/README.md +++ b/metron-platform/metron-indexing/README.md @@ -238,6 +238,24 @@ to modify the flux file, the following might be of use to you: * [Understanding the Parallelism of a Storm Topology](http://www.michael-noll.com/blog/2012/10/16/understanding-the-parallelism-of-a-storm-topology/) * [Flux Docs](http://storm.apache.org/releases/current/flux.html) +### Rest endpoints +There are rest endpoints available to perform operations like start, stop, activate, deactivate on the `indexing` topologies. + + +| | +| ---------- | +| [ `GET /api/v1/storm/indexing/batch`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingbatch)| +| [ `GET /api/v1/storm/indexing/batch/activate`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingbatchactivate)| +| [ `GET /api/v1/storm/indexing/batch/deactivate`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingbatchdeactivate)| +| [ `GET /api/v1/storm/indexing/batch/start`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingbatchstart)| +| [ `GET /api/v1/storm/indexing/batch/stop`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingbatchstop)| +| [ `GET /api/v1/storm/indexing/randomaccess`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingrandomaccess)| +| [ `GET /api/v1/storm/indexing/randomaccess/activate`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingrandomaccessactivate)| +| [ `GET /api/v1/storm/indexing/randomaccess/deactivate`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingrandomaccessdeactivate)| +| [ `GET /api/v1/storm/indexing/randomaccess/start`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingrandomaccessstart)| +| [ `GET /api/v1/storm/indexing/randomaccess/stop`](../../metron-interface/metron-rest/README.md#get-apiv1stormindexingrandomaccessstop)| + + ## Zeppelin Notebooks Zeppelin notebooks can be added to `/src/main/config/zeppelin/` (and subdirectories can be created for organization). The placed files must be .json files and be named appropriately. These files must be added to the metron.spec file and the RPMs rebuilt to be available to be loaded into Ambari.
