Skip to content

refactor: standardize resource naming and improve Bicep templates with dynamic abbreviations #101

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 10 commits into from
May 22, 2025

Conversation

Harmanpreet-Microsoft
Copy link
Contributor

Purpose

This pull request introduces significant updates to improve resource naming consistency, streamline infrastructure code, and enhance maintainability. The changes include adding a comprehensive .dockerignore file, restructuring the abbreviations.json file for better organization, and updating multiple Bicep templates to use abbreviations for resource names.

Infrastructure and Configuration Updates:

  • .dockerignore file: Added a detailed .dockerignore file to exclude unnecessary files and directories from Docker builds, such as temporary files, local build artifacts, and IDE-related files. This improves build efficiency and security.

  • infra/abbreviations.json file: Restructured and expanded the abbreviations file to organize resource abbreviations into categories like ai, analytics, compute, and more. This enhances readability and scalability for managing resource naming conventions.

Bicep Template Enhancements:

  • Dynamic resource naming: Updated multiple Bicep templates (deploy_ai_foundry.bicep, deploy_keyvault.bicep, deploy_managed_identity.bicep, and main.bicep) to use abbreviations from abbreviations.json for resource names. This ensures consistent and concise naming across resources. Examples include:

    • AI services name updated to ${abbrs.ai.aiServices}${solutionName}.
    • Key Vault name updated to ${abbrs.security.keyVault}${prefixCleaned}.
    • Cosmos DB database account name updated to ${abbrs.databases.cosmosDBDatabase}${prefixCleaned}databaseAccount.
  • Parameter simplification: Removed hardcoded default values for parameters like keyvaultName and miName in deploy_keyvault.bicep and deploy_managed_identity.bicep, allowing greater flexibility during deployments. [1] [2]

  • Resource property updates: Commented out the statisticsEnabled property in the AI services resource definition, likely for future review or adjustments.

  • ...

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

Harmanpreet Kaur and others added 4 commits May 8, 2025 12:15
refactor: centralize Azure resource naming with abbreviations.json and update Bicep templates
build: Add .dockerignore to optimize Docker build context
@Roopan-Microsoft Roopan-Microsoft merged commit 62438b7 into main May 22, 2025
9 checks passed
Copy link

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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.

5 participants