Merge pull request #83 from Azure-Samples/howie/fix-deploy-to-azure

Howie/fix deploy to azure

Author: howieleung

README.md

@@ -25,7 +25,7 @@ The app code runs in Azure Container apps to process the user input and generate
 
 ### Quick Deploy
 
-| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Azure-Samples/get-started-with-ai-agents) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Azure-Samples/get-started-with-ai-agents) | 
+| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Azure-Samples/get-started-with-ai-agents) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Azure-Samples/get-started-with-ai-agents) |
 |---|---|
 
 Github Codespaces and Dev Containers both allow you to download and deploy the code for development. You can also continue with local development. Once you have selected your environment, follow the instructions below to customize and deploy your solution.    
@@ -50,6 +50,7 @@ Make sure the following tools are installed:
 2. [Python 3.9+](https://www.python.org/downloads/)
 3. [Git](https://git-scm.com/downloads)
 4. [Docker Desktop](https://www.docker.com/products/docker-desktop/)
+5. \[Windows Only\] [PowerShell](https://learn.microsoft.com/powershell/scripting/install/installing-powershell-on-windows) of the latest version, needed only for local application development on Windows operation system. Please make sure that power shell executable `pwsh.exe` is added to the `PATH` variable.
 
 ## Configure your Environment
 
@@ -246,7 +247,7 @@ Once you've opened the project in [Codespaces](#github-codespaces) or in [Dev Co
     ```
     ⚠️ If you do not increase your quota, you may encounter rate limit issues. If needed, you can increase the quota after deployment by editing your model in the Models and Endpoints tab of the [Azure AI Foundry Portal](https://ai.azure.com/).
 
-3. Provision and deploy all the resources by running the following in get-started-with-ai-agents directory:
+3. Provision and deploy all the resources with public docker image `azdtemplate.azurecr.io/get-start-with-ai-agents:latest` by running the following in get-started-with-ai-agents directory:
 
     ```shell
     azd up
@@ -273,20 +274,10 @@ Once you've opened the project in [Codespaces](#github-codespaces) or in [Dev Co
     * In the [Azure Portal](https://portal.azure.com/), navigate to your environment's resource group. The name will be `rg-[your environment name]`. Here, you should see your container app, storage account, and all of the other [resources](#resources) that are created in the deployment.
     * In the [Azure AI Foundry Portal](https://ai.azure.com/), select your project. If you navigate to the Assistants tab, you should be able to view your new assistant, named `agent-template-assistant`. If you navigate to the Models and Endpoints tab, you should see your AI Services connection with your model deployments. 
 
-7. (Optional) If you make further modification to the app code, you can deploy the updated version with:
+7. (Optional) You can use a local development server to test app changes locally. To do so, follow the steps in [local deployment server](#local-development-server) after your app is deployed.
 
-    ```shell
-    azd deploy
-    ```
-    You can get more detailed output with the ```--debug``` parameter.
-    ```shell
-    azd deploy --debug
-    ```
-    >**Important:**
-    >
-    >Check carefully for any errors during deployment and the startup phase of the Azure Container App. If the container fails to start correctly after deployment, the application changes you made will not take effect, and Azure Container Apps will continue serving requests from the previous stable revision.
+8. (Optional) Follow this [tutorial](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-tutorial-quick-task) to build your changes into a Docker image and deploy to Azure Container App.
 
-8. (Optional) You can use a local development server to test app changes locally. To do so, follow the steps in [local deployment server](#local-development-server) after your app is deployed.
 
 ## Resource Clean-up
 

azure.yaml

@@ -6,15 +6,6 @@ name: azd-get-started-with-ai-agents
 metadata:
   template: [email protected]
 
-services:
-  api_and_frontend:
-    project: ./src
-    language: py
-    host: containerapp
-    docker:
-      image: api-and-frontend
-      remoteBuild: true
-
 hooks:
   postprovision:
     windows:

infra/api.bicep

@@ -4,9 +4,6 @@ param tags object = {}
 
 param identityName string
 param containerAppsEnvironmentName string
-param containerRegistryName string
-param serviceName string = 'api'
-param exists bool
 param projectConnectionString string
 param agentDeploymentName string
 param searchConnectionName string
@@ -16,6 +13,7 @@ param embeddingDeploymentDimensions string
 param searchServiceEndpoint string
 param agentName string
 param agentID string
+param projectName string
 
 resource apiIdentity 'Microsoft.ManagedIdentity/userAssignedIdentities@2023-01-31' = {
   name: identityName
@@ -69,24 +67,21 @@ var env = [
   }
 ]
 
-var module_name = replace(serviceName, ' ', '-')
 
 module app 'core/host/container-app-upsert.bicep' = {
-  name: '${module_name}-container-app-module'
+  name: 'container-app-module'
   params: {
     name: name
     location: location
-    tags: union(tags, { 'azd-service-name': serviceName })
+    tags: tags
     identityName: apiIdentity.name
-    exists: exists
     containerAppsEnvironmentName: containerAppsEnvironmentName
-    containerRegistryName: containerRegistryName
     targetPort: 50505
     env: env
+    projectName: projectName
   }
 }
 
 output SERVICE_API_IDENTITY_PRINCIPAL_ID string = apiIdentity.properties.principalId
 output SERVICE_API_NAME string = app.outputs.name
 output SERVICE_API_URI string = app.outputs.uri
-output SERVICE_API_IMAGE_NAME string = app.outputs.imageName

infra/core/ai/hub-dependencies.bicep

@@ -13,8 +13,6 @@ param aiServiceModelDeployments array = []
 param logAnalyticsName string = ''
 @description('Name of the Application Insights instance')
 param applicationInsightsName string = ''
-@description('Name of the container registry')
-param containerRegistryName string = ''
 @description('Name of the Azure Cognitive Search service')
 param searchServiceName string = ''
 
@@ -114,15 +112,6 @@ module applicationInsights '../monitor/applicationinsights.bicep' =
     }
   }
 
-module containerRegistry '../host/container-registry.bicep' =
-  if (!empty(containerRegistryName)) {
-    name: 'containerRegistry'
-    params: {
-      location: location
-      tags: tags
-      name: containerRegistryName
-    }
-  }
 
 module cognitiveServices '../ai/cognitiveservices.bicep' = {
   name: 'cognitiveServices'
@@ -154,10 +143,6 @@ output keyVaultEndpoint string = keyVault.outputs.endpoint
 output storageAccountId string = storageAccount.outputs.id
 output storageAccountName string = storageAccount.outputs.name
 
-output containerRegistryId string = !empty(containerRegistryName) ? containerRegistry.outputs.id : ''
-output containerRegistryName string = !empty(containerRegistryName) ? containerRegistry.outputs.name : ''
-output containerRegistryEndpoint string = !empty(containerRegistryName) ? containerRegistry.outputs.loginServer : ''
-
 output applicationInsightsId string = !empty(applicationInsightsName) ? applicationInsights.outputs.id : ''
 output applicationInsightsName string = !empty(applicationInsightsName) ? applicationInsights.outputs.name : ''
 output logAnalyticsWorkspaceId string = !empty(logAnalyticsName) ? logAnalytics.outputs.id : ''

infra/core/ai/hub.bicep

@@ -8,8 +8,6 @@ param storageAccountId string
 param keyVaultId string
 @description('The application insights ID to use for the AI Foundry Hub Resource')
 param applicationInsightsId string = ''
-@description('The container registry ID to use for the AI Foundry Hub Resource')
-param containerRegistryId string = ''
 @description('The AI Services account name to use for the AI Foundry Hub Resource')
 param aiServicesName string
 @description('The AI Services connection name to use for the AI Foundry Hub Resource')
@@ -49,7 +47,6 @@ resource hub 'Microsoft.MachineLearningServices/workspaces@2024-07-01-preview' =
     storageAccount: storageAccountId
     keyVault: keyVaultId
     applicationInsights: !empty(applicationInsightsId) ? applicationInsightsId : null
-    containerRegistry: !empty(containerRegistryId) ? containerRegistryId : null
     hbiWorkspace: false
     managedNetwork: {
       isolationMode: 'Disabled'

infra/core/host/ai-environment.bicep

@@ -35,7 +35,6 @@ module hubDependencies '../ai/hub-dependencies.bicep' = {
     tags: tags
     keyVaultName: keyVaultName
     storageAccountName: storageAccountName
-    containerRegistryName: containerRegistryName
     applicationInsightsName: applicationInsightsName
     logAnalyticsName: logAnalyticsName
     aiServicesName: aiServicesName
@@ -53,7 +52,6 @@ module hub '../ai/hub.bicep' = {
     displayName: hubName
     keyVaultId: hubDependencies.outputs.keyVaultId
     storageAccountId: hubDependencies.outputs.storageAccountId
-    containerRegistryId: hubDependencies.outputs.containerRegistryId
     applicationInsightsId: hubDependencies.outputs.applicationInsightsId
     aiServicesName: hubDependencies.outputs.aiServicesName
     aiServicesConnectionName: aiServicesConnectionName
@@ -94,10 +92,6 @@ output keyVaultEndpoint string = hubDependencies.outputs.keyVaultEndpoint
 output applicationInsightsName string = hubDependencies.outputs.applicationInsightsName
 output logAnalyticsWorkspaceName string = hubDependencies.outputs.logAnalyticsWorkspaceName
 
-// Container Registry
-output containerRegistryName string = hubDependencies.outputs.containerRegistryName
-output containerRegistryEndpoint string = hubDependencies.outputs.containerRegistryEndpoint
-
 // Storage Account
 output storageAccountName string = hubDependencies.outputs.storageAccountName
 

infra/core/host/container-app-upsert.bicep

@@ -23,12 +23,6 @@ param containerMinReplicas int = 1
 @description('The name of the container')
 param containerName string = 'main'
 
-@description('The name of the container registry')
-param containerRegistryName string = ''
-
-@description('Hostname suffix for container registry. Set when deploying to sovereign clouds')
-param containerRegistryHostSuffix string = 'azurecr.io'
-
 @allowed([ 'http', 'grpc' ])
 @description('The protocol used by Dapr to connect to the app, e.g., HTTP or gRPC')
 param daprAppProtocol string = 'http'
@@ -39,9 +33,6 @@ param daprEnabled bool = false
 @description('The Dapr app ID')
 param daprAppId string = containerName
 
-@description('Specifies if the resource already exists')
-param exists bool = false
-
 @description('Specifies if Ingress is enabled for the container app')
 param ingressEnabled bool = true
 
@@ -52,9 +43,6 @@ param identityType string = 'None'
 @description('The name of the user-assigned identity')
 param identityName string = ''
 
-@description('The name of the container image')
-param imageName string = ''
-
 @description('The secrets required for the container')
 @secure()
 param secrets object = {}
@@ -71,9 +59,8 @@ param serviceBinds array = []
 @description('The target port for the container')
 param targetPort int = 80
 
-resource existingApp 'Microsoft.App/containerApps@2023-05-02-preview' existing = if (exists) {
-  name: name
-}
+param projectName string
+
 
 module app 'container-app.bicep' = {
   name: '${deployment().name}-update'
@@ -86,8 +73,6 @@ module app 'container-app.bicep' = {
     ingressEnabled: ingressEnabled
     containerName: containerName
     containerAppsEnvironmentName: containerAppsEnvironmentName
-    containerRegistryName: containerRegistryName
-    containerRegistryHostSuffix: containerRegistryHostSuffix
     containerCpuCoreCount: containerCpuCoreCount
     containerMemory: containerMemory
     containerMinReplicas: containerMinReplicas
@@ -98,13 +83,12 @@ module app 'container-app.bicep' = {
     secrets: secrets
     external: external
     env: env
-    imageName: !empty(imageName) ? imageName : exists ? existingApp.properties.template.containers[0].image : ''
     targetPort: targetPort
     serviceBinds: serviceBinds
+    dependOn: projectName
   }
 }
 
 output defaultDomain string = app.outputs.defaultDomain
-output imageName string = app.outputs.imageName
 output name string = app.outputs.name
 output uri string = app.outputs.uri

infra/core/host/container-app.bicep

@@ -25,12 +25,6 @@ param containerMinReplicas int = 1
 @description('The name of the container')
 param containerName string = 'main'
 
-@description('The name of the container registry')
-param containerRegistryName string = ''
-
-@description('Hostname suffix for container registry. Set when deploying to sovereign clouds')
-param containerRegistryHostSuffix string = 'azurecr.io'
-
 @description('The protocol used by Dapr to connect to the app, e.g., http or grpc')
 @allowed([ 'http', 'grpc' ])
 param daprAppProtocol string = 'http'
@@ -54,14 +48,14 @@ param identityName string = ''
 @allowed([ 'None', 'SystemAssigned', 'UserAssigned' ])
 param identityType string = 'None'
 
-@description('The name of the container image')
-param imageName string = ''
 
 @description('Specifies if Ingress is enabled for the container app')
 param ingressEnabled bool = true
 
 param revisionMode string = 'Single'
 
+param dependOn string = ''
+
 @description('The secrets required for the container')
 @secure()
 param secrets object = {}
@@ -79,20 +73,9 @@ resource userIdentity 'Microsoft.ManagedIdentity/userAssignedIdentities@2023-01-
   name: identityName
 }
 
-// Private registry support requires both an ACR name and a User Assigned managed identity
-var usePrivateRegistry = !empty(identityName) && !empty(containerRegistryName)
-
 // Automatically set to `UserAssigned` when an `identityName` has been set
 var normalizedIdentityType = !empty(identityName) ? 'UserAssigned' : identityType
 
-module containerRegistryAccess '../security/registry-access.bicep' = if (usePrivateRegistry) {
-  name: '${deployment().name}-registry-access'
-  params: {
-    containerRegistryName: containerRegistryName
-    principalId: usePrivateRegistry ? userIdentity.properties.principalId : ''
-  }
-}
-
 resource app 'Microsoft.App/containerApps@2023-05-02-preview' = {
   name: name
   location: location
@@ -101,7 +84,7 @@ resource app 'Microsoft.App/containerApps@2023-05-02-preview' = {
   // otherwise the container app will throw a provision error
   // This also forces us to use an user assigned managed identity since there would no way to 
   // provide the system assigned identity with the ACR pull access before the app is created
-  dependsOn: usePrivateRegistry ? [ containerRegistryAccess ] : []
+  dependsOn: empty(dependOn)? [] : [dependOn]
   identity: {
     type: normalizedIdentityType
     userAssignedIdentities: !empty(identityName) && normalizedIdentityType == 'UserAssigned' ? { '${userIdentity.id}': {} } : null
@@ -129,18 +112,13 @@ resource app 'Microsoft.App/containerApps@2023-05-02-preview' = {
         value: secret.value
       }]
       service: !empty(serviceType) ? { type: serviceType } : null
-      registries: usePrivateRegistry ? [
-        {
-          server: '${containerRegistryName}.${containerRegistryHostSuffix}'
-          identity: userIdentity.id
-        }
-      ] : []
+      registries: []
     }
     template: {
       serviceBinds: !empty(serviceBinds) ? serviceBinds : null
       containers: [
         {
-          image: !empty(imageName) ? imageName : 'mcr.microsoft.com/azuredocs/containerapps-helloworld:latest'
+          image: 'azdtemplate.azurecr.io/get-start-with-ai-agents:latest'
           name: containerName
           env: env
           resources: {
@@ -163,7 +141,6 @@ resource containerAppsEnvironment 'Microsoft.App/managedEnvironments@2023-05-01'
 
 output defaultDomain string = containerAppsEnvironment.properties.defaultDomain
 output identityPrincipalId string = normalizedIdentityType == 'None' ? '' : (empty(identityName) ? app.identity.principalId : userIdentity.properties.principalId)
-output imageName string = imageName
 output name string = app.name
 output serviceBind object = !empty(serviceType) ? { serviceId: app.id, name: name } : {}
 output uri string = ingressEnabled ? 'https://${app.properties.configuration.ingress.fqdn}' : ''

infra/core/host/container-apps.bicep

@@ -1,12 +1,9 @@
-metadata description = 'Creates an Azure Container Registry and an Azure Container Apps environment.'
+metadata description = 'Creates an Azure Container Apps environment.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}
 
 param containerAppsEnvironmentName string
-param containerRegistryName string
-param containerRegistryResourceGroupName string = ''
-param containerRegistryAdminUserEnabled bool = false
 param logAnalyticsWorkspaceName string
 param applicationInsightsName string = ''
 
@@ -21,20 +18,7 @@ module containerAppsEnvironment 'container-apps-environment.bicep' = {
   }
 }
 
-module containerRegistry 'container-registry.bicep' = {
-  name: '${name}-container-registry'
-  scope: !empty(containerRegistryResourceGroupName) ? resourceGroup(containerRegistryResourceGroupName) : resourceGroup()
-  params: {
-    name: containerRegistryName
-    location: location
-    adminUserEnabled: containerRegistryAdminUserEnabled
-    tags: tags
-  }
-}
-
 output defaultDomain string = containerAppsEnvironment.outputs.defaultDomain
 output environmentName string = containerAppsEnvironment.outputs.name
 output environmentId string = containerAppsEnvironment.outputs.id
 
-output registryLoginServer string = containerRegistry.outputs.loginServer
-output registryName string = containerRegistry.outputs.name