Skip to content

Commit 3080dbc

Browse files
committed
docs(deploy): enhance VPN documentation with detailed client setup instructions
- update README to include VPN client installation links for Windows and macOS - provide step-by-step instructions for downloading and importing VPN configuration - clarify connection process for accessing private endpoints 🔒 - Generated by Copilot
1 parent fbefc5f commit 3080dbc

File tree

4 files changed

+38
-7
lines changed

4 files changed

+38
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Production-ready framework for orchestrating robotics and AI workloads on [Azure
99
| Infrastructure as Code | [Terraform modules](deploy/001-iac/) for reproducible Azure deployments |
1010
| Dual Orchestration | Submit jobs via [AzureML](workflows/azureml/) or [OSMO](workflows/osmo/) |
1111
| Workload Identity | Key-less auth via Azure AD ([setup guide](deploy/002-setup/README.md#scenario-2-workload-identity)) |
12-
| Private Networking | Services on private VNet with optional [VPN gateway](deploy/001-iac/vpn/) |
12+
| Private Networking | Services on private VNet with optional [VPN gateway](deploy/001-iac/vpn/) ([client setup](deploy/001-iac/vpn/README.md#-vpn-client-setup)) |
1313
| MLflow Integration | Experiment tracking with Azure ML ([details](docs/mlflow-integration.md)) |
1414
| GPU Scheduling | [KAI Scheduler](deploy/002-setup/values/kai-scheduler.yaml) for efficient utilization |
1515
| Auto-scaling | Pay-per-use GPU compute on AKS Spot nodes |

deploy/001-iac/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ cp terraform.tfvars.example terraform.tfvars
197197
terraform init && terraform apply -var-file=terraform.tfvars
198198
```
199199

200-
See [vpn/README.md](vpn/README.md) for client setup and AAD authentication.
200+
See [vpn/README.md](vpn/README.md) for configuration options and [VPN client setup](vpn/README.md#-vpn-client-setup) for connecting from your local machine.
201201

202202
### Private DNS for OSMO UI
203203

deploy/001-iac/vpn/README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,41 @@ root_certificate_public_data = "MIIC5jCCAc6g..." # Base64-encoded cert
5656

5757
## 💻 VPN Client Setup
5858

59-
1. Download the VPN client configuration from Azure Portal
60-
2. Install Azure VPN Client (Windows/macOS) or OpenVPN
61-
3. Import the downloaded profile
62-
4. Connect using Azure AD credentials or certificate
59+
### Install Azure VPN Client
60+
61+
| Platform | Installation |
62+
|----------|--------------|
63+
| Windows | [Microsoft Store](https://apps.microsoft.com/detail/9NP355QT2SQB) |
64+
| macOS | [App Store](https://apps.apple.com/us/app/azure-vpn-client/id1553936137) |
65+
| Ubuntu 20.04/22.04 | [Microsoft Docs](https://learn.microsoft.com/en-us/azure/vpn-gateway/point-to-site-entra-vpn-client-linux#install-the-azure-vpn-client) |
66+
67+
### Download VPN Configuration
68+
69+
1. Open the [Azure Portal](https://portal.azure.com)
70+
2. Navigate to your Virtual Network Gateway resource:
71+
- Search for "Virtual network gateways" in the portal search bar
72+
- Select the gateway matching your deployment (e.g., `vgw-<resource_prefix>-<environment>-<instance>`)
73+
3. Select **Point-to-site configuration** from the left menu
74+
4. Click **Download VPN client** button
75+
5. Save and extract the downloaded ZIP file
76+
77+
### Import Configuration
78+
79+
1. Open the Azure VPN Client application
80+
2. Click the **+** (Import) button in the bottom left
81+
3. Navigate to the extracted ZIP folder
82+
4. Open the `AzureVPN` folder
83+
5. Select `azurevpnconfig_aad.xml` (for Azure AD authentication)
84+
6. Click **Save**
85+
86+
### Connect
87+
88+
1. Select the imported connection profile
89+
2. Click **Connect**
90+
3. Authenticate with your Azure AD credentials when prompted
91+
4. Verify connection status shows "Connected"
92+
93+
Once connected, you can access private endpoints including OSMO UI, PostgreSQL, and Redis.
6394

6495
## 🏢 Site-to-Site VPN
6596

deploy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Point-to-Site VPN enabling secure remote access to private endpoints. Required f
5959
- Connecting to private PostgreSQL and Redis from local machine
6060
- Debugging workloads over private network
6161

62-
See [001-iac/vpn/README.md](001-iac/vpn/README.md) for client setup and AAD authentication.
62+
See [001-iac/vpn/README.md](001-iac/vpn/README.md) for deployment and [VPN client setup](001-iac/vpn/README.md#-vpn-client-setup).
6363

6464
See the [root README](../README.md) for architecture details.
6565

0 commit comments

Comments
 (0)