Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edited the top-level README and user-guides for cloud templates #23

Merged
merged 2 commits into from
Apr 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions cloud_templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,32 @@ These templates are designed in four different patterns to ingest your IoT data
<center><img src="https://d2908q01vomqb2.cloudfront.net/f6e1126cedebf23e1463aee73f9df08783640400/2022/04/04/Blog-IoT-Reporting-3-Timstream.png" alt="alt text"/></center>
</br>

In this structure, first the MQTT messages are captured in IoT Core and then pushed to Amazon Timestream by using IoT Core built rule which will provide a table view of the data to the customer. To create graphical visuals based on the data you can integrate Timestream with several visualization toools such as Amazon QuickSight. To learn more about the IoT Core-Timestream rule please see [here](https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html).

2. AWS IoT Analytics
<br>
<center><img src="https://d2908q01vomqb2.cloudfront.net/f6e1126cedebf23e1463aee73f9df08783640400/2022/04/04/Blog-IoT-Reporting-3-IotAnalytics.png" alt="alt text"/></center>
</br>

In this structure, after capturing the MQTT messages, using IoT Core built in rule, data is sent to an AWS IoT Analytics channel. Then the data will be directed to the Analytics Datastore through the Analytics pipeline. To learn more about the IoT Core to IoT Analytics rule check [here](https://docs.aws.amazon.com/iot/latest/developerguide/iotanalytics-rule-action.html). IoT Analytics automates the steps required to analyze data from IoT devices. It can filter, transform, and enrich IoT data before storing it in a time-series data store for analysis. AWS IoT Analytics is available in the following [regions](https://aws.amazon.com/iot-analytics/pricing/).

3. Amazon Kinesis Data Firehose

<br>
<center><img src="https://d2908q01vomqb2.cloudfront.net/f6e1126cedebf23e1463aee73f9df08783640400/2022/04/04/Blog-IoT-Reporting-3-KinesisAthena.png" alt="alt text"/></center>
</br>

In this pattern, the captured MQTT messages in AWS IoT core will be sent to an Amazon Kinesis Data Firehose allowing you to collect, process and analyze large bandwidth of data in real time. The service enables you to author and run code against streaming sources to perform time-series analytics, feed real-time dashboards, and create real-time metrics. You can create a Delivery Stream in the Kinesis Firehose with an S3 bucket as its destination in which the data will be stored. You can then visualize the data in the bucket by building an [Athena table](https://docs.aws.amazon.com/athena/latest/ug/data-sources-glue.html) (using Glue Crawler) on top of that and [connecting Athena to Amazon Quicksight](https://docs.aws.amazon.com/quicksight/latest/user/create-a-data-set-athena.html). Detailed information about the IoT Core rule for sending data to Kinesis Data Firehose is available [here](https://docs.aws.amazon.com/iot/latest/developerguide/kinesis-firehose-rule-action.html). Amazon Kinesis Firehose is available in the following [regions](https://aws.amazon.com/kinesis/data-firehose/pricing/).

4. Amazon OpenSearch Service
<br>
<center><img src="https://d2908q01vomqb2.cloudfront.net/f6e1126cedebf23e1463aee73f9df08783640400/2022/04/04/Blog-IoT-Reporting-3-OpenSearch.png" alt="alt text"/></center>
</br>

Amazon OpenSearch Service is a managed service that makes it easy to deploy, operate, and scale OpenSearch clusters in the AWS Cloud. It is a fully open-source search and analytics engine for use cases such as log analytics, real-time application monitoring, and clickstream analysis. To learn more you can refer to [What is Amazon OpenSearch Service?](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/) in the Amazon OpenSearch Service Developer Guide.
In this pattern, the captured data in IoT Core will be pushed to Amazon OpenSearch service through built in IoT rule. You can then use tools like OpenSearch integrated dashboards to query and visualize data in OpenSearch Service. For more details refer to [OpenSearch rule action](https://docs.aws.amazon.com/iot/latest/developerguide/opensearch-rule-action.html).


The subdirectories contain the following:

* Under `demo` directory, there are the demo templates along with a sample program to run on your Expresslink.
Expand Down
3 changes: 2 additions & 1 deletion cloud_templates/user_guides/opensearch_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ If you are interested in using the CloudFormation templates more than just for d
3. Just to verify everything is working correctly, list the stacks in your app by running `cdk ls` command. If you don't see `OpensearchPatternStack`, make sure you are currently in `OpenSearchPattern` directory.
4. The structure of the files inside `OpenSearchPattern` is as below:

[Image: Screen Shot 2022-08-25 at 12.52.09 PM.png]
<img src="images/opensearch_structure.png" height="350" align="left">

* `open_search_pattern_stack.py` is the main code of the stack. It is here where the required resources are created.
* `tests/unit/test_open_search_pattern_stack.py` is where the unit tests of the stack is written. The unit tests check
* Right creation of the resources in addition to their properties
Expand Down