Skip to content

Commit b611cb2

Browse files
authored
readme
1 parent 6dd344d commit b611cb2

1 file changed

Lines changed: 53 additions & 48 deletions

File tree

tool/README.md

Lines changed: 53 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,18 @@ Last updated: 2025-06-20
1717

1818
- [Azure Storage Scalability Targets](https://learn.microsoft.com/en-us/azure/architecture/best-practices/data-partitioning#scalability-targets)
1919
- [Types of Data in Azure](https://learn.microsoft.com/en-us/azure/architecture/guide/technology-choices/data-store-overview)
20-
- [Performance best practices for Azure SQL Database and Azure SQL Managed Instance](https://learn.microsoft.com/en-us/azure/azure-sql/database/performance-guidance-overview)
2120
- [Global Distribution with Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/distribute-data-globally)
2221
- [Consistency Levels in Azure Cosmos DB](https://learn.microsoft.com/en-us/azure/cosmos-db/consistency-levels)
2322
- [Introduction to Azure Data Factory](https://learn.microsoft.com/en-us/azure/data-factory/introduction)
2423
- [Security overview for Azure SQL Database and Azure SQL Managed Instance](https://learn.microsoft.com/en-us/azure/azure-sql/database/security-overview)
2524
- [Azure Pricing Calculator](https://azure.microsoft.com/en-us/pricing/calculator/)
26-
- [OLTP and OLAP in Azure SQL Database](https://learn.microsoft.com/en-us/azure/azure-sql/database/oltp-olap-overview)
2725
- [Azure Backup and Disaster Recovery](https://learn.microsoft.com/en-us/azure/backup/backup-overview)
2826
- [Query Performance Insight](https://learn.microsoft.com/en-us/azure/azure-sql/database/query-performance-insight-use)
29-
- [Data retention and deletion in Microsoft Azure](https://learn.microsoft.com/en-us/azure/compliance/offerings/offering-data-retention)
3027

3128
</details>
3229

33-
## Overview
3430

35-
The **Azure Databases Advisor Tool** is designed to help users select the most suitable Azure database service based on their specific use case. It provides recommendations by analyzing user inputs such as data type, scalability needs, latency requirements, and more.
31+
> The [Azure Databases Advisor Tool](https://microsoftcloudessentials-learninghub.github.io/Azure-Databases-Purview/) is designed to help users select the most suitable Azure database service based on their specific use case. It provides recommendations by analyzing user inputs such as data type, scalability needs, latency requirements, and more.
3632
3733
This tool consists of:
3834
- **Static Frontend**: A web-based interface for users to input their requirements and view recommendations. The frontend operates independently and uses hardcoded logic for recommendations.
@@ -60,66 +56,75 @@ tool/
6056

6157
## Usage
6258

63-
### Frontend
64-
The static web app is deployed via Azure Static Web Apps or GitHub Pages. It provides an interactive form for users to input their requirements. By default, the frontend operates independently and uses hardcoded logic for recommendations.
59+
<details>
60+
<summary><strong>Frontend (Click here to expand)</strong></summary>
61+
62+
> The static web app is deployed via Azure Static Web Apps or GitHub Pages. It provides an interactive form for users to input their requirements. By default, the frontend operates independently and uses hardcoded logic for recommendations.
63+
64+
</details>
65+
66+
<details>
67+
<summary><strong>Backend (Click here to expand) - Optional </strong></summary>
68+
69+
> The backend (Flask API) processes user inputs and generates recommendations dynamically. To enable backend functionality:
6570
66-
### Backend (Optional)
67-
The backend (Flask API) processes user inputs and generates recommendations dynamically. To enable backend functionality:
6871
1. Deploy the Flask API (`app.py`) to Azure App Service or Azure Functions.
6972
2. Update the backend URL in `script.js` to point to the deployed API.
7073

71-
### Deployment Instructions
74+
</details>
75+
76+
<details>
77+
<summary><strong>Deployment Instructions (Click here to expand)</strong></summary>
7278

73-
#### Backend Deployment
79+
> **Backend Deployment**:
7480
1. Use Azure App Service or Azure Functions to deploy the Flask API (`app.py`).
7581
2. Ensure the API endpoint is accessible to the frontend.
7682
3. Use Azure Monitor for logging and diagnostics.
7783

78-
#### Frontend Deployment
84+
> **Frontend Deployment**:
7985
1. Deploy the static web app (`index.html`, `script.js`, `styles.css`) to Azure Static Web Apps.
8086
2. Update the backend URL in `script.js` to point to the deployed API (if using the backend).
8187

82-
#### Security
88+
</details>
89+
90+
<details>
91+
<summary><strong>Security (Click here to expand)</strong></summary>
92+
8393
- Secure API endpoints with Azure Active Directory (AAD) authentication.
8494
- Use HTTPS for all communications.
8595

96+
</details>
97+
8698
## Expanded Questionnaire
8799

88-
The tool now includes the following questions to refine recommendations:
89-
- **Data Volume**: Expected size and growth.
90-
- Options: `<10GB`, `10GB-1TB`, `>1TB`.
91-
- **Data Type**: Structured, semi-structured, or unstructured.
92-
- Options: `Structured`, `Semi-structured`, `Unstructured`.
93-
- **Latency Requirements**: Maximum acceptable delay for database operations.
94-
- Options: `<10ms`, `10-100ms`, `>100ms`.
95-
- **Scalability Needs**: Horizontal or vertical scaling, global distribution.
96-
- Options: `Global`, `Local`.
97-
- **Consistency Model**: Strong or eventual consistency.
98-
- Options: `Strong`, `Eventual`.
99-
- **Integration Needs**: Compatibility with Azure services.
100-
- Options: `Yes`, `No`.
101-
- **Security Requirements**: Encryption, role-based access control, compliance requirements.
102-
- Options: `Encryption`, `RBAC`, `Compliance`.
103-
- **Budget Constraints**: Monthly budget for database services.
104-
- Options: `<100 USD`, `100-500 USD`, `>500 USD`.
105-
- **Use Case Specifics**: OLTP, OLAP, or AI/ML workloads.
106-
- Options: `OLTP`, `OLAP`, `AI/ML`.
107-
- **Backup and Disaster Recovery**: Automated backups and disaster recovery options.
108-
- Options: `Yes`, `No`.
109-
- **Query Complexity**: Expected complexity of database queries.
110-
- Options: `Simple`, `Moderate`, `Complex`.
111-
- **Data Retention Policy**: Retention period for data.
112-
- Options: `Short-term`, `Medium-term`, `Long-term`.
113-
114-
## Advanced Settings
115-
116-
If the "Advanced Settings" button is not working, please refer to [Advanced Configuration for Azure Databases](https://learn.microsoft.com/en-us/azure/azure-sql/database/advanced-configuration) for more information.
117-
118-
## Example Recommendation Flow
119-
120-
1. User selects **structured data** with **global distribution** and **high throughput**.
121-
2. The tool recommends **Azure Cosmos DB (SQL API)**.
122-
3. Links to Azure documentation are provided for further exploration.
100+
> The tool now includes the following questions to refine recommendations:
101+
102+
<details>
103+
<summary><strong>View All Options (Click to expand)</strong></summary>
104+
<table>
105+
<thead>
106+
<tr>
107+
<th>Question</th>
108+
<th>Options</th>
109+
</tr>
110+
</thead>
111+
<tbody>
112+
<tr><td>Data Volume</td><td>&lt;10GB, 10GB-1TB, &gt;1TB</td></tr>
113+
<tr><td>Data Type</td><td>Structured, Semi-structured, Unstructured</td></tr>
114+
<tr><td>Latency Requirements</td><td>&lt;10ms, 10-100ms, &gt;100ms</td></tr>
115+
<tr><td>Scalability Needs</td><td>Global, Local</td></tr>
116+
<tr><td>Consistency Model</td><td>Strong, Eventual</td></tr>
117+
<tr><td>Integration Needs</td><td>Yes, No</td></tr>
118+
<tr><td>Security Requirements</td><td>Encryption, RBAC, Compliance</td></tr>
119+
<tr><td>Budget Constraints</td><td>&lt;100 USD, 100-500 USD, &gt;500 USD</td></tr>
120+
<tr><td>Use Case</td><td>OLTP, OLAP, AI/ML</td></tr>
121+
<tr><td>Backup & Recovery</td><td>Yes, No</td></tr>
122+
<tr><td>Query Complexity</td><td>Simple, Moderate, Complex</td></tr>
123+
<tr><td>Data Retention</td><td>Short-term, Medium-term, Long-term</td></tr>
124+
</tbody>
125+
</table>
126+
</details>
127+
123128

124129
<div align="center">
125130
<h3 style="color: #4CAF50;">Total Visitors</h3>

0 commit comments

Comments
 (0)