Skip to content

Commit 9a092e8

Browse files
Merge pull request #403 from microsoft/PSL-US-19986
docs: Update DeploymentGuide.md with new parameters and resource group reuse instructions
2 parents a198f19 + 66df85f commit 9a092e8

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
@@ -90,25 +90,61 @@ powershell.exe -ExecutionPolicy Bypass -File ".\resourcedeployment.ps1"
9090
```
9191

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

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

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

100114
```
101115
'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'
102116
```
103-
1. **ModelLocation** - Azure data center where GPT model will be deployed.
117+
6. **ModelLocation** - Azure data center where GPT model will be deployed.
104118
The following locations are currently available :
105119
```
106120
'WestUS3', 'EastUS', 'EastUS2', 'SwedenCentral'
107121
```
108122
109-
1. **Email** - used for issuing certificates in Kubernetes clusters from the [Let's Encrypt](https://letsencrypt.org/) service. Email address should be valid.
123+
7. **Email** - used for issuing certificates in Kubernetes clusters from the [Let's Encrypt](https://letsencrypt.org/) service. Email address should be valid.
124+
125+
8. **GO !** - Deployment Script executes Azure deployment, Azure Infrastructure configuration, Application code compile and publish into Kubernetes Cluster.
126+
127+
## Configuring a New or Existing Resource Group
128+
129+
➕ Creating a New Resource Group
130+
131+
You have two options:
132+
133+
- Manually specify a resource group name (e.g., rg-myproject-dev)
134+
135+
- Leave the input field blank — a new name will be auto-generated by the script
136+
137+
🔁 Using an Existing Resource Group
138+
139+
If reusing an existing Azure Resource Group:
140+
141+
- Provide the exact name of the existing resource group
142+
143+
- Ensure the environment name matches the original environment used for that resource group
144+
145+
⚠️ After deployment, please restart the AKS (Kubernetes) service to ensure updated configurations are applied when using a reused resource group.
146+
110147
111-
1. **GO !** - Deployment Script executes Azure deployment, Azure Infrastructure configuration, Application code compile and publish into Kubernetes Cluster.
112148
113149
<!-- 1. **Data File Upload and Processing** - Once the deployment finished, The Sample Data File upload and Document processing starts. -->
114150
-440 KB
Loading

0 commit comments

Comments
 (0)