Merge pull request #568 from microsoft/dev

refactor: Cleanup local registry build code references

Author: Roopan-Microsoft

documents/DeploymentGuide.md

@@ -193,17 +193,9 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
 
 2. **Deleting Resources After a Failed Deployment**  
 
-     - Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources.
-  
-## Environment configuration for local development & debugging
-> Set APP_ENV in your .env file to control Azure authentication.Set the environment variable to dev to use Azure CLI credentials, or to prod to use Managed Identity for production. **Ensure you're logged in via az login when using dev in local**.
-To configure your environment:
-- Navigate to the `src\api` folder.
-- Create a `.env` file based on the `.env.sample` file.
-- Fill in the `.env` file using deployment output or the Azure Portal under "Deployments" in your resource group.
-- Ensure that `APP_ENV` is set to "**dev**".     
-
-## For Local Debugging
+     - Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources.     
+
+## For local development & debugging
 
 Follow steps in [Local Debugging Setup](./LocalDebuggingSetup.md) to configure your local development environment for debugging the solution.
 

documents/LocalDebuggingSetup.md

@@ -70,7 +70,7 @@ If you don't have an existing environment, you must first deploy the Azure resou
 |-------------|-------|------|
 | `SOLUTION_NAME` |  | Prefix used to uniquely identify resources in the deployment |
 | `RESOURCE_GROUP_NAME` |  | Name of the Azure Resource Group |
-| `APP_ENV` | `dev` | Environment type (dev for local debugging, prod for deployment) |
+| `APP_ENV` | `dev` | Set APP_ENV in your .env file to control Azure authentication. Set the environment variable to dev to use Azure CLI credentials, or to prod to use Managed Identity for production. Ensure you're logged in via az login when using dev in local. |
 | `APPINSIGHTS_INSTRUMENTATIONKEY` |  | Instrumentation Key for Azure Application Insights |
 | `APPLICATIONINSIGHTS_CONNECTION_STRING` |  | Connection string for Application Insights |
 | `AZURE_AI_PROJECT_CONN_STRING` |  | Connection string for the Azure AI project |

infra/deploy_app_service.bicep

@@ -12,7 +12,6 @@ param appSettings object = {}
 param appServicePlanId string
 param appImageName string
 param userassignedIdentityId string = ''
-param useLocalBuild string
 
 resource appService 'Microsoft.Web/sites@2020-06-01' = {
   name: solutionName
@@ -28,7 +27,6 @@ resource appService 'Microsoft.Web/sites@2020-06-01' = {
   properties: {
     serverFarmId: appServicePlanId
     siteConfig: {
-      acrUseManagedIdentityCreds: useLocalBuild == 'true'
       alwaysOn: true
       ftpsState: 'Disabled'
       linuxFxVersion: appImageName

infra/deploy_backend_docker.bicep

@@ -11,10 +11,8 @@ param appServicePlanId string
 param userassignedIdentityId string
 param keyVaultName string
 param aiServicesName string
-param useLocalBuild string
 param azureExistingAIProjectResourceId string = ''
 param aiSearchName string
-param aideploymentsLocation string
 var existingAIServiceSubscription = !empty(azureExistingAIProjectResourceId) ? split(azureExistingAIProjectResourceId, '/')[2] : subscription().subscriptionId
 var existingAIServiceResourceGroup = !empty(azureExistingAIProjectResourceId) ? split(azureExistingAIProjectResourceId, '/')[4] : resourceGroup().name
 var existingAIServicesName = !empty(azureExistingAIProjectResourceId) ? split(azureExistingAIProjectResourceId, '/')[8] : ''
@@ -94,7 +92,6 @@ module appService 'deploy_app_service.bicep' = {
     appServicePlanId: appServicePlanId
     appImageName: imageName
     userassignedIdentityId:userassignedIdentityId
-    useLocalBuild: useLocalBuild
     appSettings: union(
       appSettings,
       {
@@ -191,24 +188,6 @@ module assignAiUserRoleToAiProject 'deploy_foundry_role_assignment.bicep' = {
   }
 }
 
-resource containerRegistry 'Microsoft.ContainerRegistry/registries@2021-09-01' existing = if (useLocalBuild == 'true') {
-  name: acrName
-}
-
-resource AcrPull 'Microsoft.Authorization/roleDefinitions@2022-04-01' existing = if (useLocalBuild == 'true') {
-  name: '7f951dda-4ed3-4680-a7ca-43fe172d538d'
-}
-
-resource acrPullRoleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = if (useLocalBuild == 'true') {
-  name: guid(appService.name, AcrPull.id)
-  scope: containerRegistry
-  properties: {
-    roleDefinitionId: AcrPull.id
-    principalId: appService.outputs.identityPrincipalId
-    principalType: 'ServicePrincipal'
-  }
-}
-
 output appUrl string = appService.outputs.appUrl
 output reactAppLayoutConfig string = reactAppLayoutConfig
 output appInsightInstrumentationKey string = reference(applicationInsightsId, '2015-05-01').InstrumentationKey

infra/deploy_frontend_docker.bicep

@@ -8,7 +8,6 @@ param solutionLocation string
 @secure()
 param appSettings object = {}
 param appServicePlanId string
-param useLocalBuild string
 
 var imageName = 'DOCKER|${acrName}.azurecr.io/km-app:${imageTag}'
 //var name = '${solutionName}-app'
@@ -20,7 +19,6 @@ module appService 'deploy_app_service.bicep' = {
     solutionName: name
     appServicePlanId: appServicePlanId
     appImageName: imageName
-    useLocalBuild: useLocalBuild
     appSettings: union(
       appSettings,
       {
@@ -30,22 +28,4 @@ module appService 'deploy_app_service.bicep' = {
   }
 }
 
-resource containerRegistry 'Microsoft.ContainerRegistry/registries@2021-09-01' existing = if (useLocalBuild == 'true') {
-  name: acrName
-}
-
-resource AcrPull 'Microsoft.Authorization/roleDefinitions@2022-04-01' existing = if (useLocalBuild == 'true') {
-  name: '7f951dda-4ed3-4680-a7ca-43fe172d538d'
-}
-
-resource acrPullRoleAssignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = if (useLocalBuild == 'true') {
-  name: guid(appService.name, AcrPull.id)
-  scope: containerRegistry
-  properties: {
-    roleDefinitionId: AcrPull.id
-    principalId: appService.outputs.identityPrincipalId
-    principalType: 'ServicePrincipal'
-  }
-}
-
 output appUrl string = appService.outputs.appUrl

infra/main.bicep

@@ -66,12 +66,6 @@ param imageTag string = 'latest_fdp'
 param AZURE_LOCATION string=''
 var solutionLocation = empty(AZURE_LOCATION) ? resourceGroup().location : AZURE_LOCATION
 
-@description('Set this flag to true only if you are deploying from Local')
-param useLocalBuild string = 'false'
-
-// Convert input to lowercase
-var useLocalBuildLower = toLower(useLocalBuild)
-
 var uniqueId = toLower(uniqueString(subscription().id, environmentName, solutionLocation, resourceGroup().name))
 
 
@@ -89,9 +83,7 @@ param aiDeploymentsLocation string
 
 var solutionPrefix = 'km${padLeft(take(uniqueId, 12), 12, '0')}'
 
-var containerRegistryName = '${abbrs.containers.containerRegistry}${solutionPrefix}'
-var containerRegistryNameCleaned = replace(containerRegistryName, '-', '')
-var acrName = useLocalBuildLower == 'true' ? containerRegistryNameCleaned : 'kmcontainerreg'
+var acrName = 'kmcontainerreg'
 
 var baseUrl = 'https://raw.githubusercontent.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator/main/'
 
@@ -233,15 +225,13 @@ module backend_docker 'deploy_backend_docker.bicep' = {
   params: {
     name: 'api-${solutionPrefix}'
     solutionLocation: solutionLocation
-    aideploymentsLocation: aiDeploymentsLocation
     imageTag: imageTag
     acrName: acrName
     appServicePlanId: hostingplan.outputs.name
     applicationInsightsId: aifoundry.outputs.applicationInsightsId
     userassignedIdentityId: managedIdentityModule.outputs.managedIdentityBackendAppOutput.id
     keyVaultName: kvault.outputs.keyvaultName
     aiServicesName: aifoundry.outputs.aiServicesName
-    useLocalBuild: useLocalBuildLower
     azureExistingAIProjectResourceId: azureExistingAIProjectResourceId
     aiSearchName: aifoundry.outputs.aiSearchName 
     appSettings: {
@@ -284,7 +274,6 @@ module frontend_docker 'deploy_frontend_docker.bicep' = {
     acrName: acrName
     appServicePlanId: hostingplan.outputs.name
     applicationInsightsId: aifoundry.outputs.applicationInsightsId
-    useLocalBuild: useLocalBuildLower
     appSettings:{
       APP_API_BASE_URL:backend_docker.outputs.appUrl
     }