Skip to content

Commit 6f3ba79

Browse files
sethsteenkensethsteenken
andauthored
Doc updates (#23)
* Docs - arch image updates * Docs - agentic arch image non-transparent * Readme - bullet cleanup, data collection, and trademarks * Docs - moved test files to data folder in root * Docs - telemetry * Docs - samples data folder --------- Co-authored-by: sethsteenken <sethsteenken@microsoft.com>
1 parent 1b495b9 commit 6f3ba79

13 files changed

+39
-15
lines changed

README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,27 +28,29 @@ The solution uses a sophisticated multi-agent orchestration pattern where specia
2828

2929
This solution enables enterprise-grade Kubernetes migration with the following capabilities:
3030

31-
**Enterprise Batch Processing Architecture**
32-
Complete solution including React web application for file upload, validation, and queue management coupled with intelligent multi-agent processing engine
31+
- **Enterprise Batch Processing Architecture** <br/>
32+
Complete solution including React web application for file upload, validation, and queue management coupled with intelligent multi-agent processing engine
3333

34-
**Intelligent Platform Detection**
35-
Automatically identifies source Kubernetes platform (GKE/EKS) through configuration analysis and applies platform-specific migration strategies
34+
- **Intelligent Platform Detection** <br/>
35+
Automatically identifies source Kubernetes platform (GKE/EKS) through configuration analysis and applies platform-specific migration strategies
3636

37-
**Multi-Agent Expert Orchestration**
38-
Specialized agents (Technical Architect, Azure Expert, Platform Experts, QA Engineer) collaborate through Semantic Kernel GroupChat orchestration patterns
37+
- **Multi-Agent Expert Orchestration** <br/>
38+
Specialized agents (Technical Architect, Azure Expert, Platform Experts, QA Engineer) collaborate through Semantic Kernel GroupChat orchestration patterns
3939

40-
**Process Framework Integration**
41-
Each migration step (analysis, design, conversion, documentation) is built using Semantic Kernel Process Framework with event routing and step orchestration
40+
- **Process Framework Integration** <br/>
41+
Each migration step (analysis, design, conversion, documentation) is built using Semantic Kernel Process Framework with event routing and step orchestration
4242

43-
**MCP Server Tool Integration**
44-
Agents access intelligent tools through Model Context Protocol servers for file operations, knowledge search, and specialized functions without direct model training
43+
- **MCP Server Tool Integration** <br/>
44+
Agents access intelligent tools through Model Context Protocol servers for file operations, knowledge search, and specialized functions without direct model training
4545

46-
**Azure Well-Architected Framework Compliance**
47-
Configurations transformed according to Azure security, reliability, performance, cost optimization, and operational excellence principles
46+
- **Azure Well-Architected Framework Compliance** <br/>
47+
Configurations transformed according to Azure security, reliability, performance, cost optimization, and operational excellence principles
48+
49+
- **Comprehensive Migration Reporting** <br/>
50+
Detailed reports capturing expert analysis, transformation decisions, and recommendations from multiple specialized agents
4851

49-
**Comprehensive Migration Reporting**
50-
Detailed reports capturing expert analysis, transformation decisions, and recommendations from multiple specialized agents
5152
### Agentic Architecture
53+
5254
## <img src="docs/images/readme/agentic_architecture.png">
5355
If you want to get know more detail about Agentic Architecture, please take a look at this document: [Agentic Architecture](docs/AgenticArchitecture.md)
5456

@@ -231,6 +233,23 @@ Have questions, find a bug, or want to request a feature? [Submit a new issue](h
231233
## Responsible AI Transparency FAQ
232234
Please refer to [Transparency FAQ](./TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
233235

236+
## Data Collection
237+
238+
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of [Microsoft’s privacy statement](https://go.microsoft.com/fwlink/?LinkID=824704). You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
239+
240+
### Telemetry Configuration
241+
242+
This repository uses telemetry to track and monitor usage. There are two means of telemetry being used for this purpose: [Azure Developer CLI (AZD)](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/overview?tabs=windows) and using [Azure Verified Modules (AVM)](https://azure.github.io/Azure-Verified-Modules/) for provisioning resources. Telemetry collection in this solution is enabled by default.
243+
244+
To opt out, perform the following steps:
245+
246+
1. Set the environment variable `AZURE_DEV_COLLECT_TELEMETRY` to `no` in your environment prior to deploying.
247+
2. Set the `enableTelemetry` parameter value in `main.parameters.json` to `false` prior to deploying.
248+
249+
## Trademarks
250+
251+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.
252+
234253
## Disclaimers
235254

236255
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.

src/backend-api/src/tests/test_files/EKS/ebs-kc-classes.yaml renamed to data/eks/ebs-kc-classes.yaml

File renamed without changes.

src/backend-api/src/tests/test_files/EKS/ebs-kc-restore.yaml renamed to data/eks/ebs-kc-restore.yaml

File renamed without changes.

src/backend-api/src/tests/test_files/EKS/ebs-kc-snapshot.yaml renamed to data/eks/ebs-kc-snapshot.yaml

File renamed without changes.

src/backend-api/src/tests/test_files/EKS/ebs-kc.yaml renamed to data/eks/ebs-kc.yaml

File renamed without changes.

src/backend-api/src/tests/test_files/GKE/axolotl-training-job.yaml renamed to data/gke/axolotl-training-job.yaml

File renamed without changes.

src/backend-api/src/tests/test_files/GKE/model-export.yaml renamed to data/gke/model-export.yaml

File renamed without changes.

src/backend-api/src/tests/test_files/GKE/model-storage-pvc.yaml renamed to data/gke/model-storage-pvc.yaml

File renamed without changes.

src/backend-api/src/tests/test_files/GKE/tensorboard.yaml renamed to data/gke/tensorboard.yaml

File renamed without changes.

docs/DeploymentGuide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,9 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
170170

171171
> #### Important Note : Before accessing the application, ensure that all **[Post Deployment Steps](#post-deployment-steps)** are fully completed, as they are critical for the proper configuration of **Data Ingestion** and **Authentication** functionalities.
172172
173-
6. After exploring the application, you can delete the resources by running `azd down` command.
173+
6. Use the application by uploading other GKE or EKS container workload configuration YAML files. [Sample input files can be found in the data folder](/data/).
174+
175+
7. After exploring the application, you can delete the resources by running `azd down` command.
174176

175177
### Post Deployment Steps
176178

0 commit comments

Comments
 (0)