Skip to content

Commit c8537ef

Browse files
Updated the readme document (#86)
1 parent a7a42b2 commit c8537ef

File tree

12 files changed

+50
-34
lines changed

12 files changed

+50
-34
lines changed

docs/Dev_ContainerSteps.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,35 @@ You can run this solution in VS Code Dev Containers, which will open the project
3030
The [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/what-is-azure-cli?view=azure-cli-latest) is used to validate available AI model quota.
3131

3232
![image showing theaz login in the vs code terminal](../img/provisioning/az_login.png)
33+
3. Return to terminal and type the below command for initializing the environment.
34+
```shell
35+
azd init
36+
```
37+
![image showing the initial screen in the vs code terminal](../img/provisioning/azd_init_terminal.png)
38+
39+
4. Enter the environment name.
40+
> **Note:** Length of the environment name should be less than or equal to 12 characters.
41+
42+
![aImage showing entering a new environment name](../img/provisioning/enter_evn_name.png)
3343

34-
3. Now start the deployment of the infrastructure by typing the below command:
44+
5. Now start the deployment of the infrastructure by typing the below command:
3545
```shell
3646
azd up
3747
```
3848
> ⚠️ **Note:** The latest version of the Azure Developer CLI (AZD) is currently limited on prompting for missing parameters. The feature flag parameters in this solution have been temporarily defaulted to `'disabled'` until this limitation is lifted and prompting will resume.
3949

4050

41-
![image showing the terminal in vs code](../img/provisioning/azd_provision_terminal.png)
42-
51+
![image showing the terminal in vs code](images/re_use_log/nonwaf.png)
52+
Log in to **Azure** for authentication. ![alt text](images/re_use_log/login.png)
4353
This step will allow you to choose from the subscriptions you have available, based on the account you logged in with in the login step. Next it will prompt you for the region to deploy the resources into as well as any additional Azure resources to be provisioned and configured.
44-
54+
4555
**Important:** Be sure to remember the vm password. This will be used in a later step. You are still required to log into Azure once you connect through the virtual machine.
56+
> ⚠️ **Note:**
57+
> 1. For **WAF Deployment**, Select the **Network Isolation** as **'True'**.
58+
> ![alt text](images/re_use_log/waf.png)
59+
> 2. For **Sample App Deployment**, Select the **appSampleEnabled** as **'True'**.
60+
> ![alt text](images/re_use_log/samapp.png)
61+
4662

4763
6. The automated model quota check will run, and will check if the location selected will have the necessary quota for the AI Models that are listed in the parameters file prior to deploying any resources.
4864
![image showing model quota pre-provision code executing](../img/provisioning/preprovision_output.png)
@@ -63,28 +79,25 @@ You can run this solution in VS Code Dev Containers, which will open the project
6379
These steps will help to check that the isolated environment was set up correctly.
6480
Follow these steps to check the creation of the required private endpoints in the environment (when set to networkIsolation = true).
6581

66-
One way to check if the access is private to the hub is to launch the AI Foundry hub from the portal.
82+
One way to verify whether access is private to the foundry is by launching Azure AI Foundry from the portal.
6783

68-
![Image showing if network isolation is checked](../img/provisioning/checkNetworkIsolation3.png)
84+
![Image showing if network isolation is checked](images/re_use_log/AI_Foundry_Portal.png)
6985

7086
When a user that is not connected through the virtual network via an RDP approved connection will see the following screen in their browser. This is the intended behavior!
7187

72-
![Image showing the virtual machine in the browser](../img/provisioning/checkNetworkIsolation4.png)
88+
![Image showing the virtual machine in the browser](images/re_use_log/AI_Foundry_view.png)
7389

7490
A more thourough check is to look for the networking settings and checking for private end points.
7591

7692
1. Go to the Azure Portal and select your Azure AI hub that was just created.
7793

78-
2. Click on Settings and then Networking.
79-
80-
![Image showing the Azure Portal for AI Foundry Hub and the settings blade](../img/provisioning/checkNetworkIsolation1.png)
94+
2. Click on Resource Management and then Networking.
8195

82-
3. Open the Workspace managed outbound access tab.
96+
![Image showing the Azure Portal for AI Foundry Hub and the settings blade](images/re_use_log/Private_network_endpoints.png)
8397

84-
![Image showing the Azure Portal for AI Foundry Hub and the Workspace managed outbound access tab](../img/provisioning/checkNetworkIsolation2.png)
8598

86-
Here, you will find the private endpoints that are connected to the resources within the hub managed virtual network. Ensure that these private endpoints are active.
87-
The hub should show that Public access is ‘disabled’.
99+
Here, you will find the private endpoints that are connected to the resources within the foundry managed virtual network. Ensure that these private endpoints are active.
100+
The foundry should show that Public access is ‘disabled’.
88101

89102
## Connecting to the isolated network via RDP
90103
1. Navigate to the resource group where the isolated AI Foundry was deployed to and select the virtual machine.
@@ -101,22 +114,22 @@ A more thourough check is to look for the networking settings and checking for p
101114

102115
4. Supply the username and the password you created as environment variables and press the connect button.
103116

104-
![Image showing the screen to enter the VM Admin info and the connect to bastion button](../img/provisioning/checkNetworkIsolation8.png)
117+
![Image showing the screen to enter the VM Admin info and the connect to bastion button](../img/provisioning/Bastion.png)
105118

106119
5. Your virtual machine will launch and you will see a different screen.
107120

108121
![Image showing the opening of the Virtual machine in another browser tab](../img/provisioning/checkNetworkIsolation9.png)
109122

110-
6. Launch Edge browser and navigate to your AI Foundry Hub. https://ai.azure.com Sign in using your credentials.
123+
6. Launch Edge browser and navigate to your Azure AI Foundry. https://ai.azure.com Sign in using your credentials.
111124

112125

113126
7. You are challenged by MFA to connect.
114127

115128
![Image showing the Multi Factor Authentication popup](../img/provisioning/checkNetworkIsolation10.png)
116129

117-
8. You will now be able to view the Foundry Hub which is contained in an isolated network.
130+
8. You will now be able to view the Azure AI Foundry which is contained in an isolated network.
118131

119-
![Image showing the Azure Foundry AI Hub with a private bubble icon](../img/provisioning/checkNetworkIsolation11.png)
132+
![Image showing the Azure Foundry AI Hub with a private bubble icon](images/re_use_log/Azure_ai_foundry_inside_vm.png)
120133

121134
## Contributing
122135

docs/github_code_spaces_steps.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ You can run this solution using GitHub Codespaces. The button will open a web-ba
3838
![image showing the initial screen in the vs code terminal](../img/provisioning/azd_init_terminal.png)
3939

4040
4. Enter the environment name.
41+
> **Note:** Length of the environment name should be less than or equal to 12 characters.
4142

4243
![aImage showing entering a new environment name](../img/provisioning/enter_evn_name.png)
4344

@@ -47,11 +48,16 @@ You can run this solution using GitHub Codespaces. The button will open a web-ba
4748
```
4849
> ⚠️ **Note:** The latest version of the Azure Developer CLI (AZD) is currently limited on prompting for missing parameters. The feature flag parameters in this solution have been temporarily defaulted to `'disabled'` until this limitation is lifted and prompting will resume.
4950

50-
![image showing the terminal in vs code](../img/provisioning/azd_provision_terminal.png)
51-
51+
![image showing the terminal in vs code](images/re_use_log/nonwaf.png)
52+
Log in to **Azure** for authentication. ![alt text](images/re_use_log/login.png)
5253
This step will allow you to choose from the subscriptions you have available, based on the account you logged in with in the login step. Next it will prompt you for the region to deploy the resources into as well as any additional Azure resources to be provisioned and configured.
5354

5455
**Important:** Be sure to remember the vm password. This will be used in a later step. You are still required to log into Azure once you connect through the virtual machine.
56+
> ⚠️ **Note:**
57+
> 1. For **WAF Deployment**, Select the **Network Isolation** as **'True'**.
58+
> ![alt text](images/re_use_log/waf.png)
59+
> 2. For **Sample App Deployment**, Select the **appSampleEnabled** as **'True'**.
60+
> ![alt text](images/re_use_log/samapp.png)
5561

5662
6. The automated model quota check will run, and will check if the location selected will have the necessary quota for the AI Models that are listed in the parameters file prior to deploying any resources.
5763
![image showing model quota pre-provision code executing](../img/provisioning/preprovision_output.png)
@@ -72,28 +78,25 @@ You can run this solution using GitHub Codespaces. The button will open a web-ba
7278
These steps will help to check that the isolated environment was set up correctly.
7379
Follow these steps to check the creation of the required private endpoints in the environment (when set to networkIsolation = true).
7480

75-
One way to check if the access is private to the hub is to launch the AI Foundry hub from the portal.
81+
One way to verify whether access is private to the foundry is by launching Azure AI Foundry from the portal.
7682

77-
![Image showing if network isolation is checked](../img/provisioning/checkNetworkIsolation3.png)
83+
![Image showing if network isolation is checked](images/re_use_log/AI_Foundry_Portal.png)
7884

7985
When a user that is not connected through the virtual network via an RDP approved connection will see the following screen in their browser. This is the intended behavior!
8086

81-
![Image showing the virtual machine in the browser](../img/provisioning/checkNetworkIsolation4.png)
87+
![Image showing the virtual machine in the browser](images/re_use_log/AI_Foundry_view.png)
8288

8389
A more thourough check is to look for the networking settings and checking for private end points.
8490

8591
1. Go to the Azure Portal and select your Azure AI hub that was just created.
8692

87-
2. Click on Settings and then Networking.
88-
89-
![Image showing the Azure Portal for AI Foundry Hub and the settings blade](../img/provisioning/checkNetworkIsolation1.png)
93+
2. Click on Resource Management and then Networking.
9094

91-
3. Open the Workspace managed outbound access tab.
95+
![Image showing the Azure Portal for AI Foundry Hub and the settings blade](images/re_use_log/Private_network_endpoints.png)
9296

93-
![Image showing the Azure Portal for AI Foundry Hub and the Workspace managed outbound access tab](../img/provisioning/checkNetworkIsolation2.png)
9497

95-
Here, you will find the private endpoints that are connected to the resources within the hub managed virtual network. Ensure that these private endpoints are active.
96-
The hub should show that Public access is ‘disabled’.
98+
Here, you will find the private endpoints that are connected to the resources within the foundry managed virtual network. Ensure that these private endpoints are active.
99+
The foundry should show that Public access is ‘disabled’.
97100

98101
## Connecting to the isolated network via RDP
99102
1. Navigate to the resource group where the isolated AI Foundry was deployed to and select the virtual machine.
@@ -110,22 +113,22 @@ A more thourough check is to look for the networking settings and checking for p
110113

111114
4. Supply the username and the password you created as environment variables and press the connect button.
112115

113-
![Image showing the screen to enter the VM Admin info and the connect to bastion button](../img/provisioning/checkNetworkIsolation8.png)
116+
![Image showing the screen to enter the VM Admin info and the connect to bastion button](../img/provisioning/Bastion.png)
114117

115118
5. Your virtual machine will launch and you will see a different screen.
116119

117120
![Image showing the opening of the Virtual machine in another browser tab](../img/provisioning/checkNetworkIsolation9.png)
118121

119-
6. Launch Edge browser and navigate to your AI Foundry Hub. https://ai.azure.com Sign in using your credentials.
122+
6. Launch Edge browser and navigate to your Azure AI Foundry. https://ai.azure.com Sign in using your credentials.
120123

121124

122125
7. You are challenged by MFA to connect.
123126

124127
![Image showing the Multi Factor Authentication popup](../img/provisioning/checkNetworkIsolation10.png)
125128

126-
8. You will now be able to view the Foundry Hub which is contained in an isolated network.
129+
8. You will now be able to view the Azure AI Foundry which is contained in an isolated network.
127130

128-
![Image showing the Azure Foundry AI Hub with a private bubble icon](../img/provisioning/checkNetworkIsolation11.png)
131+
![Image showing the Azure Foundry AI Hub with a private bubble icon](images/re_use_log/Azure_ai_foundry_inside_vm.png)
129132

130133
## Contributing
131134

81.9 KB
Loading
156 KB
Loading
176 KB
Loading
74 KB
Loading

docs/images/re_use_log/login.png

17 KB
Loading

docs/images/re_use_log/nonwaf.png

120 KB
Loading

docs/images/re_use_log/samapp.png

4.62 KB
Loading

docs/images/re_use_log/waf.png

6.35 KB
Loading

0 commit comments

Comments
 (0)