Skip to content

refactor: standardize Bicep resource naming, simplify parameters, and upgrade OpenAI model #531

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

Merged
merged 3 commits into from
May 2, 2025

Conversation

Harmanpreet-Microsoft
Copy link
Contributor

Purpose

This pull request introduces significant updates to the infrastructure Bicep templates, focusing on improving resource naming conventions, standardizing parameter handling, and updating dependencies. The most notable changes include the addition of a centralized abbreviations file for consistent naming, the removal of hardcoded default parameter values, and the transition to a new version of the OpenAI model. Below is a categorized summary of the most important changes:

Naming Standardization and Abbreviations

  • Added infra/bicep/abbreviations.json to centralize resource abbreviations for consistent and scalable naming conventions across all Bicep templates.
  • Updated main.bicep to dynamically generate resource names using abbreviations, such as managedIdentity, storageAccount, and keyVault, by referencing the new abbreviations.json file. [1] [2] [3]

Parameter Simplification

  • Removed default values for parameters like searchServices_byc_cs_name, HostingPlanName, WebsiteName, and others across multiple deployment files to allow for more flexibility during deployment. [1] [2] [3] [4] [5]

OpenAI Model Update

  • Changed the OpenAI model in deploy_azure_open_ai.bicep and main.bicep from gpt-35-turbo-16k to gpt-35-turbo with updated version 0125 for improved performance and compatibility. [1] [2]

Dependency Updates

  • Updated the base URL in main.bicep to point to the byoc-researcher branch for the latest resources.
  • Upgraded the Bicep CLI version in main.json metadata from 0.29.47.4906 to 0.33.93.31351 for compatibility with new features.

Resource-Specific Enhancements

  • Incorporated dynamic naming for App Service Plan, Web App, and Application Insights in main.bicep using the new abbreviations file.
  • Adjusted the deployment of cognitive services in deploy_azure_ai_service.bicep and deploy_ai_search_service.bicep to use dynamically generated names. [1] [2]

These changes enhance maintainability, scalability, and flexibility of the infrastructure deployment process.

  • ...

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • ...

Other Information

@Roopan-Microsoft Roopan-Microsoft merged commit cf5156b into byoc-researcher May 2, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants