Merge pull request #84 from Azure-Samples/add-entra-auth

Add entra auth

Author: pamelafox

.github/workflows/app-tests.yaml

@@ -3,8 +3,18 @@ name: App Tests
 on:
   push:
     branches: [ main ]
+    paths-ignore:
+      - "**.md"
+      - ".azdo/**"
+      - ".devcontainer/**"
+      - ".github/**"
   pull_request:
     branches: [ main ]
+    paths-ignore:
+      - "**.md"
+      - ".azdo/**"
+      - ".devcontainer/**"
+      - ".github/**"
   workflow_dispatch:
 
 permissions:

README.md

@@ -204,6 +204,7 @@ Further documentation is available in the `docs/` folder:
 * [Understanding the RAG flow](docs/rag_flow.md)
 * [Customizing the data](docs/customize_data.md)
 * [Deploying with existing resources](docs/deploy_existing.md)
+* [Using Entra auth with PostgreSQL tools](docs/using_entra_auth.md)
 * [Monitoring with Azure Monitor](docs/monitoring.md)
 * [Load testing](docs/loadtesting.md)
 

docs/using_entra_auth.md

@@ -0,0 +1,47 @@
+# Using Entra auth with PostgreSQL tools
+
+To follow security best practices, this project is setup to use passwordless authentication with the Azure Database for PostgreSQL Flexible Server. This means that you can't connect to the database with a password, but instead need to use a token associated with a Microsoft Entra user. Locally, the user should be your own Azure account, whichever account was used to run `azd up`. In production, the user will be the managed identity assigned to the Azure Container App.
+
+## Using psql with Entra auth
+
+1. Make sure you are logged into the Azure Developer CLI with the same account that was used to run `azd up`.
+
+    ```shell
+    azd auth login
+    ```
+
+    If you used a non-default tenant to run `azd up`, you may need to specify the tenant ID:
+
+    ```shell
+    azd auth login --tenant-id {tenant_id}
+    ```
+
+2. Generate a token for the Azure Database for PostgreSQL Flexible Server.
+
+    ```shell
+    azd auth token --scope https://ossrdbms-aad.database.windows.net/.default --output json
+    ```
+
+    Once again, if you used a non-default tenant to run `azd up`, you may need to specify the tenant ID.
+
+    ```shell
+    azd auth token --scope https://ossrdbms-aad.database.windows.net/.default --tenant-id YOUR-TENANT-ID --output json
+    ```
+
+    This will output JSON with a token inside the "token" field. Copy the token.
+
+3. Set the `PGPASSWORD` environment variable to the token.
+
+    ```shell
+    export PGPASSWORD={token}
+    ```
+
+    If you are using a different shell, you may need to use a different syntax to set the environment variable.
+
+4. Connect to the database with `psql`, using the `POSTGRES_HOST`, `POSTGRES_USERNAME`, and `POSTGRES_DATABASE` values from the current `azd` environment.
+
+    ```shell
+    psql -h $(azd env get-value POSTGRES_HOST) -U $(azd env get-value POSTGRES_USERNAME) -d $(azd env get-value POSTGRES_DATABASE) -p 5432
+    ```
+
+5. In psql, use `\d` to list the tables. When you `SELECT` from a table, select only the columns you're interested in, to avoid rendering the vector embeddings in the terminal.