Merge pull request #34 from microsoft/azd/add-template-gallery

mswantek68 · web-flow · commit 4b177c252cbb · 2025-03-20T11:07:51.000-04:00
Azd/add template gallery
diff --git a/.github/workflows/azd-template-validation.yml b/.github/workflows/azd-template-validation.yml
@@ -0,0 +1,34 @@
+name: AZD Template Validation
+on: 
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  id-token: write
+  pull-requests: write
+
+jobs:
+  template_validation:
+    runs-on: ubuntu-latest
+    name: azd template validation
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: microsoft/template-validation-action@Latest
+        with:
+          validateAzd: ${{ vars.TEMPLATE_VALIDATE_AZD }}
+          useDevContainer: ${{ vars.TEMPLATE_USE_DEV_CONTAINER }}
+        id: validation
+        env:
+          AZURE_CLIENT_ID: ${{ vars.AZURE_CLIENT_ID }}
+          AZURE_TENANT_ID: ${{ vars.AZURE_TENANT_ID }}
+          AZURE_SUBSCRIPTION_ID: ${{ vars.AZURE_SUBSCRIPTION_ID }}
+          AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
+          AZURE_LOCATION: ${{ vars.AZURE_LOCATION }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: print result
+        run: cat ${{ steps.validation.outputs.resultFile }}
diff --git a/.github/workflows/azure-dev.yml b/.github/workflows/azure-dev.yml
@@ -0,0 +1,39 @@
+name: AZD Deployment
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      AZURE_CLIENT_ID: ${{ vars.AZURE_CLIENT_ID }}
+      AZURE_TENANT_ID: ${{ vars.AZURE_TENANT_ID }}
+      AZURE_SUBSCRIPTION_ID: ${{ vars.AZURE_SUBSCRIPTION_ID }}
+      AZURE_RESOURCE_GROUP: ${{ vars.AZURE_RESOURCE_GROUP }}
+      AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
+      AZURE_LOCATION: ${{ vars.AZURE_LOCATION }}
+      AZURE_USER_OBJECT_ID: ''
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install azd
+        uses: Azure/setup-azd@v2
+      - name: Log in with Azure (Federated Credentials)
+        run: |
+          azd auth login `
+            --client-id "$Env:AZURE_CLIENT_ID" `
+            --federated-credential-provider "github" `
+            --tenant-id "$Env:AZURE_TENANT_ID" 
+        shell: pwsh
+
+      - name: Provision Infrastructure
+        run: azd provision --no-prompt
+        env:
+           AZD_INITIAL_ENVIRONMENT_CONFIG: ${{ secrets.AZD_INITIAL_ENVIRONMENT_CONFIG }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,76 @@
+# Contributing to Deploy your AI Application in Production
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+ - [Code of Conduct](#coc)
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+ - [Submission Guidelines](#submit)
+
+## <a name="coc"></a> Code of Conduct
+Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+## <a name="issue"></a> Found an Issue?
+If you find a bug in the source code or a mistake in the documentation, you can help us by
+[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can
+[submit a Pull Request](#submit-pr) with a fix.
+
+## <a name="feature"></a> Want a Feature?
+You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub
+Repository. If you would like to *implement* a new feature, please submit an issue with
+a proposal for your work first, to be sure that we can use it.
+
+* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
+
+## <a name="submit"></a> Submission Guidelines
+
+### <a name="submit-issue"></a> Submitting an Issue
+Before you submit an issue, search the archive, maybe your question was already answered.
+
+If your issue appears to be a bug, and hasn't been reported, open a new issue.
+Help us to maximize the effort we can spend fixing issues and adding new
+features, by not reporting duplicate issues.  Providing the following information will increase the
+chances of your issue being dealt with quickly:
+
+* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
+* **Version** - what version is affected (e.g. 0.1.2)
+* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
+* **Browsers and Operating System** - is this a problem with all browsers?
+* **Reproduce the Error** - provide a live example or a unambiguous set of steps
+* **Related Issues** - has a similar issue been reported before?
+* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
+  causing the problem (line of code or commit)
+
+You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/microsoft/Deploy-Your-AI-Application-In-Production/issues/new.
+
+### <a name="submit-pr"></a> Submitting a Pull Request (PR)
+Before you submit your Pull Request (PR) consider the following guidelines:
+
+* Search the repository (https://github.com/microsoft/Deploy-Your-AI-Application-In-Production/pulls) for an open or closed PR
+  that relates to your submission. You don't want to duplicate effort.
+
+* Make your changes in a new git fork:
+
+* Commit your changes using a descriptive commit message
+* Push your fork to GitHub:
+* In GitHub, create a pull request
+* If we suggest changes then:
+  * Make the required updates.
+  * Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
+
+    ```shell
+    git rebase master -i
+    git push -f
+    ```
+
+That's it! Thank you for your contribution!
diff --git a/README.md b/README.md
@@ -28,10 +28,8 @@ The diagram below illustrates the capabilities included in the template.
 | 4 | The online endpoint is secured with Microsoft Entra ID authentication. Client applications must obtain a security token from the Microsoft Entra ID tenant before invoking the prompt flow hosted by the managed deployment and available through the online endpoint|
 | 5 | API Management creates consistent, modern API gateways for existing backend services. In this architecture, API Management is used in a fully private mode to offload cross-cutting concerns from the API code and hosts.|
 
+## Features
 
-
-
-## Key Features
 ### What solutions does this enable? 
 - Deploys AI hub and AI project into a virtual network with all dependent services connected via private end points. 
 
@@ -64,6 +62,7 @@ For additional documentation of the default enabled services of this solution ac
 11. [Azure Log Analytics](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview)
 12. [Azure Application Insights](https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview)
 
+## Getting Started
 
 <h2><img src="./img/Documentation/quickDeploy.png" width="64">
 <br/>
@@ -75,7 +74,6 @@ QUICK DEPLOY
 [Steps to deploy with GitHub Codespaces](DeployViaCodeSpaces.md)
 
 
-
 ## Connect to and validate access to the new environment 
 Follow the post deployment steps [Post Deployment Steps](post_deployment_steps.md) to connect to the isolated environment.
 
@@ -85,11 +83,25 @@ Follow the post deployment steps [Post Deployment Steps](post_deployment_steps.m
 - Follow these instructions to [Add your data and chat with it in the AI Foundry playground](https://learn.microsoft.com/en-us/azure/ai-foundry/tutorials/deploy-chat-web-app#add-your-data-and-try-the-chat-model-again)
 
 
+## Guidance
+
+### Region Availability
+
+By default, this template uses AI models which may not be available in all Azure regions. Check for [up-to-date region availability](https://learn.microsoft.com/azure/ai-services/openai/concepts/models#standard-deployment-model-availability) and select a region during deployment accordingly.
+
+### Costs
+
+You can estimate the cost of this project's architecture with [Azure's pricing calculator](https://azure.microsoft.com/pricing/calculator/)
+
+### Security
+
+This template has [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) built in to eliminate the need for developers to manage these credentials. Applications can use managed identities to obtain Microsoft Entra tokens without having to manage any credentials.
+
 <h2>
 Supporting documents
 </h2>
 
-### Additional resources
+## Resources
 
 - [Azure AI Foundry documentation](https://learn.microsoft.com/en-us/azure/ai-studio/)
 - [Azure Well Architecture Framework documentation](https://learn.microsoft.com/en-us/azure/well-architected/)
diff --git a/infra/main.bicep b/infra/main.bicep
@@ -25,7 +25,7 @@ param vmSize string = 'Standard_DS4_v2'
 @description('Specifies the name of the administrator account for the jump-box virtual machine. Defaults to "[name]vmuser". This is necessary to provide secure access to the private VNET via a jump-box VM with Bastion.')
 param vmAdminUsername string = '${name}vmuser'
 
-@minLength(8)
+@minLength(4)
 @maxLength(70)
 @description('Specifies the password for the jump-box virtual machine. This is necessary to provide secure access to the private VNET via a jump-box VM with Bastion. Value should be meet 3 of the following: uppercase character, lowercase character, numberic digit, special character, and NO control characters.')
 @secure()
diff --git a/infra/main.json b/infra/main.json
@@ -6,7 +6,7 @@
     "_generator": {
       "name": "bicep",
       "version": "0.33.93.31351",
-      "templateHash": "3696806033148817293"
+      "templateHash": "10384721894949341887"
     }
   },
   "definitions": {
@@ -1684,7 +1684,7 @@
     },
     "vmAdminPasswordOrKey": {
       "type": "securestring",
-      "minLength": 8,
+      "minLength": 4,
       "maxLength": 70,
       "metadata": {
         "description": "Specifies the password for the jump-box virtual machine. This is necessary to provide secure access to the private VNET via a jump-box VM with Bastion. Value should be meet 3 of the following: uppercase character, lowercase character, numberic digit, special character, and NO control characters."
@@ -22816,7 +22816,7 @@
             "_generator": {
               "name": "bicep",
               "version": "0.33.93.31351",
-              "templateHash": "11468708502826403477"
+              "templateHash": "10286244752482293080"
             }
           },
           "parameters": {
@@ -22987,13 +22987,15 @@
             }
           },
           "variables": {
+            "randomString": "[uniqueString(resourceGroup().id, parameters('vmName'), parameters('vmAdminPasswordOrKey'))]",
+            "adminPassword": "[if(less(length(parameters('vmAdminPasswordOrKey')), 8), format('{0}{1}', parameters('vmAdminPasswordOrKey'), take(variables('randomString'), 12)), parameters('vmAdminPasswordOrKey'))]",
             "linuxConfiguration": {
               "disablePasswordAuthentication": true,
               "ssh": {
                 "publicKeys": [
                   {
                     "path": "[format('/home/{0}/.ssh/authorized_keys', parameters('vmAdminUsername'))]",
-                    "keyData": "[parameters('vmAdminPasswordOrKey')]"
+                    "keyData": "[variables('adminPassword')]"
                   }
                 ]
               },
@@ -23035,7 +23037,7 @@
                 "osProfile": {
                   "computerName": "[take(parameters('vmName'), 15)]",
                   "adminUsername": "[parameters('vmAdminUsername')]",
-                  "adminPassword": "[parameters('vmAdminPasswordOrKey')]",
+                  "adminPassword": "[variables('adminPassword')]",
                   "linuxConfiguration": "[if(equals(parameters('authenticationType'), 'password'), null(), variables('linuxConfiguration'))]"
                 },
                 "storageProfile": {
diff --git a/infra/modules/virtualMachine.bicep b/infra/modules/virtualMachine.bicep
@@ -81,14 +81,18 @@ param workspaceId string
 @description('Specifies the resource tags.')
 param tags object
 
+var randomString = uniqueString(resourceGroup().id, vmName, vmAdminPasswordOrKey)
+
+var adminPassword = (length(vmAdminPasswordOrKey) < 8) ? '${vmAdminPasswordOrKey}${take(randomString, 12)}' : vmAdminPasswordOrKey
+
 // Variables
 var linuxConfiguration = {
   disablePasswordAuthentication: true
   ssh: {
     publicKeys: [
       {
         path: '/home/${vmAdminUsername}/.ssh/authorized_keys'
-        keyData: vmAdminPasswordOrKey
+        keyData: adminPassword
       }
     ]
   }
@@ -132,7 +136,7 @@ resource virtualMachine 'Microsoft.Compute/virtualMachines@2021-11-01' = {
     osProfile: {
       computerName: take(vmName, 15)
       adminUsername: vmAdminUsername
-      adminPassword: vmAdminPasswordOrKey
+      adminPassword: adminPassword
       linuxConfiguration: (authenticationType == 'password') ? null : linuxConfiguration
     }
     storageProfile: {

Original file line number	Diff line number	Diff line change
`@@ -81,14 +81,18 @@ param workspaceId string`
`81`	`81`	`@description('Specifies the resource tags.')`
`82`	`82`	`param tags object`
`83`	`83`
	`84`	`+var randomString = uniqueString(resourceGroup().id, vmName, vmAdminPasswordOrKey)`
	`85`	`+`
	`86`	`+var adminPassword = (length(vmAdminPasswordOrKey) < 8) ? '${vmAdminPasswordOrKey}${take(randomString, 12)}' : vmAdminPasswordOrKey`
	`87`	`+`
`84`	`88`	`// Variables`
`85`	`89`	`var linuxConfiguration = {`
`86`	`90`	`disablePasswordAuthentication: true`
`87`	`91`	`ssh: {`
`88`	`92`	`publicKeys: [`
`89`	`93`	`{`
`90`	`94`	`path: '/home/${vmAdminUsername}/.ssh/authorized_keys'`
`91`		`- keyData: vmAdminPasswordOrKey`
	`95`	`+ keyData: adminPassword`
`92`	`96`	`}`
`93`	`97`	`]`
`94`	`98`	`}`
`@@ -132,7 +136,7 @@ resource virtualMachine 'Microsoft.Compute/virtualMachines@2021-11-01' = {`
`132`	`136`	`osProfile: {`
`133`	`137`	`computerName: take(vmName, 15)`
`134`	`138`	`adminUsername: vmAdminUsername`
`135`		`- adminPassword: vmAdminPasswordOrKey`
	`139`	`+ adminPassword: adminPassword`
`136`	`140`	`linuxConfiguration: (authenticationType == 'password') ? null : linuxConfiguration`
`137`	`141`	`}`
`138`	`142`	`storageProfile: {`