Another Pack from IBM (MONITOR_INGEST)

.circleci/config.yml

@@ -30,7 +30,7 @@ jobs:
       - run:
           name: Download dependencies
           command: |
-            git clone -b ${CI_BRANCH:-master} [email protected]:StackStorm-Exchange/ci.git ~/ci
+            git clone -b ${CI_BRANCH:-master} [email protected]:Anshika-Gautam/ci.git ~/ci
             ~/ci/.circle/dependencies
       - run:
           name: Run tests

monitor_ingest/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

monitor_ingest/README.md

@@ -0,0 +1,152 @@
+# IBM Maximo Monitor Ingest Pack
+
+This pack uses Maximo Monitor SDK (https://github.com/ibm-watson-iot/maximo-asset-monitor-sdk.git) in StackStorm dynamically. It has following features:
+
+- Create Entities in Maximo Assset Monitor
+- Add Constants, Dimensions and Functions
+- Cleaning the CSV data files as per a valid schema
+- Load metrics data from a CSV to Maximo
+
+# <a name="QuickStart"></a> Quick Start
+## Prerequisites
+
+IBM monitor Ingest pack,
+IBM Cloud Access,
+IBM Maximo Analytics service Access, Stackstorm,
+Python 3.7.
+
+## Setup
+
+### Install Monitor Ingest pack on local StackStorm env
+1. Clone from Github repo [Monitor Ingest_pack](https://github.com/maximo-developer/monitor_ingest):
+
+    ```
+    # clone Monitor_Ingest code from github repo
+    cd /opt/stackstorm/packs/
+    git clone --branch st2 https://github.com/maximo-developer/monitor_ingest.git
+    ```
+## Get credentials
+2. Set credentials to connect Watson Analytics Service:
+- On the user interface, go to the Services tab.
+- Select Watson IoT Platform Analytics and click View Details.
+- In the Environment Variables field, click Copy to Clipboard.
+
+## Configuration
+
+3. Copy the example configuration in [monitor_ingest.yaml.example](./monitor_ingest.yaml.example)
+to `/opt/stackstorm/configs/monitor_ingest.yaml` and edit as per credentials copied in Step 2.
+
+Config file must have action_type, data_file_path and credentials keys.
+To run a specific Actions use `action_type`, `data_file_path` and `credentials` keys.
+`action_type` : action type name
+`data_file_path` : source json input file for specified action type
+`credentials` : Analytics service credentials
+
+** Check [config.schema.yaml](./config.schema.yaml) schema before creating your config file.
+
+Example configuration:
+
+```yaml
+action_type : "SetupEntityAction | SetupAddConstants | SetupAddDimesions | SetupAddFunctions "
+entity_name : ""
+data_file_path : "/opt/stackstorm/packs/monitor_ingest/etc/sample_usage_data.json"
+credentials:
+    _id: "id*******"
+    tenantId: "tenant Id"
+    db2:
+      username: "username"
+      password: "pwd"
+      databaseName: BLUDB
+      port: 50001
+      httpsUrl: "https://*******.cloud.ibm.com"
+      host: "*******.cloud.ibm.com"
+      security: SSL
+    iotp:
+      url: "https://orgId**.internetofthings.ibmcloud.com/api/v0002"
+      orgId: "org Id"
+      host: "orgId**.messaging.internetofthings.ibmcloud.com"
+      port: 8883
+      asHost: "*********.internetofthings.ibmcloud.com"
+      apiKey: "api_key"
+      apiToken: "api_token"
+    messageHub:
+      brokers:
+      - broker-0-****************************.us-south.eventstreams.cloud.ibm.com:9093
+      - broker-1-****************************.us-south.eventstreams.cloud.ibm.com:9093
+      - broker-5-****************************.us-south.eventstreams.cloud.ibm.com:9093
+      - broker-4-****************************.us-south.eventstreams.cloud.ibm.com:9093
+      - broker-2-****************************.us-south.eventstreams.cloud.ibm.com:9093
+      - broker-3-****************************.us-south.eventstreams.cloud.ibm.com:9093
+      username: "user name"
+      password: "password"
+    objectStorage:
+      region: global
+      username: "user name"
+      password: "password"
+    config:
+      objectStorageEndpoint: https://undefined
+      bos_logs_bucket: "log bucket"
+      bos_runtime_bucket: "runtime bucket"
+      mh_topic_analytics_alerts: ''
+```
+
+**Note** : When modifying the configuration in `/opt/stackstorm/configs/` please
+           remember to tell StackStorm to load these new values by running
+           `sudo st2ctl reload --register-configs`
+
+## Creating Vitual environment in StackStorm (Required only if testing in St2 env)
+
+    ```
+    # 1. Setup monitor_ingest Virtual Env in SackStorm 
+    st2 run packs.setup_virtualenv packs=monitor_ingest python3=True
+
+    # 2. Reload pack actions 
+    sudo st2ctl reload --register-all
+
+    # 3. Fetch list of installed actions 
+    st2 action list -p monitor_ingest
+
+    # 4. Run an action
+    st2 run <pack.action_name>
+    ```
+
+## Actions
+
+The following actions are supported:
+
+### Setup Entity ``setup_entity``
+`[Mandatory]`
+* To Setup Entity Action use action_type - ``SetupEntityAction``
+* To Add Constants to an Entity use action_type - ``SetupAddConstants``
+* To Add Dimesions to an Entity use action_type - ``SetupAddDimesions``
+* To Add Functions to an Entity use action_type - ``SetupAddFunctions``
+* Specify json file path in config -``data_file_path`` 
+#### Check /etc directory for Sample data files for Setup Entity Action
+* for SetupEntityAction sample [data_file_path](./etc/sample_usage_data.json)
+* for SetupAddConstants sample [data_file_path](./etc/sample_constant_data.json)
+* for SetupAddDimesions sample [data_file_path](./etc/sample_dimension_data.json)
+* for SetupAddFunctions sample [data_file_path](./etc/sample_function_data.json)
+
+### Clean CSV metrics data from a CSV ``clean_csv_data``
+`[Mandatory]`
+* Specify json Schema file path in config -``json_schema_path``
+* Specify csv file path in config -``data_file_path``
+#### Check /etc directory for Sample data files for clean_csv_data Action
+* for clean_csv_data sample [data_file_path](./etc/sample_csv_data.csv)
+* for clean_csv_data sample [json_schema_path](./etc/csvSchema.json)
+``Action Output`` - clean and error csv files will be under ./etc/clean_data_output/__.csv
+
+### Data metrics data ingestion using CSV ``csv_data_ingest``
+`[Mandatory]`
+* Specify json file path in config -``data_file_path``
+* Specify entity name in config - ``entity_name``
+#### Check /etc directory for Sample data files for csv_data_ingest Action
+* for csv_data_ingest [sample data file](./etc/sample_csv_data.csv)
+* or for a clean csv please check under ./etc/clean_data_output/
+
+
+## Workflow 
+* Action chain workflow added ``clean_data_ingest_chain``
+
+## Maximo Packs [Documents](https://maximo-developer.github.io/monitor-st2-docs/)
+

monitor_ingest/actions/chains/clean_data_ingest_chain.yaml

@@ -0,0 +1,10 @@
+---
+  chain:
+      -
+        name: "clean_csv_data"
+        ref: "monitor_ingest.clean_csv_data"
+        on-success: "data_ingest"
+      -
+        name: "data_ingest"
+        ref: "monitor_ingest.csv_data_ingest"
+  default: "clean_csv_data"

monitor_ingest/actions/clean_data_ingest_chain.meta.yaml

@@ -0,0 +1,10 @@
+---
+  name: "clean_data_ingest_chain"
+  description: "Action Chain to pre process CSV metrics data and ingest it to monitor."
+  runner_type: "action-chain"
+  pack: monitor_ingest
+  enabled: true
+  entry_point: "chains/clean_data_ingest_chain.yaml"
+  notify:
+    on-complete:
+      message: " Action succeeded."