Skip to content

Commit 57593d8

Browse files
Merge pull request #404 from microsoft/dev
docs: Merge dev into main (Deployment Guide Improvements and UX Updates)
2 parents 213e928 + 9a092e8 commit 57593d8

File tree

2 files changed

+43
-7
lines changed

2 files changed

+43
-7
lines changed

docs/DeploymentGuide.md

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,25 +89,61 @@ powershell.exe -ExecutionPolicy Bypass -File ".\resourcedeployment.ps1"
8989
```
9090

9191
You will be prompted for the following parameters with this Screen :
92-
<img src="./images/deployment/Deployment_Screen01.png" width="900" alt-text="Input Parameters">
92+
<img src="./images/deployment/Deployment_Screen01.png" width="900" alt-text="Input Parameters">
9393

94-
1. **Subscription ID** - copy/paste from Azure portal
95-
1. **Location** - Azure data center where resources will be deployed.
94+
1. **Tenant ID** - The Azure Active Directory (AAD) tenant ID. This is used for authenticating against Azure resources. Copy this from the Azure portal.
95+
Example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
9696

97-
*Please [check Azure resource availability and note hardcoded regions](#regional-availability). The following locations are currently supported:
97+
2. **Subscription ID** - The Azure subscription ID where resources will be deployed.
98+
Copy this from the Azure portal.
99+
100+
3. **Environment Name** - A unique environment name (e.g., dev, test, prod).
101+
This is used to scope resource names and group deployments logically.
102+
103+
4. **Resource Group Name** - The Azure resource group to deploy resources into.
104+
You may either:
105+
106+
- Specify an existing resource group to reuse it, [see below](#configuring-a-new-or-existing-resource-group) for more details, or
107+
- Leave blank to auto-generate a new name.
108+
109+
5. **Location** - Azure data center where resources will be deployed.
110+
111+
* Please [check Azure resource availability and note hardcoded regions](#regional-availability). The following locations are currently supported:
98112

99113
```
100114
'EastUS', 'EastUS2', 'WestUS', 'WestUS2', 'WestUS3', 'CentralUS', 'NorthCentralUS', 'SouthCentralUS','WestEurope', 'NorthEurope', 'SoutheastAsia', 'EastAsia', 'JapanEast', 'JapanWest', 'AustraliaEast', 'AustraliaSoutheast', 'CentralIndia', 'SouthIndia', 'CanadaCentral','CanadaEast', 'UKSouth', 'UKWest', 'FranceCentral', 'FranceSouth', 'KoreaCentral','KoreaSouth', 'GermanyWestCentral', 'GermanyNorth', 'NorwayWest', 'NorwayEast', 'SwitzerlandNorth', 'SwitzerlandWest', 'UAENorth', 'UAECentral', 'SouthAfricaNorth','SouthAfricaWest', 'BrazilSouth','BrazilSoutheast', 'QatarCentral', 'ChinaNorth', 'ChinaEast', 'ChinaNorth2', 'ChinaEast2'
101115
```
102-
1. **ModelLocation** - Azure data center where GPT model will be deployed.
116+
6. **ModelLocation** - Azure data center where GPT model will be deployed.
103117
The following locations are currently available :
104118
```
105119
'WestUS3', 'EastUS', 'EastUS2', 'SwedenCentral'
106120
```
107121
108-
1. **Email** - used for issuing certificates in Kubernetes clusters from the [Let's Encrypt](https://letsencrypt.org/) service. Email address should be valid.
122+
7. **Email** - used for issuing certificates in Kubernetes clusters from the [Let's Encrypt](https://letsencrypt.org/) service. Email address should be valid.
123+
124+
8. **GO !** - Deployment Script executes Azure deployment, Azure Infrastructure configuration, Application code compile and publish into Kubernetes Cluster.
125+
126+
## Configuring a New or Existing Resource Group
127+
128+
➕ Creating a New Resource Group
129+
130+
You have two options:
131+
132+
- Manually specify a resource group name (e.g., rg-myproject-dev)
133+
134+
- Leave the input field blank — a new name will be auto-generated by the script
135+
136+
🔁 Using an Existing Resource Group
137+
138+
If reusing an existing Azure Resource Group:
139+
140+
- Provide the exact name of the existing resource group
141+
142+
- Ensure the environment name matches the original environment used for that resource group
143+
144+
⚠️ After deployment, please restart the AKS (Kubernetes) service to ensure updated configurations are applied when using a reused resource group.
145+
109146
110-
1. **GO !** - Deployment Script executes Azure deployment, Azure Infrastructure configuration, Application code compile and publish into Kubernetes Cluster.
111147
112148
<!-- 1. **Data File Upload and Processing** - Once the deployment finished, The Sample Data File upload and Document processing starts. -->
113149
-440 KB
Loading

0 commit comments

Comments
 (0)