This documentation highlights key considerations for transitioning from an Information Assistant (IA) agent template to a production-ready deployment. Emphasizing scalability, high availability, security, and proactive management, the recommendations cover components such as App Server scaling, Load Balancing strategies, and global-scale content delivery. Additional guidance addresses GPT Model throttling, security enhancements, proactive monitoring, and redundancy. It stresses the importance of safeguarding against cyber threats, seamless integration with existing ecosystems, and proactive environment management through monitoring and alerts.
These recommendations offer options for load balancing and high availability, catering to the scalability needs and global distribution requirements of your IA application.
Consideration: As the load on the App Server increases, scaling becomes crucial to handle varying levels of traffic efficiently.
Recommendation: Learn more about Azure Monitor based app service scaling here. Alternatively, you can modify the existing Auto scaling rules. See this documentation on the explanation of the existing auto scaling rules. Configure autoscaling rules to automatically adjust the number of instances in response to changes in load. You can also adjust the sku to scale vertically and adjust the number of workers in the app server. Alternatively, you could consider deploying the App to a container orchestration platform like Azure Kubernetes Service (AKS) for management and scaling.
Consideration: Ensure App Gateway handles increased traffic and maintains high availability. Learn more about App Gateway here.
Recommendation: Explore horizontal scaling with multiple instances. Use Azure Traffic Manager for global distribution.
Consideration: Efficient workload distribution for optimal performance.
Recommendation: Utilize Azure Load Balancer for even traffic distribution. Adjust load balancing rules and implement health probes. Learn more about load balancing options in Azure here.
Consideration: Address global-scale distribution and content delivery concerns.
Recommendation: Implement Azure Front Door for global load balancing and improved content delivery. Configure regional routing and caching for optimized user experience. Learn more about Frontdoor here.
Consideration: Enhancing the security posture of your deployment is crucial, especially when dealing with sensitive data or services.
Recommendation: Private Endpoints are now offered as part of our secure mode. Learn more about it here
Consideration: Safeguarding your IA application from cyber threats is crucial for protecting sensitive data and maintaining user trust.
Recommendation: Many security policies have been followed in our secure mode. You can read more about this mode and its implementation here
Consideration: Security monitoring alerts you to potential threats and helps you respond effectively to potential incidents.
Recommendation: Consider deploying Microsoft Defender for Cloud to secure your workloads, understand your security posture and improve your overall security. Defender for Cloud combines the capabilities of a cloud security posture management (CSPM) solution and a cloud workload protection platform (CWPP). Defender for Cloud also uses role-based access control (RBAC) allowing you to assign roles to users, groups, and services so users only see information related to resources they have access to.
Learn more here.
Consideration: To enhance system reliability and ensure business continuity, consider implementing multiple instances of your Azure OpenAI (AOAI).
Recommendation: You could deploy AOAI instances across multiple Azure regions for geographic redundancy. Leverage Azure Traffic Manager for global distribution and failover capabilities, ensuring uninterrupted service even in the event of a regional failure. Learn more about potential strategies here.
Consideration: Throttling is essential to control the rate at which requests are sent to the GPT model, preventing overload and maintaining performance.
Recommendation: Microsoft offers Provisioned Throughput options, allowing you to specify the maximum request rate for your GPT model. Define appropriate throughput limits based on the model's capacity and resource availability. Adjust throttling settings as needed to ensure optimal performance without risking service degradation. Learn more here.
Consideration: Proactively monitoring the IA environment is crucial for identifying performance issues, bottlenecks, and potential security threats.
Recommendation: Leverage Azure Monitor to gain insights into the performance and health of your entire IA ecosystem. Set up custom alerts based on key performance indicators and metrics. Utilize Azure Log Analytics for in-depth analysis and troubleshooting. Integrate Azure Security Center to monitor and respond to security threats in real-time. Learn more here.
Diagnostic settings have been enabled in IA as part of our secure mode. You can read more about this mode and its implementation here
Consideration: This agent template uses Azure Document Intelligence for PDF's and Unstructured.io for document processing. These tools have their own limitations when it comes to document sizes they can handle. The page limit and document size limits for PDFs on Document Intelligence can vary by subscription tier. Learn more about Document Intelligence here.
More info on unstructured.io for other supported document types can be found here.
Recommendation: If you see issues with the chunking or processing of very large documents, we recommend splitting those into a sensible format of multiple documents for ingestion.
If you would like to give custom branding to the Front End Web App interface, there are a couple ways this might be accomplished.
Consideration: To give custom branding to the existing Front End Web App interface. This can be achieved by modifying the currently provided UI by making a couple of configuration changes.
Recommendation: In the local.env used to deploy the solution, there exists a parameter called "APPLICATION_TITLE" that can be given any string value to change the title that appears on the title bar of the existing UI. See this section for a list of configurable environment variables. You may also change the image files displayed by replacing them in the /app/frontend/src/assets folder. You may need to change the reference names in the code where it is referencing if you change the file name of the referenced image file. The sky is the limit when it comes to modifying the existing front end source code for your own use cases.
Consideration: When considering the replacement of the existing UI, it is important to assess the potential for enabling token OAuth implementation on the API. This could allow for the integration of a distinct custom UI to call the web app backend API.
Recommendation: To securely invoke the API with an alternative interface, it is recommended to implement the Client Credentials Flow. This approach facilitates OAuth token authentication for the API, requiring subsequent integration into your own UI or processes.
Ensure that your IA agent template seamlessly integrates into your existing ecosystem, considering compatibility and interoperability. Use the IA agent template as a blueprint to plan integration into your ecosystem.