feat: Adding SDKDefault Authentication (#67)

promitor · Nov 27, 2024 · 9bcece1 · 9bcece1
1 parent dbe68c3
commit 9bcece1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/docs/resource-discovery/runtime-configuration.md b/docs/resource-discovery/runtime-configuration.md
@@ -17,7 +17,7 @@ Here is a complete example of the runtime YAML:
 
 ```yaml
 authentication:
-  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity.
+  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity, SdkDefault.
   mode: ServicePrincipal # Optional. Default: ServicePrincipal.
   identityId: xxxx-xxxx-xxxx # Optional.
 server:
@@ -41,15 +41,15 @@ telemetry:
 The Promitor runtime allows you to use various ways to authenticate to Azure:
 
 - `authentication.mode` - Defines authentication mode to use. Options are `ServicePrincipal`,
- `SystemAssignedManagedIdentity`, `UserAssignedManagedIdentity`. _(defaults to service principle)_
+ `SystemAssignedManagedIdentity`, `UserAssignedManagedIdentity`, `SdkDefault` . _(defaults to service principle)_
 - `authentication.identityId` - Id of the Azure AD entity to authenticate with when integrating with Microsoft Azure.
  Required when using `ServicePrincipal`.
 
 Example:
 
 ```yaml
 authentication:
-  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity.
+  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity, SdkDefault.
   mode: ServicePrincipal # Optional. Default: ServicePrincipal.
   identityId: xxxx-xxxx-xxxx # Optional.
 ```

diff --git a/docs/scraping/runtime-configuration.md b/docs/scraping/runtime-configuration.md
@@ -17,7 +17,7 @@ Here is a complete example of the runtime YAML:
 
 ```yaml
 authentication:
-  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity.
+  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity, SdkDefault.
   mode: ServicePrincipal # Optional. Default: ServicePrincipal.
   identityId: xxxx-xxxx-xxxx # Optional.
 server:
@@ -70,15 +70,15 @@ resourceDiscovery:
 The Promitor runtime allows you to use various ways to authenticate to Azure:
 
 - `authentication.mode` - Defines authentication mode to use. Options are `ServicePrincipal`,
- `SystemAssignedManagedIdentity`, `UserAssignedManagedIdentity`. _(defaults to service principle)_
+ `SystemAssignedManagedIdentity`, `UserAssignedManagedIdentity`, `SdkDefault`. _(defaults to service principle)_
 - `authentication.identityId` - Id of the Azure AD entity to authenticate with when integrating with Microsoft Azure.
  Required when using `ServicePrincipal`.
 
 Example:
 
 ```yaml
 authentication:
-  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity.
+  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity, SdkDefault.
   mode: ServicePrincipal # Optional. Default: ServicePrincipal.
   identityId: xxxx-xxxx-xxxx # Optional.
 ```

diff --git a/docs/security/azure-authentication.md b/docs/security/azure-authentication.md
@@ -37,7 +37,7 @@ The app key can also be read from a file by specifying the file's location:
 
 ```yaml
 authentication:
-  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity.
+  # Options are ServicePrincipal, SystemAssignedManagedIdentity, UserAssignedManagedIdentity, SdkDefault.
   mode: ServicePrincipal # Optional. Default: ServicePrincipal.
   identityid: # [app id]
   secretFilePath: # [the name of the folder containing the secret file]
@@ -53,6 +53,7 @@ When using Managed Identity, you can use one of the following scenarios:
 - **System-assigned Managed Identity** - Use the identity of the Azure resource on which it runs and let Azure handle
  the authentication.
 - **User-assigned Managed Identity** - Use a pre-created Azure AD identity but let Azure handle the authentication for you
+- **SdkDefault** - Use credentials from both Azure hosting environments and local development, letting [Azure manage authentication seamlessly](https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication/credential-chains?tabs=dac#defaultazurecredential-overview). 
 
 > ⚠ In order to use managed identity, your Kubernetes cluster must be hosted on Microsoft Azure to leverage this.