Skip to content

Commit deb0a2c

Browse files
Merge pull request #65 from microsoft/readme-updates
docs: Refactor deployment guide Readme
2 parents 81e8922 + 173e9d5 commit deb0a2c

File tree

1 file changed

+57
-52
lines changed

1 file changed

+57
-52
lines changed

docs/DeploymentGuide.md

Lines changed: 57 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ Ensure you have access to an [Azure subscription](https://azure.microsoft.com/fr
2121

2222
**🔍 How to Check Your Permissions:**
2323

24-
<details>
25-
<summary><b>Azure Portal</b></summary>
26-
2724
1. Go to [Azure Portal](https://portal.azure.com/)
2825
2. Navigate to **Subscriptions** (search for "subscriptions" in the top search bar)
2926
3. Click on your target subscription
@@ -39,9 +36,6 @@ Ensure you have access to an [Azure subscription](https://azure.microsoft.com/fr
3936
3. If you can access this page, you have the required permissions
4037
4. Cancel without creating an app registration
4138

42-
</details>
43-
44-
4539
📖 **Detailed Setup:** Follow [Azure Account Set Up](./AzureAccountSetup.md) for complete configuration.
4640

4741
### 1.2 Check Service Availability & Quota
@@ -184,35 +178,13 @@ Review the configuration options below. You can customize any settings that meet
184178

185179
Copy the contents from the production configuration file to your main parameters file:
186180

187-
<details>
188-
<summary><b>Option 1: Manual Copy (Recommended for beginners)</b></summary>
189-
190181
1. Navigate to the `infra` folder in your project
191182
2. Open `main.waf.parameters.json` in a text editor (like Notepad, VS Code, etc.)
192183
3. Select all content (Ctrl+A) and copy it (Ctrl+C)
193184
4. Open `main.parameters.json` in the same text editor
194185
5. Select all existing content (Ctrl+A) and paste the copied content (Ctrl+V)
195186
6. Save the file (Ctrl+S)
196187

197-
</details>
198-
199-
<details>
200-
<summary><b>Option 2: Using Command Line</b></summary>
201-
202-
**For Linux/macOS/Git Bash:**
203-
```bash
204-
# Copy contents from production file to main parameters file
205-
cat infra/main.waf.parameters.json > infra/main.parameters.json
206-
```
207-
208-
**For Windows PowerShell:**
209-
```powershell
210-
# Copy contents from production file to main parameters file
211-
Get-Content infra/main.waf.parameters.json | Set-Content infra/main.parameters.json
212-
```
213-
214-
</details>
215-
216188
### 3.2 Set VM Credentials (Optional - Production Deployment Only)
217189

218190
> **Note:** This section only applies if you selected **Production** deployment type in section 3.1. VMs are not deployed in the default Development/Testing configuration.
@@ -229,16 +201,9 @@ azd env set AZURE_ENV_VM_ADMIN_PASSWORD <your-password>
229201
<details>
230202
<summary><b>Configurable Parameters</b></summary>
231203

232-
Customize these settings by following [Parameter Customization Guide](../docs/CustomizingAzdParameters.md):
204+
You can customize various deployment settings before running `azd up`, including Azure regions, AI model configurations (deployment type, version, capacity), container registry settings, and resource names.
233205

234-
| **Setting** | **Description** | **Default** |
235-
|-------------|-----------------|-------------|
236-
| **Azure Region** | Primary deployment region | Resource Group location |
237-
| **Secondary Location** | Fallback region for Cosmos DB | - |
238-
| **Deployment Type** | Infrastructure configuration | GlobalStandard |
239-
| **o3 Model** | AI model selection | o3 |
240-
| **o3 Model Version** | Model version | 2025-04-16 |
241-
| **o3 Model Capacity** | Token capacity | 200k |
206+
📖 **Complete Guide:** See [Parameter Customization Guide](../docs/CustomizingAzdParameters.md) for the full list of available parameters and their usage.
242207

243208
</details>
244209

@@ -295,11 +260,13 @@ azd up
295260
**During deployment, you'll be prompted for:**
296261
1. **Environment name** (e.g., "conmig") - Must be 3-16 characters long, alphanumeric only
297262
2. **Azure subscription** selection
298-
3. **Region** selection (choose one with adequate quota)
263+
3. **Azure AI Foundry deployment region** - Select a region with available o3 model quota for AI operations
264+
4. **Primary location** - Select the region where your infrastructure resources will be deployed
265+
5. **Resource group** selection (create new or use existing)
299266

300-
**Expected Duration:** 4-6 minutes
267+
**Expected Duration:** 4-6 minutes for default configuration
301268

302-
> **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).
269+
**⚠️ 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).
303270

304271
### 4.3 Get Application URL
305272

@@ -323,8 +290,22 @@ After successful deployment:
323290
### 5.2 Verify Deployment
324291

325292
1. Access your application using the URL from Step 4.3
326-
2. Upload sample YAML files from the [`/data`](../data/) folder
327-
3. Test the migration functionality
293+
2. Confirm the application loads successfully
294+
3. Verify you can sign in with your authenticated account
295+
296+
### 5.3 Test the Application
297+
298+
Follow the detailed workflow to test the migration functionality:
299+
300+
**Quick Test Steps:**
301+
1. Download sample YAML files from the [`/data`](../data/) folder (EKS or GKE samples)
302+
2. Upload the files to the application
303+
3. Click **Start Processing** to begin the migration
304+
4. Monitor the batch processing status (typically takes 20-30 minutes)
305+
5. Review the translated files and generated reports
306+
6. Download the results using the **Download all as .zip** button
307+
308+
📖 **Detailed Instructions:** See the complete [Sample Workflow](./SampleWorkflow.md) guide for step-by-step testing procedures.
328309

329310
## Step 6: Clean Up (Optional)
330311

@@ -436,22 +417,46 @@ azd env get-values
436417
437418
## Next Steps
438419
439-
🚀 **Get Started:** Follow the [Sample Workflow](./SampleWorkflow.md) to explore the application features.
420+
Now that your deployment is complete and tested, explore these resources to enhance your experience:
440421
441422
📚 **Learn More:**
442-
- [Technical Architecture](./TechnicalArchitecture.md)
443-
- [Troubleshooting Guide](./TroubleShootingSteps.md)
444-
- [Local Development Setup](./LocalDevelopmentSetup.md)
423+
- [Technical Architecture](./TechnicalArchitecture.md) - Understand the system design and components
424+
- [Customize Expert Agents](./CustomizeExpertAgents.md) - Tailor AI agents to your specific needs
425+
- [Extend Platform Support](./ExtendPlatformSupport.md) - Add support for additional container platforms
426+
- [Configure MCP Servers](./ConfigureMCPServers.md) - Set up Model Context Protocol servers
427+
- [Local Development Setup](./LocalDevelopmentSetup.md) - Set up your local development environment
445428
446429
## Need Help?
447430
448431
- 🐛 **Issues:** Check [Troubleshooting Guide](./TroubleShootingSteps.md)
449432
- 💬 **Support:** Review [Support Guidelines](../SUPPORT.md)
450433
- 🔧 **Development:** See [Contributing Guide](../CONTRIBUTING.md)
451-
452-
### Deploy Your local changes
453-
To Deploy your local changes rename the below files.
454434
455-
Rename `azure.yaml` to `azure_custom2.yaml` and `azure_custom.yaml` to `azure.yaml`.
456-
Go to `infra` directory
457-
Rename `main.bicep` to `main_custom2.bicep` and `main_custom.bicep` to `main.bicep`. Continue with the [deploying steps](#deploying-with-azd).
435+
---
436+
437+
## Advanced: Deploy Local Changes
438+
439+
If you've made local modifications to the code and want to deploy them to Azure, follow these steps to swap the configuration files:
440+
441+
> **Note:** To set up and run the application locally for development, see the [Local Development Setup Guide](./LocalDevelopmentSetup.md).
442+
443+
### Step 1: Rename Azure Configuration Files
444+
445+
**In the root directory:**
446+
1. Rename `azure.yaml` to `azure_custom2.yaml`
447+
2. Rename `azure_custom.yaml` to `azure.yaml`
448+
449+
### Step 2: Rename Infrastructure Files
450+
451+
**In the `infra` directory:**
452+
1. Rename `main.bicep` to `main_custom2.bicep`
453+
2. Rename `main_custom.bicep` to `main.bicep`
454+
455+
### Step 3: Deploy Changes
456+
457+
Run the deployment command:
458+
```shell
459+
azd up
460+
```
461+
462+
> **Note:** These custom files are configured to deploy your local code changes instead of pulling from the GitHub repository.

0 commit comments

Comments
 (0)