Skip to content

Commit cb73d91

Browse files
Yamini-MicrosoftYamini-Microsoft
committed
docs: Update README with new 7-step deployment guide anchors
- Update deployment guide table with new section anchors - Link to Step 1-7 sections instead of old flat structure - Maintain all Quick deploy options and badges - Align README navigation with refactored DeploymentGuide
1 parent 0529d61 commit cb73d91

1 file changed

Lines changed: 256 additions & 0 deletions

File tree

‎README copy.md‎

Lines changed: 256 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,256 @@
1+
# Real-Time Intelligence for Operations Solution Accelerator
2+
3+
This solution accelerator provides a complete real-time intelligence platform for manufacturing operations. It analyzes live and historical telemetry data through interactive dashboards, automatically detects anomalies with email alerts, and includes an AI-powered data agent for conversational insights. The architecture and approach can be easily extended to other industries for broad adoption.
4+
5+
**Key use cases include:**
6+
7+
- Real-time dashboard with up-to-date analysis and reporting.
8+
- Anomaly detection and notification.
9+
- Customized data agent answering users' questions with intelligence derived from the data.
10+
11+
<br/>
12+
13+
<div align="center">
14+
15+
[**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS SCENARIO**](#business-use-case) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
16+
17+
</div>
18+
<br/>
19+
20+
<h2><img src="./docs/images/readme/solution-overview.png" width="48" />
21+
Solution overview
22+
</h2>
23+
24+
This solution accelerator delivers comprehensive asset monitoring, real-time anomaly detection, and automated notifications for manufacturing operations.
25+
26+
### Solution architecture
27+
28+
Below diagram illustrates the solution architecture. Synthetic telemetry data is generated by the `Telemetry Data Simulator`. The architecture easily adapts to other industries by connecting your own data sources to `Azure Event Hub` and customizing the dashboards and queries. For technical details, see the [Solution Architecture Overview](./docs/TechnicalArchitecture.md).
29+
30+
| ![image](./docs/images/readme/solution-architecture.png) |
31+
| -------------------------------------------------------- |
32+
| |
33+
34+
### How to customize
35+
If you'd like to customize the solution accelerator, here are some common areas to start:
36+
37+
- Data generation and collection: You can customize the data simulator to generate data that is closely aligned with your own industry or your own company.
38+
- Update the KQL queries for the tiles in Real-Time Intelligence dashboard.
39+
- Update the Activator rules to meet your business needs.
40+
- Update the instructions to the Fabric Data Agent to align with your own business goals and data insights.
41+
42+
<br/>
43+
44+
### Additional resources
45+
46+
[What's New in Microsoft Fabric](https://learn.microsoft.com/en-us/fabric/fundamentals/whats-new)
47+
48+
[Microsoft Fabric Blog](https://blog.fabric.microsoft.com/en-us/blog)
49+
50+
[What Is Real-Time Intelligence in Microsoft Fabric? ](https://learn.microsoft.com/en-us/fabric/real-time-intelligence/overview)
51+
52+
[Fabric data agent creation](https://learn.microsoft.com/en-us/fabric/data-science/concept-data-agent)
53+
54+
<br/>
55+
56+
### Key features
57+
<details>
58+
<summary>Click to learn more about the key features this solution enables</summary>
59+
60+
- **Fabric Data Ingestion Program and Real-Time Event Simulator** <br/>One-time batch historical data simulator and real-time telemetry data simulator are provided. For more details, please refer to [Fabric Data Ingestion Guide](./docs/FabricDataIngestion.md) and [Event Simulator Guide](./docs/EventSimulatorGuide.md).
61+
62+
- **Real-Time Intelligence Operations Dashboard** <br/>Real-Time Intelligence Operations Dashboard provides an overview of how manufacturing assets are performing, and shows individual sensor data trends. For details, please refer to [Real-Time Intelligence Dashboard Guide](./docs/RealTimeIntelligenceDashboardGuide.md).
63+
64+
- **Fabric EventHouse with Customized Fabric Data Agent**
65+
66+
Manufacturing telemetry data is hosted in Fabric EventHouse. You can use conversational interface powered by Fabric Data Agent for live operational queries. For details, please refer to [Fabric Data Agent Guide](./docs/FabricDataAgentGuide.md).
67+
68+
- **Anomaly Detection and Alerts through Fabric Activator** <br/>Microsoft Activator is configured with anomaly detection rules that trigger Outlook email notifications when an anomaly occurs. For more details, please refer to [Activator Guide](./docs/ActivatorGuide.md).
69+
70+
- **Useful Data Analysis and Performance Metrics KQL Code** <br/>Reusable KQL code is provided to get you started quickly. For details, please refer to [Data Analysis KQL Guide](./src/kql/data_analysis/data_analysis_guide.md) and [Performance Metrics KQL Queryset Guide](./src/kql/kql_queryset/kql_queryset_guide.md).
71+
72+
- **Demonstrator's Guide** <br/> After successful deployment of the solution accelerator, you or your colleague who has required access can demonstrate this solution by following the steps outlined in the [Demonstrator's Guide](./docs/DemonstratorGuide.md).
73+
74+
</details>
75+
76+
<br /><br />
77+
78+
<h2><img src="./docs/images/readme/quick-deploy.png" width="48" />
79+
Quick deploy
80+
</h2>
81+
82+
### How to install or deploy
83+
84+
Follow these steps to deploy the solution to your own Azure subscription:
85+
86+
| [![GitHub Codespaces](https://img.shields.io/badge/GitHub_Codespaces-Open-grey?style=flat&labelColor=grey&message=Open&color=blue&logo=github)](https://codespaces.new/microsoft/real-time-intelligence-operations-solution-accelerator) | [![Visual Studio Code Dev Containers](https://img.shields.io/badge/Visual_Studio_Code_Dev_Container-Open-gray?style=flat&labelColor=grey&message=Open&color=blue)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/real-time-intelligence-operations-solution-accelerator) | [![Visual Studio Code Web](https://img.shields.io/badge/Visual_Studio_Code_Web-Open-gray?style=flat&labelColor=grey&message=Open&color=blue)](https://vscode.dev/github/microsoft/real-time-intelligence-operations-solution-accelerator) | [![Azure Cloud Shell](https://img.shields.io/badge/Azure_Cloud_Shell-Open-grey?style=flat&labelColor=grey&message=Open&color=blue)](https://portal.azure.com/#cloudshell/) |
87+
|---|---|---|---|
88+
89+
**One-command deployment** - Deploy everything with [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd) and [Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli) (check [prerequisites](./docs/DeploymentGuide.md#step-1-prerequisites--setup)):
90+
91+
```bash
92+
# Clone and navigate to repository
93+
git clone https://github.com/microsoft/real-time-intelligence-operations-solution-accelerator.git
94+
cd real-time-intelligence-operations-solution-accelerator
95+
96+
# Authenticate (required)
97+
azd auth login # Required to deploy with azd up
98+
az login # Required to use the Azure CLI commands that connect Azure resources to Fabric workspace
99+
100+
# Recommended: set email to receive alerts
101+
azd env set FABRIC_ACTIVATOR_ALERTS_EMAIL "myteam@company.com"
102+
103+
104+
# Optional: Customize resource names
105+
azd env set FABRIC_WORKSPACE_NAME "My RTI Workspace"
106+
azd env set FABRIC_WORKSPACE_ADMINISTRATORS "user@company.com,12345678-1234-abcd-1234-123456789abc" # comma-separated
107+
azd env set FABRIC_EVENTHOUSE_NAME "my_custom_eventhouse"
108+
azd env set FABRIC_EVENTHOUSE_DATABASE_NAME "my_custom_kql_db"
109+
azd env set FABRIC_EVENT_HUB_CONNECTION_NAME "my_eventhub_connection"
110+
azd env set FABRIC_RTIDASHBOARD_NAME "My Custom Dashboard"
111+
azd env set FABRIC_EVENTSTREAM_NAME "my_custom_eventstream"
112+
azd env set FABRIC_ACTIVATOR_NAME "my_custom_activator"
113+
114+
# Deploy everything
115+
azd up
116+
```
117+
<br/>
118+
119+
Check more deployment aspects in our [deployment guide](./docs/DeploymentGuide.md):
120+
121+
| Topic | Description |
122+
|---|---|
123+
| [**Prerequisites**](./docs/DeploymentGuide.md#step-1-prerequisites--setup) | Required Azure permissions, API access, and software installations (Python, Azure CLI, azd) |
124+
| [**Deployment Environment**](./docs/DeploymentGuide.md#step-2-choose-your-deployment-environment) | Choose your deployment method: local machine, GitHub Codespaces, VS Code Dev Container, Azure Cloud Shell, or GitHub Actions |
125+
| [**Configuration Settings**](./docs/DeploymentGuide.md#step-3-configure-deployment-settings---advanced-configuration) | Optional: Customize workspace names, component names, email alerts, and capacity options |
126+
| [**Deploy the Solution**](./docs/DeploymentGuide.md#step-4-deploy-the-solution) | Execute the deployment with detailed step-by-step instructions and verification |
127+
| [**Post-Deployment Setup**](./docs/DeploymentGuide.md#step-5-post-deployment-configuration) | Configure Fabric Data Agent, Event Simulator, Activator rules, and explore features |
128+
| [**Deployment Results**](./docs/DeploymentGuide.md#step-6-deployment-results) | Verify Azure infrastructure, Fabric workspace components, and data flow |
129+
| [**Cleanup**](./docs/DeploymentGuide.md#step-7-clean-up-optional) | Remove all deployed resources with `azd down` or manual cleanup |
130+
| [**Known Issues**](./docs/DeploymentGuide.md#known-issues-and-troubleshooting) | Troubleshoot common issues and known limitations |
131+
132+
### Prerequisites and costs
133+
Microsoft Fabric Capacity is enabled for your organization. Please refer to [Enable Microsoft Fabric for your organization](https://learn.microsoft.com/en-us/fabric/admin/fabric-switch) for more information.
134+
135+
To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and Role Based Access Control role on the subscription and/or resource group level. Follow the steps in [Azure Account Set Up](./docs/AzureAccountSetUp.md).
136+
137+
Licensing and cost for establishing Fabric can be found at [Microsoft Fabric concepts and licenses](https://learn.microsoft.com/en-us/fabric/enterprise/licenses#capacity) and [Microsoft Fabric Pricing](https://azure.microsoft.com/en-us/pricing/details/microsoft-fabric/).
138+
139+
Consumption model and pricing information for Azure Databricks can be found at [Serverless DBU consumption by SKU - Azure Databricks](https://learn.microsoft.com/en-us/azure/databricks/resources/pricing).
140+
141+
_Note: This is not meant to outline all costs as selected SKUs, scaled use, customizations, and integrations into your own tenant can affect the total consumption of this sample solution. The sample pricing sheet is meant to give you a starting point to customize the estimate for your specific needs._
142+
143+
<br/>
144+
145+
| Product | Description | Cost |
146+
|---|---|---|
147+
| [Microsoft Fabric](https://learn.microsoft.com/en-us/fabric) | Core Medallion Architecture in Microsoft Fabric, and Unified Data Platform for integration with other platforms such as Azure Databricks and Snowflakes. | [Pricing](https://learn.microsoft.com/en-us/fabric/enterprise/buy-subscription#prerequisites) |
148+
149+
<br/>
150+
151+
>⚠️ **Important:** To avoid unnecessary costs, remember to take down your app if it's no longer in use,
152+
either by deleting the resource group in the Portal or running `azd down`.
153+
154+
<br /><br />
155+
156+
<h2><img src="./docs/images/readme/business-scenario.png" width="48" />
157+
Business use case
158+
</h2>
159+
Use cases can be summarized as below:
160+
161+
- For manufacturing plants, the plant manager or other business stakeholders can use the Fabric Data Agent to get business and operations intelligence quickly without the need to create query code. For details, please refer to [Fabric Data Agent Guide](./docs/FabricDataAgentGuide.md).
162+
163+
- For manufacturing plants, the designated operations team receives email notification when an anomaly occurs. The solution can also be configured to send anomaly notifications to a Teams Channel. For rule configuration options (Email or Teams), please refer to [Activator Guide](./docs/ActivatorGuide.md).
164+
165+
- Plant manager uses real-time dashboard to analyze manufacturing plant asset performance, key telemetry data over time.
166+
167+
The image below shows the first page of the real-time intelligence operations dashboard, which displays sensor status, quality metrics, and individual sensor data trends. The second page shows additional information such as daily anomaly rate by asset, asset maintenance status, and fault correlations. For more details, please refer to [Real-Time Intelligence Operations Dashboard Guide](./docs/RealTimeIntelligenceDashboardGuide.md).
168+
169+
| ![image](./docs/images/readme/rti-dashboard.png) |
170+
| ------------------------------------------------ |
171+
172+
<br/>
173+
174+
⚠️ The sample data used in this repository is synthetic and generated using Python Programs. The data is intended for use as sample data only.
175+
176+
### Business value
177+
<details>
178+
<summary>Click to learn more about what value this solution provides</summary>
179+
180+
- **The solution provides multiple business functions with a simple architecture** <br/>
181+
The deployed solution provides real-time telemetry data monitoring, analysis, summarization, graphical reports, anomaly detection and notifications with a quick to deploy, secure, and simple architecture.
182+
183+
- **A Fabric Data Agent getting quick business intelligence without programming effort** <br/>
184+
The Fabric Data Agent can be quickly configured with instructions delivered in this solution accelerator, providing quick and accurate insights from data effortlessly. No programming skills are necessary.
185+
186+
- **Real-Time Intelligence for Operations Dashboard**<br/>
187+
The deployed solution accelerator provides a working architecture with best practices, security, components integration, and real-time intelligence for operations dashboard.
188+
189+
- **Configurable Activator providing anomaly detection and notifications** <br/>
190+
The deployed and configurable Activator provides real-time anomaly detection and alert notifications out of the box. The rules are easily configurable.
191+
192+
- **Reusable and updatable real-time event simulator and batch data update program** <br/>
193+
Real-time telemetry data simulator and batch data ingestion / update program are provided to help to bring the solution to simulate a real-time environment quickly.
194+
195+
</details>
196+
197+
<br /><br />
198+
199+
<h2><img src="./docs/images/readme/supporting-documentation.png" width="48" />
200+
Supporting documentation
201+
</h2>
202+
203+
### Security guidelines
204+
205+
This template uses Azure Key Vault to store all connections to communicate between resources.
206+
207+
This template also uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for local development and deployment.
208+
209+
To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [GitHub secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled.
210+
211+
You may want to consider additional security measures, such as:
212+
213+
* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/en-us/azure/defender-for-cloud/).
214+
* Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli).
215+
216+
<br/>
217+
218+
### Frequently asked questions
219+
220+
[Click here](./docs/FAQs.md) to learn more about common questions about this solution.
221+
222+
<br/>
223+
224+
### Cross references
225+
Check out similar solution accelerators
226+
227+
| Solution Accelerator | Description |
228+
|---|---|
229+
| [Unified Data Foundation with Microsoft Fabric](https://github.com/microsoft/unified-data-foundation-with-fabric-solution-accelerator) | Unified Data Foundation with Microsoft Fabric with Options to Integrate with Azure Databricks and Microsoft Purview. |
230+
| [Agentic applications for unified data foundation](https://github.com/microsoft/agentic-applications-for-unified-data-foundation-solution-accelerator) | Agentic AI application that provides natural language query of the data using unified data foundation. Description of solution accelerator. |
231+
232+
<br/>
233+
234+
235+
## Provide feedback (To update the link)
236+
237+
Have questions, find a bug, or want to request a feature? [Submit a new issue](https://github.com/microsoft/real-time-intelligence-operations-solution-accelerator/issues) on this repo and we'll connect.
238+
239+
<br/>
240+
241+
## Responsible AI Transparency FAQ (To update the Transparency FAQs)
242+
Please refer to [Transparency FAQ](./TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
243+
244+
<br/>
245+
246+
## Disclaimers
247+
248+
To the extent that the Software includes components or code used in or derived from Microsoft products or services, including without limitation Microsoft Azure Services (collectively, "Microsoft Products and Services"), you must also comply with the Product Terms applicable to such Microsoft Products and Services. You acknowledge and agree that the license governing the Software does not grant you a license or other right to use Microsoft Products and Services. Nothing in the license or this ReadMe file will serve to supersede, amend, terminate or modify any terms in the Product Terms for any Microsoft Products and Services.
249+
250+
You must also comply with all domestic and international export laws and regulations that apply to the Software, which include restrictions on destinations, end users, and end use. For further information on export restrictions, visit https://aka.ms/exporting.
251+
252+
You acknowledge that the Software and Microsoft Products and Services (1) are not designed, intended or made available as a medical device(s), and (2) are not designed or intended to be a substitute for professional medical advice, diagnosis, treatment, or judgment and should not be used to replace or as a substitute for professional medical advice, diagnosis, treatment, or judgment. Customer is solely responsible for displaying and/or obtaining appropriate consents, warnings, disclaimers, and acknowledgements to end users of Customer's implementation of the Online Services.
253+
254+
You acknowledge the Software is not subject to SOC 1 and SOC 2 compliance audits. No Microsoft technology, nor any of its component technologies, including the Software, is intended or made available as a substitute for the professional advice, opinion, or judgement of a certified financial services professional. Do not use the Software to replace, substitute, or provide professional financial advice or judgment.
255+
256+
BY ACCESSING OR USING THE SOFTWARE, YOU ACKNOWLEDGE THAT THE SOFTWARE IS NOT DESIGNED OR INTENDED TO SUPPORT ANY USE IN WHICH A SERVICE INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE COULD RESULT IN THE DEATH OR SERIOUS BODILY INJURY OF ANY PERSON OR IN PHYSICAL OR ENVIRONMENTAL DAMAGE (COLLECTIVELY, "HIGH-RISK USE"), AND THAT YOU WILL ENSURE THAT, IN THE EVENT OF ANY INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE, THE SAFETY OF PEOPLE, PROPERTY, AND THE ENVIRONMENT ARE NOT REDUCED BELOW A LEVEL THAT IS REASONABLY, APPROPRIATE, AND LEGAL, WHETHER IN GENERAL OR IN A SPECIFIC INDUSTRY. BY ACCESSING THE SOFTWARE, YOU FURTHER ACKNOWLEDGE THAT YOUR HIGH-RISK USE OF THE SOFTWARE IS AT YOUR OWN RISK.

0 commit comments

Comments
 (0)