Updating and formatting cep and das README files
Project: http://git-wip-us.apache.org/repos/asf/stratos/repo Commit: http://git-wip-us.apache.org/repos/asf/stratos/commit/bd7d2464 Tree: http://git-wip-us.apache.org/repos/asf/stratos/tree/bd7d2464 Diff: http://git-wip-us.apache.org/repos/asf/stratos/diff/bd7d2464 Branch: refs/heads/release-4.1.5 Commit: bd7d2464464c21762b8d71df0af9d01f4649f94d Parents: 65142d8 Author: Thanuja <[email protected]> Authored: Sun Dec 6 15:05:17 2015 +0530 Committer: gayangunarathne <[email protected]> Committed: Mon Dec 7 10:16:30 2015 +0000 ---------------------------------------------------------------------- extensions/cep/modules/distribution/README.md | 34 +++++++++++++-- .../artifacts/metering-dashboard/README.md | 36 +++++++++++----- .../metering-dashboard/ues-patch/README.md | 5 ++- .../artifacts/monitoring-dashboard/README.md | 33 +++++++++----- extensions/das/modules/distribution/README.md | 45 +++++++++++++++++++- .../das/modules/stratos-das-extension/README.md | 10 +++-- 6 files changed, 132 insertions(+), 31 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/stratos/blob/bd7d2464/extensions/cep/modules/distribution/README.md ---------------------------------------------------------------------- diff --git a/extensions/cep/modules/distribution/README.md b/extensions/cep/modules/distribution/README.md index ebf6bf2..03358a4 100755 --- a/extensions/cep/modules/distribution/README.md +++ b/extensions/cep/modules/distribution/README.md @@ -1,8 +1,36 @@ # Apache Stratos CEP Extensions -Apache Stratos Complex Event Processor (CEP) extensions include Window Processors for processing -health statistic events. These extensions are available in Stratos binary distribution, in a -distributed deployment where CEP is run externally, these extensions need to be deployed manually. +Apache Stratos Complex Event Processor (CEP) extensions include Window Processors for processing health statistic +events. These extensions are available in Stratos binary distribution, in a distributed deployment where CEP is run +externally, these extensions need to be deployed manually. + +You can setup stratos with either WSO2 CEP 3.0.0 or WSO2 CEP 3.1.0. Please note that only WSO2 CEP 3.1.0 supports +highly available clustered deployment. + +1. Copy jar files in apache-stratos-cep-extension-4.1.5/lib folder to <CEP_HOME>/repository/components/lib. These jar +files are common to both WSO2 CEP 3.0.0 and WSO2 CEP 3.1.0 + +2. Copy files in apache-stratos-cep-extension-4.1.5/wso2cep-<version>/eventbuilders to +<CEP_HOME>/repository/deployment/server/eventbuilders + +3. Copy files in apache-stratos-cep-extension-4.1.5/wso2cep-<version>/eventformatters to +<CEP_HOME>/repository/deployment/server/eventformatters + +4. Copy files in apache-stratos-cep-extension-4.1.5/wso2cep-<version>/executionplans to +<CEP_HOME>/repository/deployment/server/executionplans + +5. Copy files in apache-stratos-cep-extension-4.1.5/wso2cep-<version>/inputeventadaptors to +<CEP_HOME>/repository/deployment/server/inputeventadaptors + +6. Copy files in apache-stratos-cep-extension-4.1.5/wso2cep-<version>/outputeventadaptors to +<CEP_HOME>/repository/deployment/server/outputeventadaptors + +7. Copy files in apache-stratos-cep-extension-4.1.5/wso2cep-<version>/streamdefinitions to +<CEP_HOME>/repository/deployment/server/streamdefinitions + +8. Update message broker endpoint in <CEP_HOME>/repository/deployment/server/outputeventadaptors/JMSOutputAdaptor.xml + +9. Copy files in apache-stratos-cep-extension-4.1.5/wso2cep-<version>/lib to <CEP_HOME>/repository/components/lib Please refer below link for more information on WSO2 CEP. http://wso2.com/products/complex-event-processor/ http://git-wip-us.apache.org/repos/asf/stratos/blob/bd7d2464/extensions/das/modules/artifacts/metering-dashboard/README.md ---------------------------------------------------------------------- diff --git a/extensions/das/modules/artifacts/metering-dashboard/README.md b/extensions/das/modules/artifacts/metering-dashboard/README.md index 21ea33f..c0df3d5 100644 --- a/extensions/das/modules/artifacts/metering-dashboard/README.md +++ b/extensions/das/modules/artifacts/metering-dashboard/README.md @@ -1,13 +1,27 @@ # Apache Stratos Metering Dashboard -This directory contains following artifacts: <br/> -(1) capps - Includes stratos-metering-service car file which bundles all Event Stream, Event receiver, Even Store, Gadgets, SparkScripts and Dashboard artifacts. <br/> -(2) jaggery-files <br/> -(3) ues-patch <br/> - -Follow the below steps to generate the metering dashboard: <br/> -1. Follow instruction given in <Stratos-SOURCE-HOME>/extensions/das/stratos-das-extension/README.md file to add stratos-das-extension jar to DAS. <br/> -2. Add jaggery files which can be found in <Stratos-DAS-Distribution>/metering-dashboard/jaggery-files/ to DAS server path <DAS_HOME/repository/deployment/server/jaggeryapps/portal/controllers/apis/ <br/> -3. Create MySQL database and tables using queries in <Stratos-DAS-Distribution>/metering-dashboard/metering-mysqlscript.sql manually. <br/> -4. Apply ues-patch files in <Stratos-DAS-Distribution>/metering-dashboard/ues-patch/ to DAS as mentioned in its README file. <br/> -5. Add stratos-metering-service car file in <Stratos-DAS-Distribution>/metering-dashboard/ to <DAS-HOME>/repository/deployment/server/carbonapps/ to generate the metering dashboard. <br/> \ No newline at end of file +## This directory contains following artifacts: + +(1) capps - Includes stratos-metering-service car file which bundles all Event Stream, Event receiver, Even Store, + Gadgets, SparkScripts and Dashboard artifacts. + +(2) jaggery-files + +(3) ues-patch + +## Follow the below steps to generate the metering dashboard: + +1. Follow instruction given in <Stratos-SOURCE-HOME>/extensions/das/stratos-das-extension/README.md file to add +stratos-das-extension jar to DAS. + +2. Add jaggery files which can be found in <Stratos-DAS-Distribution>/metering-dashboard/jaggery-files/ to DAS server + path <DAS_HOME/repository/deployment/server/jaggeryapps/portal/controllers/apis/ + +3. Create MySQL database and tables using queries in +<Stratos-DAS-Distribution>/metering-dashboard/metering-mysqlscript.sql manually. + +4. Apply ues-patch files in <Stratos-DAS-Distribution>/metering-dashboard/ues-patch/ to DAS as mentioned in its +README file. + +5. Add stratos-metering-service car file in <Stratos-DAS-Distribution>/metering-dashboard/ to +<DAS-HOME>/repository/deployment/server/carbonapps/ to generate the metering dashboard. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/bd7d2464/extensions/das/modules/artifacts/metering-dashboard/ues-patch/README.md ---------------------------------------------------------------------- diff --git a/extensions/das/modules/artifacts/metering-dashboard/ues-patch/README.md b/extensions/das/modules/artifacts/metering-dashboard/ues-patch/README.md index 2bafefa..0d85e02 100644 --- a/extensions/das/modules/artifacts/metering-dashboard/ues-patch/README.md +++ b/extensions/das/modules/artifacts/metering-dashboard/ues-patch/README.md @@ -2,7 +2,10 @@ This folder (ues-patch) contains fix for DAS-3.0.0 analytics dashboard to suppo dashboard url and publish the values to gadgets. You can find the related UES product jira here: https://wso2.org/jira/browse/UES-582 + Please follow below steps to apply the patch locally: -1. Copy 'ues-gadgets.js' and 'ues-pubsub.js' files to <DAS-HOME>/repository/deployment/server/jaggeryapps/portal/js/ folder. +1. Copy 'ues-gadgets.js' and 'ues-pubsub.js' files to <DAS-HOME>/repository/deployment/server/jaggeryapps/portal/js/ +folder. + 2. Copy 'dashboard.jag' file to <DAS-HOME>/repository/deployment/server/jaggeryapps/portal/theme/templates/ folder. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/bd7d2464/extensions/das/modules/artifacts/monitoring-dashboard/README.md ---------------------------------------------------------------------- diff --git a/extensions/das/modules/artifacts/monitoring-dashboard/README.md b/extensions/das/modules/artifacts/monitoring-dashboard/README.md index d80ff14..968b8cc 100644 --- a/extensions/das/modules/artifacts/monitoring-dashboard/README.md +++ b/extensions/das/modules/artifacts/monitoring-dashboard/README.md @@ -1,12 +1,25 @@ # Apache Stratos Monitoring Dashboard -This directory contains following artifacts: <br /> -(1) capps - Includes stratos-monitoring-service car file which bundles all Event Stream, Event receiver, Even Store, Gadgets, SparkScripts and Dashboard artifacts. <br /> -(2) jaggery-files <br /> - -Follow the below steps to generate the monitoring dashboard: <br /> -1. Add jaggery files which can be found in <Stratos-DAS-Distribution>/monitoring-dashboard/jaggery-files/ to DAS path '<DAS_HOME/repository/deployment/server/jaggeryapps/portal/controllers/apis/' <br/> -2. Create MySQL database and tables using queries in <Stratos-DAS-Distribution>/monitoring-dashboard/monitoring-mysqlscript.sql manually. <br /> -3. Copy CEP EventFormatter artifacts in <Stratos-DAS-Distribution>/wso2cep-<version>/eventformatters/ to <CEP-HOME>/repository/deployment/server/eventformatters/. <br /> -4. Copy CEP OutputEventAdapter artifact in <Stratos-DAS-Distribution>/wso2cep-<version>/outputeventadaptors/ to <CEP-HOME>/repository/deployment/server/outputeventadaptors and update the tcp and ssl ports according to DAS server port offset. <br /> -5. Add stratos-monitoring-service car file in <Stratos-DAS-Distribution>/monitoring-dashboard/ to <DAS-HOME>/repository/deployment/server/carbonapps/ to generate the monitoring dashboard. <br /> \ No newline at end of file +## This directory contains following artifacts: +(1) capps - Includes stratos-monitoring-service car file which bundles all Event Stream, Event receiver, Even Store, +Gadgets, SparkScripts and Dashboard artifacts. + +(2) jaggery-files + +## Follow the below steps to generate the monitoring dashboard: + +1. Add jaggery files which can be found in <Stratos-DAS-Distribution>/monitoring-dashboard/jaggery-files/ to DAS path + <DAS_HOME/repository/deployment/server/jaggeryapps/portal/controllers/apis/. + +2. Create MySQL database and tables using queries in +<Stratos-DAS-Distribution>/monitoring-dashboard/monitoring-mysqlscript.sql manually. + +3. Copy CEP EventFormatter artifacts in <Stratos-DAS-Distribution>/wso2cep-<version>/eventformatters/ to +<CEP-HOME>/repository/deployment/server/eventformatters/. + +4. Copy CEP OutputEventAdapter artifact in <Stratos-DAS-Distribution>/wso2cep-<version>/outputeventadaptors/ to +<CEP-HOME>/repository/deployment/server/outputeventadaptors and update the tcp and ssl ports according to DAS server + port offset. + +5. Add stratos-monitoring-service car file in <Stratos-DAS-Distribution>/monitoring-dashboard/ to +<DAS-HOME>/repository/deployment/server/carbonapps/ to generate the monitoring dashboard. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/bd7d2464/extensions/das/modules/distribution/README.md ---------------------------------------------------------------------- diff --git a/extensions/das/modules/distribution/README.md b/extensions/das/modules/distribution/README.md index 1354716..0ae46c9 100644 --- a/extensions/das/modules/distribution/README.md +++ b/extensions/das/modules/distribution/README.md @@ -1,7 +1,48 @@ # Apache Stratos DAS Extensions -Apache Stratos Data Analytics Server (DAS) extensions include DAS artifacts and spark udf to run spark script. -These extensions need to be deployed manually when running DAS externally. +Apache Stratos Data Analytics Server (DAS) extensions include DAS artifacts and stratos-das-extension jar which has +spark UDF (User Defined Funtion) used in spark script. You can configure an external DAS for stratos metering and +monitoring feature as below: + +## Follow the below steps to configure DAS for metering dashboard: + +1. Add org.apache.stratos.das.extension-<stratos-version>.jar file to <DAS-HOME>/repository/components/lib/. + +2. Add UDF class '<class-name>org.apache.stratos.das.extension.TimeUDF</class-name>' to 'spark-udf-config.xml' file +in <DAS-HOME>/repository/conf/analytics/spark/' folder. + +3. Add jaggery files which can be found in <Stratos-DAS-Distribution>/metering-dashboard/jaggery-files/ to DAS server + path <DAS_HOME/repository/deployment/server/jaggeryapps/portal/controllers/apis/. + +4. Create MySQL database and tables using queries in +<Stratos-DAS-Distribution>/metering-dashboard/metering-mysqlscript.sql manually. + +5. Apply ues-patch files in <Stratos-DAS-Distribution>/metering-dashboard/ues-patch/ to DAS below: + - Copy 'ues-gadgets.js' and 'ues-pubsub.js' files to + <DAS-HOME>/repository/deployment/server/jaggeryapps/portal/js/ folder. + - Copy 'dashboard.jag' file to <DAS-HOME>/repository/deployment/server/jaggeryapps/portal/theme/templates/ folder. + +6. Add stratos-metering-service car file in <Stratos-DAS-Distribution>/metering-dashboard/ to +<DAS-HOME>/repository/deployment/server/carbonapps/ to generate the metering dashboard. + +## Follow the below steps to configure DAS for monitoring dashboard: + +1. Add jaggery files which can be found in <Stratos-DAS-Distribution>/monitoring-dashboard/jaggery-files/ to DAS path +'<DAS_HOME/repository/deployment/server/jaggeryapps/portal/controllers/apis/'. + +2. Create MySQL database and tables using queries in +<Stratos-DAS-Distribution>/monitoring-dashboard/monitoring-mysqlscript.sql manually. + +3. Copy CEP EventFormatter artifacts in <Stratos-DAS-Distribution>/wso2cep-<version>/eventformatters/ to +<CEP-HOME>/repository/deployment/server/eventformatters/. + +4. Copy CEP OutputEventAdapter artifact in <Stratos-DAS-Distribution>/wso2cep-<version>/outputeventadaptors/ to +<CEP-HOME>/repository/deployment/server/outputeventadaptors and update the tcp and ssl ports according to DAS server +port offset. + +5. Add stratos-monitoring-service car file in <Stratos-DAS-Distribution>/monitoring-dashboard/ to +<DAS-HOME>/repository/deployment/server/carbonapps/ to generate the monitoring dashboard. + Please refer below link for more information on WSO2 DAS. https://docs.wso2.com/display/DAS300/WSO2+Data+Analytics+Server+Documentation http://git-wip-us.apache.org/repos/asf/stratos/blob/bd7d2464/extensions/das/modules/stratos-das-extension/README.md ---------------------------------------------------------------------- diff --git a/extensions/das/modules/stratos-das-extension/README.md b/extensions/das/modules/stratos-das-extension/README.md index 58bdd5b..59fe665 100644 --- a/extensions/das/modules/stratos-das-extension/README.md +++ b/extensions/das/modules/stratos-das-extension/README.md @@ -1,6 +1,8 @@ # Apache Stratos DAS Extension -This directory contains DAS Extensions needed for Stratos. <br /> -1. Add org.apache.stratos.das.extension-<stratos-version>.jar file to '<DAS-HOME>/repository/components/lib/'. <br /> -2. Add below UDF class path to 'spark-udf-config.xml' file in '<DAS-HOME>/repository/conf/analytics/spark/' folder. <br /> - <class-name>org.apache.stratos.das.extension.TimeUDF</class-name> <br /> \ No newline at end of file +This directory contains DAS Extensions needed for Stratos. + +1. Add org.apache.stratos.das.extension-<stratos-version>.jar file to <DAS-HOME>/repository/components/lib/. + +2. Add UDF class '<class-name>org.apache.stratos.das.extension.TimeUDF</class-name>' to 'spark-udf-config.xml' +file in <DAS-HOME>/repository/conf/analytics/spark/ folder. \ No newline at end of file
