From c0a496b49484eb1ab3fcc8bba4fec9f4a216728f Mon Sep 17 00:00:00 2001 From: Elias Keis <13063245+elKei24@users.noreply.github.com> Date: Fri, 24 Jan 2025 20:46:08 +0100 Subject: [PATCH 1/2] Update azure-event-hub.md for Dapr versions >= 1.10 (#1530) * Adapt azure-event-hub.md on 2.16 Signed-off-by: Elias Keis <13063245+elKei24@users.noreply.github.com> * adapt remaining versions Signed-off-by: Elias Keis <13063245+elKei24@users.noreply.github.com> --------- Signed-off-by: Elias Keis <13063245+elKei24@users.noreply.github.com> --- content/docs/2.10/scalers/azure-event-hub.md | 9 ++++++--- content/docs/2.11/scalers/azure-event-hub.md | 9 ++++++--- content/docs/2.12/scalers/azure-event-hub.md | 9 ++++++--- content/docs/2.13/scalers/azure-event-hub.md | 9 ++++++--- content/docs/2.14/scalers/azure-event-hub.md | 9 ++++++--- content/docs/2.15/scalers/azure-event-hub.md | 9 ++++++--- content/docs/2.16/scalers/azure-event-hub.md | 9 ++++++--- content/docs/2.17/scalers/azure-event-hub.md | 9 ++++++--- content/docs/2.9/scalers/azure-event-hub.md | 9 ++++++--- 9 files changed, 54 insertions(+), 27 deletions(-) diff --git a/content/docs/2.10/scalers/azure-event-hub.md b/content/docs/2.10/scalers/azure-event-hub.md index e19858754..05af9596c 100644 --- a/content/docs/2.10/scalers/azure-event-hub.md +++ b/content/docs/2.10/scalers/azure-event-hub.md @@ -51,9 +51,12 @@ triggers: - `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified. - `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs. - `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing. - - `dapr` - Suitable for Dapr pubsub and bindings, depending on the used Dapr version: - - pubsub components: >= Dapr 1.6 (older versions need the GoSdk checkpointer) - - binding components: >= Dapr 1.9 (older versions need the GoSdk checkpointer) + - `dapr` - Suitable for older Dapr pubsub and bindings + - Compatible Dapr versions: + - pubsub components: 1.6, 1.7, 1.8, 1.9 + - bindings: 1.9 + - For newer Dapr versions, use the `blobMetadata` strategy. + - For older Dapr versions, use the `goSdk` strategy. - When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required. - `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`, Optional) - `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`). diff --git a/content/docs/2.11/scalers/azure-event-hub.md b/content/docs/2.11/scalers/azure-event-hub.md index e19858754..05af9596c 100644 --- a/content/docs/2.11/scalers/azure-event-hub.md +++ b/content/docs/2.11/scalers/azure-event-hub.md @@ -51,9 +51,12 @@ triggers: - `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified. - `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs. - `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing. - - `dapr` - Suitable for Dapr pubsub and bindings, depending on the used Dapr version: - - pubsub components: >= Dapr 1.6 (older versions need the GoSdk checkpointer) - - binding components: >= Dapr 1.9 (older versions need the GoSdk checkpointer) + - `dapr` - Suitable for older Dapr pubsub and bindings + - Compatible Dapr versions: + - pubsub components: 1.6, 1.7, 1.8, 1.9 + - bindings: 1.9 + - For newer Dapr versions, use the `blobMetadata` strategy. + - For older Dapr versions, use the `goSdk` strategy. - When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required. - `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`, Optional) - `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`). diff --git a/content/docs/2.12/scalers/azure-event-hub.md b/content/docs/2.12/scalers/azure-event-hub.md index e19858754..05af9596c 100644 --- a/content/docs/2.12/scalers/azure-event-hub.md +++ b/content/docs/2.12/scalers/azure-event-hub.md @@ -51,9 +51,12 @@ triggers: - `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified. - `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs. - `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing. - - `dapr` - Suitable for Dapr pubsub and bindings, depending on the used Dapr version: - - pubsub components: >= Dapr 1.6 (older versions need the GoSdk checkpointer) - - binding components: >= Dapr 1.9 (older versions need the GoSdk checkpointer) + - `dapr` - Suitable for older Dapr pubsub and bindings + - Compatible Dapr versions: + - pubsub components: 1.6, 1.7, 1.8, 1.9 + - bindings: 1.9 + - For newer Dapr versions, use the `blobMetadata` strategy. + - For older Dapr versions, use the `goSdk` strategy. - When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required. - `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`, Optional) - `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`). diff --git a/content/docs/2.13/scalers/azure-event-hub.md b/content/docs/2.13/scalers/azure-event-hub.md index e19858754..05af9596c 100644 --- a/content/docs/2.13/scalers/azure-event-hub.md +++ b/content/docs/2.13/scalers/azure-event-hub.md @@ -51,9 +51,12 @@ triggers: - `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified. - `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs. - `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing. - - `dapr` - Suitable for Dapr pubsub and bindings, depending on the used Dapr version: - - pubsub components: >= Dapr 1.6 (older versions need the GoSdk checkpointer) - - binding components: >= Dapr 1.9 (older versions need the GoSdk checkpointer) + - `dapr` - Suitable for older Dapr pubsub and bindings + - Compatible Dapr versions: + - pubsub components: 1.6, 1.7, 1.8, 1.9 + - bindings: 1.9 + - For newer Dapr versions, use the `blobMetadata` strategy. + - For older Dapr versions, use the `goSdk` strategy. - When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required. - `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`, Optional) - `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`). diff --git a/content/docs/2.14/scalers/azure-event-hub.md b/content/docs/2.14/scalers/azure-event-hub.md index 54135b492..20755e9d7 100644 --- a/content/docs/2.14/scalers/azure-event-hub.md +++ b/content/docs/2.14/scalers/azure-event-hub.md @@ -52,9 +52,12 @@ triggers: - `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified. - `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs. - `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing. - - `dapr` - Suitable for Dapr pubsub and bindings, depending on the used Dapr version: - - pubsub components: >= Dapr 1.6 (older versions need the GoSdk checkpointer) - - binding components: >= Dapr 1.9 (older versions need the GoSdk checkpointer) + - `dapr` - Suitable for older Dapr pubsub and bindings + - Compatible Dapr versions: + - pubsub components: 1.6, 1.7, 1.8, 1.9 + - bindings: 1.9 + - For newer Dapr versions, use the `blobMetadata` strategy. + - For older Dapr versions, use the `goSdk` strategy. - When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required. - `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`, Optional) - `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`). diff --git a/content/docs/2.15/scalers/azure-event-hub.md b/content/docs/2.15/scalers/azure-event-hub.md index cb1601cf3..a1b5f375f 100644 --- a/content/docs/2.15/scalers/azure-event-hub.md +++ b/content/docs/2.15/scalers/azure-event-hub.md @@ -48,9 +48,12 @@ triggers: - `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified. - `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs. - `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing. - - `dapr` - Suitable for Dapr pubsub and bindings, depending on the used Dapr version: - - pubsub components: >= Dapr 1.6 (older versions need the GoSdk checkpointer) - - binding components: >= Dapr 1.9 (older versions need the GoSdk checkpointer) + - `dapr` - Suitable for older Dapr pubsub and bindings + - Compatible Dapr versions: + - pubsub components: 1.6, 1.7, 1.8, 1.9 + - bindings: 1.9 + - For newer Dapr versions, use the `blobMetadata` strategy. + - For older Dapr versions, use the `goSdk` strategy. - When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required. - `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`, Optional) - `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`). diff --git a/content/docs/2.16/scalers/azure-event-hub.md b/content/docs/2.16/scalers/azure-event-hub.md index cb1601cf3..a1b5f375f 100644 --- a/content/docs/2.16/scalers/azure-event-hub.md +++ b/content/docs/2.16/scalers/azure-event-hub.md @@ -48,9 +48,12 @@ triggers: - `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified. - `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs. - `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing. - - `dapr` - Suitable for Dapr pubsub and bindings, depending on the used Dapr version: - - pubsub components: >= Dapr 1.6 (older versions need the GoSdk checkpointer) - - binding components: >= Dapr 1.9 (older versions need the GoSdk checkpointer) + - `dapr` - Suitable for older Dapr pubsub and bindings + - Compatible Dapr versions: + - pubsub components: 1.6, 1.7, 1.8, 1.9 + - bindings: 1.9 + - For newer Dapr versions, use the `blobMetadata` strategy. + - For older Dapr versions, use the `goSdk` strategy. - When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required. - `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`, Optional) - `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`). diff --git a/content/docs/2.17/scalers/azure-event-hub.md b/content/docs/2.17/scalers/azure-event-hub.md index cb1601cf3..a1b5f375f 100644 --- a/content/docs/2.17/scalers/azure-event-hub.md +++ b/content/docs/2.17/scalers/azure-event-hub.md @@ -48,9 +48,12 @@ triggers: - `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified. - `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs. - `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing. - - `dapr` - Suitable for Dapr pubsub and bindings, depending on the used Dapr version: - - pubsub components: >= Dapr 1.6 (older versions need the GoSdk checkpointer) - - binding components: >= Dapr 1.9 (older versions need the GoSdk checkpointer) + - `dapr` - Suitable for older Dapr pubsub and bindings + - Compatible Dapr versions: + - pubsub components: 1.6, 1.7, 1.8, 1.9 + - bindings: 1.9 + - For newer Dapr versions, use the `blobMetadata` strategy. + - For older Dapr versions, use the `goSdk` strategy. - When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required. - `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`, Optional) - `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`). diff --git a/content/docs/2.9/scalers/azure-event-hub.md b/content/docs/2.9/scalers/azure-event-hub.md index e19858754..05af9596c 100644 --- a/content/docs/2.9/scalers/azure-event-hub.md +++ b/content/docs/2.9/scalers/azure-event-hub.md @@ -51,9 +51,12 @@ triggers: - `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified. - `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs. - `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing. - - `dapr` - Suitable for Dapr pubsub and bindings, depending on the used Dapr version: - - pubsub components: >= Dapr 1.6 (older versions need the GoSdk checkpointer) - - binding components: >= Dapr 1.9 (older versions need the GoSdk checkpointer) + - `dapr` - Suitable for older Dapr pubsub and bindings + - Compatible Dapr versions: + - pubsub components: 1.6, 1.7, 1.8, 1.9 + - bindings: 1.9 + - For newer Dapr versions, use the `blobMetadata` strategy. + - For older Dapr versions, use the `goSdk` strategy. - When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required. - `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`, Optional) - `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`). From 23e2d88efc06311dc62ab15b09fc403f3839c3d7 Mon Sep 17 00:00:00 2001 From: Dao Thanh Tung Date: Mon, 3 Feb 2025 23:12:21 +0000 Subject: [PATCH 2/2] Add `vhostName` to Auth Params RabbitMQ doc (#1525) Signed-off-by: dttung2905 --- content/docs/2.17/scalers/rabbitmq-queue.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/content/docs/2.17/scalers/rabbitmq-queue.md b/content/docs/2.17/scalers/rabbitmq-queue.md index e2cc20e20..31f4fbfe1 100644 --- a/content/docs/2.17/scalers/rabbitmq-queue.md +++ b/content/docs/2.17/scalers/rabbitmq-queue.md @@ -74,6 +74,7 @@ TriggerAuthentication CRD is used to connect and authenticate to RabbitMQ: > See the [RabbitMQ Ports](https://www.rabbitmq.com/networking.html#ports) section for more details on how to configure the ports. +- `vhostName` - Vhost to use for the connection, overrides any vhost set in the connection string from `host`/`hostFromEnv`. (Optional / Required if Azure AD Workload Identity authorization is used) **Username and Password based authentication:** This allows sensitive credentials to be stored and managed separately from the connection string. @@ -106,7 +107,8 @@ kind: Secret metadata: name: keda-rabbitmq-secret data: - host: # base64 encoded value of format amqp://guest:password@localhost:5672/vhost + host: # base64 encoded value of format amqp://guest:password@localhost:5672 + vhostName: vhost --- apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication @@ -118,6 +120,9 @@ spec: - parameter: host name: keda-rabbitmq-secret key: host + - parameter: vhostName + name: keda-rabbitmq-secret + key: vhostName --- apiVersion: keda.sh/v1alpha1 kind: ScaledObject