Skip to content

Commit d50e46a

Browse files
Thanusree-MicrosoftThanusree-Microsoft
authored
Update DeploymentGuide.md
Updated content and maintained consistency throughout.
1 parent 59dba48 commit d50e46a

1 file changed

Lines changed: 52 additions & 33 deletions

File tree

‎docs/DeploymentGuide.md‎

Lines changed: 52 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -29,41 +29,13 @@ Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/g
2929

3030
➡️ To ensure sufficient quota is available in your subscription, please follow **[Quota check instructions guide](../docs/quota_check.md)** before you deploy the solution.
3131

32-
| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Modernize-your-Code-Solution-Accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Modernize-your-Code-Solution-Accelerator) |
33-
|---|---|
34-
35-
### **Configurable Deployment Settings**
36-
37-
When you start the deployment, most parameters will have **default values**, but you can update the following settings by following the steps [here](../docs/CustomizingAzdParameters.md):
38-
39-
| **Setting** | **Description** | **Default value** |
40-
|----------------------------------|------------------------------------------------------------------------------------------------------|----------------------------|
41-
| **Azure Region** | The region where resources will be created. | East US |
42-
| **Resource Prefix** | Prefix for all resources created by this template. This prefix will be used to create unique names for all resources. The prefix must be unique within the resource group. | azdtemp |
43-
| **AI Location** | Location for all AI services resources. This location can be different from the resource group location. | japaneast |
44-
| **Capacity** | Configure capacity for **gpt-4o**. | 200 |
45-
| **Model Deployment Type** | Change the Model Deployment Type (allowed values: Standard, GlobalStandard). | GlobalStandard |
46-
| **Model Name** | Set the Model Name (allowed values: gpt-4o). | gpt-4o |
47-
| **Model Version** | Set the Azure model version (allowed values: 2024-08-06). | 2024-08-06 |
48-
| **Image Tag** | Set the Image tag (allowed values: latest, dev, hotfix). | latest |
49-
| **Existing Log analytics workspace** | To reuse the existing Log analytics workspace Id. | `<Existing Workspace Id>` |
32+
## Deployment Options & Steps
5033

51-
52-
This accelerator can be configured to use authentication.
53-
54-
* To use authentication the installer must have the rights to create and register an application identity in their Azure environment.
55-
After installation is complete, follow the directions in the [App Authentication](../docs/AddAuthentication.md) document to enable authentication.
56-
* Note: If you enable authentication, all processing history and current processing will be performed for your specific user. Without authentication, all batch history from the tool will be visible to all users.
57-
58-
### [Optional] Quota Recommendations
59-
By default, the **GPT model capacity** in deployment is set to **5k tokens**.
60-
> **We recommend increasing the capacity to 200k tokens for optimal performance.**
61-
62-
To adjust quota settings, follow these [steps](../docs/AzureGPTQuotaSettings.md)
63-
64-
### Deployment Options
6534
Pick from the options below to see step-by-step instructions for: GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments.
6635

36+
| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Modernize-your-Code-Solution-Accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Modernize-your-Code-Solution-Accelerator) |
37+
|---|---|
38+
6739
<details>
6840
<summary><b>Deploy in GitHub Codespaces</b></summary>
6941

@@ -124,7 +96,54 @@ If you're not using one of the above options for opening the project, then you'l
12496

12597
</details>
12698

127-
### Deploying
99+
<br/>
100+
101+
Consider the following settings during your deployment to modify specific settings:
102+
103+
<details>
104+
<Summary><b>Configurable Deployment Settings</b></Summary>
105+
106+
When you start the deployment, most parameters will have **default values**, but you can update the following settings by following the steps [here](../docs/CustomizingAzdParameters.md):
107+
108+
| **Setting** | **Description** | **Default value** |
109+
|----------------------------------|------------------------------------------------------------------------------------------------------|----------------------------|
110+
| **Azure Region** | The region where resources will be created. | East US |
111+
| **Resource Prefix** | Prefix for all resources created by this template. This prefix will be used to create unique names for all resources. The prefix must be unique within the resource group. | azdtemp |
112+
| **AI Location** | Location for all AI services resources. This location can be different from the resource group location. | japaneast |
113+
| **Capacity** | Configure capacity for **gpt-4o**. | 200 |
114+
| **Model Deployment Type** | Change the Model Deployment Type (allowed values: Standard, GlobalStandard). | GlobalStandard |
115+
| **Model Name** | Set the Model Name (allowed values: gpt-4o). | gpt-4o |
116+
| **Model Version** | Set the Azure model version (allowed values: 2024-08-06). | 2024-08-06 |
117+
| **Image Tag** | Set the Image tag (allowed values: latest, dev, hotfix). | latest |
118+
| **Existing Log analytics workspace** | To reuse the existing Log analytics workspace Id. | `<Existing Workspace Id>` |
119+
120+
121+
This accelerator can be configured to use authentication.
122+
123+
* To use authentication the installer must have the rights to create and register an application identity in their Azure environment.
124+
After installation is complete, follow the directions in the [App Authentication](../docs/AddAuthentication.md) document to enable authentication.
125+
* Note: If you enable authentication, all processing history and current processing will be performed for your specific user. Without authentication, all batch history from the tool will be visible to all users.
126+
127+
</details>
128+
129+
<details>
130+
<Summary><b> Quota Recommendations </b></Summary>
131+
By default, the **GPT model capacity** in deployment is set to **5k tokens**.
132+
> **We recommend increasing the capacity to 200k tokens for optimal performance.**
133+
134+
To adjust quota settings, follow these [steps](../docs/AzureGPTQuotaSettings.md)
135+
136+
</details>
137+
138+
<details>
139+
140+
<summary><b>Reusing an Existing Log Analytics Workspace</b></summary>
141+
142+
Guide to get your [Existing Workspace ID](/docs/re-use-log-analytics.md)
143+
144+
</details>
145+
146+
### Deploying with AZD
128147

129148
Once you've opened the project in [Codespaces](#github-codespaces) or in [Dev Containers](#vs-code-dev-containers) or [locally](#local-environment), you can deploy it to Azure following the following steps.
130149

0 commit comments

Comments
 (0)