You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Enhance precheck scripts with tenant and role validation
- Added checks for Azure tenant match and user type in precheck.ps1 and precheck.sh to prevent cross-tenant deployment issues.
- Implemented role assignment checks in both scripts to ensure necessary permissions are granted for deployment.
- Updated Docker checks to clarify requirements based on environment (Local vs. Codespace/DevContainer).
- Introduced resource provider registration checks to ensure all required providers are registered before deployment.
- Enhanced model quota checks to utilize a centralized quota check script, allowing for better management of Azure OpenAI model quotas.
Copy file name to clipboardExpand all lines: docs/DeploymentGuide.md
+41-14Lines changed: 41 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -277,13 +277,40 @@ To optimize costs and integrate with your existing Azure infrastructure, you can
277
277
278
278
</details>
279
279
280
-
## Step 4: Deploy the Solution
280
+
## Step 4: Run the Deployment Pre-Check (Recommended)
281
+
282
+
Before kicking off `azd up`, run the standalone pre-check script to validate your environment, identity, regions, RBAC roles, resource providers, and Azure OpenAI quota in one shot. The script is **not** wired into `azd up` — it is a manual, read-only diagnostic you can run as many times as you like.
283
+
284
+
Run the script that matches your shell, from the repository root:
285
+
286
+
```bash
287
+
# Linux / macOS / Codespaces / WSL
288
+
bash scripts/precheck.sh
289
+
```
290
+
291
+
```powershell
292
+
# Windows (PowerShell 7+)
293
+
pwsh scripts/precheck.ps1
294
+
```
295
+
296
+
**What it checks (15 sections):** environment detection, `azd` / Azure CLI / Bicep / Python / Node / Docker tooling, `jq` (bash only), Azure login + subscription, tenant match (cross-tenant + Guest user detection), RBAC roles (Contributor + UAA/RBAC Admin, or Owner), app registration permission, required resource providers, `azd` environment variables, presence of deployment hook scripts, and an Azure OpenAI quota report across the recommended regions.
297
+
298
+
**Exit codes:**
299
+
300
+
| Exit Code | Meaning |
301
+
|-----------|---------|
302
+
|`0`| All checks passed (warnings allowed) — safe to proceed to Step 5 |
303
+
|`1`| One or more critical checks failed — fix the issues listed in the summary and re-run before invoking `azd up`|
304
+
305
+
For the full list of checks, severities, and remediation steps, see [DeploymentPreChecks.md](./DeploymentPreChecks.md).
306
+
307
+
## Step 5: Deploy the Solution
281
308
282
309
💡 **Before You Start:** If you encounter any issues during deployment, check our [Troubleshooting Guide](./TroubleShootingSteps.md) for common solutions.
283
310
284
311
⚠️ **Critical: Redeployment Warning** - If you have previously run `azd up` in this folder (i.e., a `.azure` folder exists), you must [create a fresh environment](#creating-a-new-environment) to avoid conflicts and deployment failures.
2. Navigate to **Microsoft Entra ID** from the left-hand menu
302
329
3. Under the **Overview** section, locate the **Tenant ID** field. Copy the value displayed
303
330
304
-
### 4.2 Start Deployment
331
+
### 5.2 Start Deployment
305
332
**NOTE:** If you are running the latest azd version (version 1.23.9), please run the following command.
306
333
```bash
307
334
azd config set provision.preflight off
@@ -326,19 +353,19 @@ azd up
326
353
327
354
**⚠️ Deployment Issues:** If you encounter errors or timeouts, try a different region as there may be capacity constraints. For detailed error solutions, see our [Troubleshooting Guide](./TroubleShootingSteps.md).
328
355
329
-
### 4.3 Get Application URL
356
+
### 5.3 Get Application URL
330
357
331
358
After successful deployment:
332
359
1. Open [Azure Portal](https://portal.azure.com/)
333
360
2. Navigate to your resource group
334
361
3. Find the Frontend App Service
335
362
4. Copy the **Default domain**
336
363
337
-
⚠️ **Important:** Complete [Post-Deployment Steps](#step-5-post-deployment-configuration) before accessing the application.
364
+
⚠️ **Important:** Complete [Post-Deployment Steps](#step-6-post-deployment-configuration) before accessing the application.
338
365
339
-
## Step 5: Post-Deployment Configuration
366
+
## Step 6: Post-Deployment Configuration
340
367
341
-
### 5.1 Run Post Deployment Script
368
+
### 6.1 Run Post Deployment Script
342
369
343
370
1. You can upload Team Configurations using command printed in the terminal. The command will look like one of the following. Run the appropriate command for your shell from the project root:
344
371
@@ -358,32 +385,32 @@ After successful deployment:
2. Wait up to 10 minutes for authentication changes to take effect
365
392
366
-
### 5.3 Verify Deployment
393
+
### 6.3 Verify Deployment
367
394
368
-
1. Access your application using the URL from Step 4.3
395
+
1. Access your application using the URL from Step 5.3
369
396
2. Confirm the application loads successfully
370
397
<!-- 3. Verify you can sign in with your authenticated account -->
371
398
372
-
### 5.4 Test the Application
399
+
### 6.4 Test the Application
373
400
374
401
**Quick Test Steps:**
375
402
376
-
1. **Access the application** using the URL from Step 4.3
403
+
1. **Access the application** using the URL from Step 5.3
377
404
2. **Sign in** with your authenticated account
378
-
3. **Select a use case** from the available scenarios you uploaded in Step 5.1
405
+
3. **Select a use case** from the available scenarios you uploaded in Step 6.1
379
406
4. **Ask a sample question** relevant to the selected use case
380
407
5. **Verify the response** includes appropriate multi-agent collaboration
381
408
6. **Check the logs** in Azure Portal to confirm backend processing
382
409
383
410
📖 **Detailed Instructions:** See the complete [Sample Workflow](./SampleQuestions.md) guide for step-by-step testing procedures and sample questions for each use case.
0 commit comments