From e495305bbc47a493230c6e4a6a96732b3dad3ea2 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Fri, 2 Dec 2022 11:04:16 +0100 Subject: [PATCH] docs(event-hubs): Provide authentication parameter for connection strings (#994) --- content/docs/2.0/scalers/azure-event-hub.md | 14 ++++++++++++- content/docs/2.1/scalers/azure-event-hub.md | 20 +++++++++++++++--- content/docs/2.2/scalers/azure-event-hub.md | 20 +++++++++++++++--- content/docs/2.3/scalers/azure-event-hub.md | 20 +++++++++++++++--- content/docs/2.4/scalers/azure-event-hub.md | 20 +++++++++++++++--- content/docs/2.5/scalers/azure-event-hub.md | 21 ++++++++++++++++--- content/docs/2.6/scalers/azure-event-hub.md | 21 ++++++++++++++++--- content/docs/2.7/scalers/azure-event-hub.md | 21 ++++++++++++++++--- content/docs/2.8/scalers/azure-event-hub.md | 21 ++++++++++++++++--- content/docs/2.9/scalers/azure-event-hub.md | 23 +++++++++++++++++---- 10 files changed, 172 insertions(+), 29 deletions(-) diff --git a/content/docs/2.0/scalers/azure-event-hub.md b/content/docs/2.0/scalers/azure-event-hub.md index ead252859fd..bd56c2b0756 100644 --- a/content/docs/2.0/scalers/azure-event-hub.md +++ b/content/docs/2.0/scalers/azure-event-hub.md @@ -34,7 +34,19 @@ triggers: ### Authentication Parameters -Not supported yet. +You can authenticate by using connection string authentication. + +**Connection String Authentication:** + +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. ### Example diff --git a/content/docs/2.1/scalers/azure-event-hub.md b/content/docs/2.1/scalers/azure-event-hub.md index 8d198e5a7b6..1e0d6c71ec5 100644 --- a/content/docs/2.1/scalers/azure-event-hub.md +++ b/content/docs/2.1/scalers/azure-event-hub.md @@ -34,11 +34,25 @@ triggers: ### Authentication Parameters -The common way of authenticating to Azure Event Hub is by using the connection string. However, you can use [Pod Identity](https://azure.github.io/aad-pod-identity/docs/demo/standard_walkthrough/) if you host your cluster in Azure AKS, and if have configured it to support Pod Identity. +You can authenticate by using pod identity or connection string authentication. -To use Pod Identity, you have to add a [TriggerAuthentication](../concepts/authentication.md#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so: +**Connection String Authentication:** -``` +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. + +**Pod identity based authentication:** + +[Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used. + +```yaml apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: diff --git a/content/docs/2.2/scalers/azure-event-hub.md b/content/docs/2.2/scalers/azure-event-hub.md index 8d198e5a7b6..1e0d6c71ec5 100644 --- a/content/docs/2.2/scalers/azure-event-hub.md +++ b/content/docs/2.2/scalers/azure-event-hub.md @@ -34,11 +34,25 @@ triggers: ### Authentication Parameters -The common way of authenticating to Azure Event Hub is by using the connection string. However, you can use [Pod Identity](https://azure.github.io/aad-pod-identity/docs/demo/standard_walkthrough/) if you host your cluster in Azure AKS, and if have configured it to support Pod Identity. +You can authenticate by using pod identity or connection string authentication. -To use Pod Identity, you have to add a [TriggerAuthentication](../concepts/authentication.md#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so: +**Connection String Authentication:** -``` +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. + +**Pod identity based authentication:** + +[Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used. + +```yaml apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: diff --git a/content/docs/2.3/scalers/azure-event-hub.md b/content/docs/2.3/scalers/azure-event-hub.md index 860281af285..f9ca88da1cf 100644 --- a/content/docs/2.3/scalers/azure-event-hub.md +++ b/content/docs/2.3/scalers/azure-event-hub.md @@ -40,11 +40,25 @@ triggers: ### Authentication Parameters -The common way of authenticating to Azure Event Hub is by using the connection string. However, you can use [Pod Identity](https://azure.github.io/aad-pod-identity/docs/demo/standard_walkthrough/) if you host your cluster in Azure AKS, and if have configured it to support Pod Identity. +You can authenticate by using pod identity or connection string authentication. -To use Pod Identity, you have to add a [TriggerAuthentication](../concepts/authentication.md#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so: +**Connection String Authentication:** -``` +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. + +**Pod identity based authentication:** + +[Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used. + +```yaml apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: diff --git a/content/docs/2.4/scalers/azure-event-hub.md b/content/docs/2.4/scalers/azure-event-hub.md index 860281af285..f9ca88da1cf 100644 --- a/content/docs/2.4/scalers/azure-event-hub.md +++ b/content/docs/2.4/scalers/azure-event-hub.md @@ -40,11 +40,25 @@ triggers: ### Authentication Parameters -The common way of authenticating to Azure Event Hub is by using the connection string. However, you can use [Pod Identity](https://azure.github.io/aad-pod-identity/docs/demo/standard_walkthrough/) if you host your cluster in Azure AKS, and if have configured it to support Pod Identity. +You can authenticate by using pod identity or connection string authentication. -To use Pod Identity, you have to add a [TriggerAuthentication](../concepts/authentication.md#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so: +**Connection String Authentication:** -``` +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. + +**Pod identity based authentication:** + +[Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used. + +```yaml apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: diff --git a/content/docs/2.5/scalers/azure-event-hub.md b/content/docs/2.5/scalers/azure-event-hub.md index 31c66b6459b..f9ca88da1cf 100644 --- a/content/docs/2.5/scalers/azure-event-hub.md +++ b/content/docs/2.5/scalers/azure-event-hub.md @@ -37,13 +37,28 @@ triggers: > 💡 Learn more about the checkpointing behaviour in this [section](#checkpointing-behaviour). > 💡 The Azure Storage connection string is not compatible with connection string created from a Shared Access Signature. + ### Authentication Parameters -The common way of authenticating to Azure Event Hub is by using the connection string. However, you can use [Pod Identity](https://azure.github.io/aad-pod-identity/docs/demo/standard_walkthrough/) if you host your cluster in Azure AKS, and if have configured it to support Pod Identity. +You can authenticate by using pod identity or connection string authentication. -To use Pod Identity, you have to add a [TriggerAuthentication](../concepts/authentication.md#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so: +**Connection String Authentication:** -``` +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. + +**Pod identity based authentication:** + +[Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used. + +```yaml apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: diff --git a/content/docs/2.6/scalers/azure-event-hub.md b/content/docs/2.6/scalers/azure-event-hub.md index 31c66b6459b..f9ca88da1cf 100644 --- a/content/docs/2.6/scalers/azure-event-hub.md +++ b/content/docs/2.6/scalers/azure-event-hub.md @@ -37,13 +37,28 @@ triggers: > 💡 Learn more about the checkpointing behaviour in this [section](#checkpointing-behaviour). > 💡 The Azure Storage connection string is not compatible with connection string created from a Shared Access Signature. + ### Authentication Parameters -The common way of authenticating to Azure Event Hub is by using the connection string. However, you can use [Pod Identity](https://azure.github.io/aad-pod-identity/docs/demo/standard_walkthrough/) if you host your cluster in Azure AKS, and if have configured it to support Pod Identity. +You can authenticate by using pod identity or connection string authentication. -To use Pod Identity, you have to add a [TriggerAuthentication](../concepts/authentication.md#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so: +**Connection String Authentication:** -``` +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. + +**Pod identity based authentication:** + +[Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used. + +```yaml apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: diff --git a/content/docs/2.7/scalers/azure-event-hub.md b/content/docs/2.7/scalers/azure-event-hub.md index db0fed24fe3..5986325d684 100644 --- a/content/docs/2.7/scalers/azure-event-hub.md +++ b/content/docs/2.7/scalers/azure-event-hub.md @@ -49,13 +49,28 @@ triggers: > 💡 Learn more about the checkpointing behaviour in this [section](#checkpointing-behaviour). > 💡 The Azure Storage connection string is not compatible with connection string created from a Shared Access Signature. + ### Authentication Parameters -The common way of authenticating to Azure Event Hub is by using the connection string. However, you can use [Pod Identity](https://azure.github.io/aad-pod-identity/docs/demo/standard_walkthrough/) if you host your cluster in Azure AKS, and if have configured it to support Pod Identity. +You can authenticate by using pod identity or connection string authentication. -To use Pod Identity, you have to add a [TriggerAuthentication](../concepts/authentication.md#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so: +**Connection String Authentication:** -``` +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. + +**Pod identity based authentication:** + +[Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used. + +```yaml apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: diff --git a/content/docs/2.8/scalers/azure-event-hub.md b/content/docs/2.8/scalers/azure-event-hub.md index 455c43b46af..d958c621cc4 100644 --- a/content/docs/2.8/scalers/azure-event-hub.md +++ b/content/docs/2.8/scalers/azure-event-hub.md @@ -51,13 +51,28 @@ triggers: > 💡 Learn more about the checkpointing behaviour in this [section](#checkpointing-behaviour). > 💡 The Azure Storage connection string is not compatible with connection string created from a Shared Access Signature. + ### Authentication Parameters -The common way of authenticating to Azure Event Hub is by using the connection string. However, you can use [Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers if you host your cluster in Azure AKS, and if have configured it to support Pod Identity. +You can authenticate by using pod identity or connection string authentication. -To use Pod Identity, you have to add a [TriggerAuthentication](../concepts/authentication.md#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so: +**Connection String Authentication:** -``` +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. + +**Pod identity based authentication:** + +[Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used. + +```yaml apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: diff --git a/content/docs/2.9/scalers/azure-event-hub.md b/content/docs/2.9/scalers/azure-event-hub.md index 5effc5b97be..7117cdf6cc9 100644 --- a/content/docs/2.9/scalers/azure-event-hub.md +++ b/content/docs/2.9/scalers/azure-event-hub.md @@ -61,13 +61,28 @@ triggers: > 💡 Learn more about the checkpointing behaviour in this [section](#checkpointing-behaviour). > 💡 The Azure Storage connection string is not compatible with connection string created from a Shared Access Signature. + ### Authentication Parameters -The common way of authenticating to Azure Event Hub is by using the connection string. However, you can use [Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers if you host your cluster in Azure AKS, and if have configured it to support Pod Identity. +You can authenticate by using pod identity or connection string authentication. -To use Pod Identity, you have to add a [TriggerAuthentication](../concepts/authentication.md#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so: +**Connection String Authentication:** -``` +- `connection` - Connection string for the Azure Event Hubs Namespace. + + The following formats are supported. + + - With **SharedAccessKey** - `Endpoint=sb://.servicebus.windows.net/;SharedAccessKeyName=;SharedAccessKey=;EntityPath=`. + +- `storageConnection` - Connection string for the Azure Storage Account used to store checkpoint information. + +> 💡 When providing `connection`, `EntityPath` is optional. If it is not provided, then `eventHubName` must be used to provide the name of the Azure Event Hub instance to use inside the namespace. + +**Pod identity based authentication:** + +[Azure AD Pod Identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) or [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used. + +```yaml apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: @@ -78,7 +93,7 @@ spec: provider: Azure | azure-workload ``` -When you do so, the Event Hub scaler will depend on the existence of two configurations you have to provide: `eventHubNamespace` and `eventHubName`. You can also configure `storageAccountName` if you wish to use Azure AD Pod / Workload Identity to authenticate to Azure Blob Storage instead of a connection string. +When you do so, the Event Hub scaler will depend on the existence of two configurations you have to provide: `eventHubNamespace` and `eventHubName`. You can also configure `storageAccountName` if you wish to use Azure AD Pod / Workload Identity to authenticate to Azure Blob Storage instead of a connection string. > 💡 When using Azure AD Pod Identity to authenticate the identity must have appropriate [RBAC role-assignments](https://docs.microsoft.com/azure/role-based-access-control/role-assignments-steps) for both Event Hub and Storage Account. Permissions covered by `Azure Event Hubs Data Receiver` and `Storage Blob Data Reader` are required.