Update prepdocs with ping and update docs

Author: pamelafox

app/backend/prepdocs.py

@@ -4,6 +4,7 @@
 import os
 from typing import Optional, Union
 
+import aiohttp
 from azure.core.credentials import AzureKeyCredential
 from azure.core.credentials_async import AsyncTokenCredential
 from azure.identity.aio import AzureDeveloperCliCredential, get_bearer_token_provider
@@ -45,6 +46,19 @@ def clean_key_if_exists(key: Union[str, None]) -> Union[str, None]:
     return None
 
 
+async def check_search_service_connectivity(search_service: str) -> bool:
+    """Check if the search service is accessible by hitting the /ping endpoint."""
+    ping_url = f"https://{search_service}.search.windows.net/ping"
+
+    try:
+        async with aiohttp.ClientSession() as session:
+            async with session.get(ping_url, timeout=aiohttp.ClientTimeout(total=10)) as response:
+                return response.status == 200
+    except Exception as e:
+        logger.debug(f"Search service ping failed: {e}")
+        return False
+
+
 async def setup_search_info(
     search_service: str,
     index_name: str,
@@ -372,6 +386,23 @@ async def main(strategy: Strategy, setup_index: bool = True):
             search_key=clean_key_if_exists(args.searchkey),
         )
     )
+
+    # Check search service connectivity
+    search_service = os.environ["AZURE_SEARCH_SERVICE"]
+    is_connected = loop.run_until_complete(check_search_service_connectivity(search_service))
+
+    if not is_connected:
+        if os.getenv("AZURE_USE_PRIVATE_ENDPOINT"):
+            logger.error(
+                "Unable to connect to Azure AI Search service, which indicates either a network issue or a misconfiguration. You have AZURE_USE_PRIVATE_ENDPOINT enabled. Perhaps you're not yet connected to the VPN? Download the VPN configuration from the Azure portal here: %s",
+                os.getenv("AZURE_VPN_CONFIG_DOWNLOAD_LINK"),
+            )
+        else:
+            logger.error(
+                "Unable to connect to Azure AI Search service, which indicates either a network issue or a misconfiguration."
+            )
+        exit(1)
+
     blob_manager = setup_blob_manager(
         azure_credential=azd_credential,
         storage_account=os.environ["AZURE_STORAGE_ACCOUNT"],

docs/deploy_private.md

@@ -46,7 +46,7 @@ Deploying with public access disabled adds additional cost to your deployment. P
 
 ## Recommended deployment strategy for private access
 
-1. Deploy the app with private endpoints enabled, public network access disabled, and a VPN gateway configured. This will allow you to connect to the chat app from inside the virtual network.
+1. Configure the azd environment variables to use private endpoints and a VPN gateway, with public network access disabled. This will allow you to connect to the chat app from inside the virtual network, but not from the public Internet.
 
     ```shell
     azd env set AZURE_USE_PRIVATE_ENDPOINT true
@@ -55,19 +55,19 @@ Deploying with public access disabled adds additional cost to your deployment. P
     azd up
     ```
 
-2. First provision all the resources:
+2. Provision all the Azure resources:
 
     ```bash
     azd provision
     ```
 
-3. Once provisioning is complete, run this command to get the VPN configuration download link:
+3. Once provisioning is complete, you will see an error when it tries to run the data ingestion script, because you are not yet connected to the VPN. That message should provide a URL for the VPN configuration file download. If you don't see that URL, run this command:
 
     ```bash
     azd env get-value AZURE_VPN_CONFIG_DOWNLOAD_LINK
     ```
 
-    Select "Download VPN client" to download a ZIP file containing the VPN configuration.
+    Open that link in your browser. Select "Download VPN client" to download a ZIP file containing the VPN configuration.
 
 4. Open `AzureVPN/azurevpnconfig.xml`, and replace the `<clientconfig>` empty tag with the following:
 
@@ -79,17 +79,19 @@ Deploying with public access disabled adds additional cost to your deployment. P
       </clientconfig>
     ```
 
-5. Open the "Azure VPN" client and select "Import" button. Select the `azurevpnconfig.xml` file you just downloaded and modified.
+5. Install the [Azure VPN Client](https://learn.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-vpn-client-install).
 
-6. Select "Connect" and the new VPN connection. You will be prompted to select your Microsoft account and login.
+6. Open the "Azure VPN" client and select "Import" button. Select the `azurevpnconfig.xml` file you just downloaded and modified.
 
-7. Once you're successfully connected to VPN, you can run the data ingestion script:
+7. Select "Connect" and the new VPN connection. You will be prompted to select your Microsoft account and login.
+
+8. Once you're successfully connected to VPN, you can run the data ingestion script:
 
     ```bash
     azd hooks run postprovision
     ```
 
-8. Finally, you can deploy the app:
+9. Finally, you can deploy the app:
 
     ```bash
     azd deploy

todo.txt

@@ -1,4 +1,2 @@
-* Better error when youre trying to run prepdocs and not connected to VPN.
-   * Hit up /ping and check that it returns 200 OK. Anything else = no bueno.
-   * If they have AZURE_USE_PRIVATE_ENDPOINT and it gets non-200, reminds them to set up VPN.
+
 * Manually test App Service