Merge branch 'main' into add-grafana-dashboard-docs

Signed-off-by: Dario Mader <9934402+darox@users.noreply.github.com>

README.md

@@ -100,7 +100,7 @@ Make sure to update the following metadata fields:
 * `description`
 
 ## Writing documentation for a new authentication provider
-To add documentation for a new [provider](https://keda.sh/docs/concept/authentication):
+To add documentation for a new [provider](https://keda.sh/docs/concepts/authentication):
 
 ```console
 $ hugo new --kind provider docs/<VERSION>/providers/my-new-provider.md

config.toml

@@ -403,6 +403,10 @@ logo = "grafana.png"
 url = "https://github.com/hmcts/"
 logo = "hmcts.png"
 
+[[params.users]]
+url = "https://intension.de"
+logo = "intension.png"
+
 [[params.users]]
 url = "https://www.intercept.cloud"
 logo = "intercept.png"
@@ -475,6 +479,10 @@ logo = "swisslife.jpg"
 url = "https://www.teamleader.eu"
 logo = "teamleader.png"
 
+[[params.users]]
+url = "https://vitc.gmbh"
+logo = "vitc.png"
+
 [[params.users]]
 url = "https://www.workiva.com"
 logo = "workiva.png"

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://<sb>.servicebus.windows.net/;SharedAccessKeyName=<key name>;SharedAccessKey=<key value>;EntityPath=<hub-name>`.
+
+- `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
 

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://<sb>.servicebus.windows.net/;SharedAccessKeyName=<key name>;SharedAccessKey=<key value>;EntityPath=<hub-name>`.
+
+- `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:

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://<sb>.servicebus.windows.net/;SharedAccessKeyName=<key name>;SharedAccessKey=<key value>;EntityPath=<hub-name>`.
+
+- `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:

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://<sb>.servicebus.windows.net/;SharedAccessKeyName=<key name>;SharedAccessKey=<key value>;EntityPath=<hub-name>`.
+
+- `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:

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://<sb>.servicebus.windows.net/;SharedAccessKeyName=<key name>;SharedAccessKey=<key value>;EntityPath=<hub-name>`.
+
+- `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:

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://<sb>.servicebus.windows.net/;SharedAccessKeyName=<key name>;SharedAccessKey=<key value>;EntityPath=<hub-name>`.
+
+- `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:

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://<sb>.servicebus.windows.net/;SharedAccessKeyName=<key name>;SharedAccessKey=<key value>;EntityPath=<hub-name>`.
+
+- `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:

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://<sb>.servicebus.windows.net/;SharedAccessKeyName=<key name>;SharedAccessKey=<key value>;EntityPath=<hub-name>`.
+
+- `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:

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://<sb>.servicebus.windows.net/;SharedAccessKeyName=<key name>;SharedAccessKey=<key value>;EntityPath=<hub-name>`.
+
+- `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:

content/docs/2.9/concepts/external-scalers.md

@@ -19,7 +19,7 @@ Since external scalers mirror the interface of built-in scalers, it's worth beco
 
 ```go
 type Scaler interface {
-	GetMetrics(ctx context.Context, metricName string, metricSelector labels.Selector) ([]external_metrics.ExternalMetricValue, error)
+	GetMetrics(ctx context.Context, metricName string) ([]external_metrics.ExternalMetricValue, error)
 	GetMetricSpecForScaling() []v2beta2.MetricSpec
 	IsActive(ctx context.Context) (bool, error)
 	Close() error

content/docs/2.9/operate/prometheus.md

@@ -6,15 +6,21 @@ weight = 200
 
 ## Prometheus Exporter Metrics
 
-### Operator
+### KEDA Operator 
 
 The KEDA Operator exposes Prometheus metrics which can be scraped on port `8080` at `/metrics`. The following metrics are being gathered:
 
-- `keda_operator_resource_totals` - Total number of KEDA custom resources per namespace for each custom resource type (CRD).
-- `keda_operator_trigger_totals` - Total number of triggers per trigger type.
+- `keda_scaler_metrics_value`- The current value for each scaler's metric that would be used by the HPA in computing the target average.
+- `keda_scaler_errors` - The number of errors that have occurred for each scaler.
+- `keda_scaler_error_totals` - The total number of errors encountered for all scalers.
+- `keda_scaled_object_error_totals`- The number of errors that have occurred for each ScaledObejct.
+- `keda_resource_totals` - Total number of KEDA custom resources per namespace for each custom resource type (CRD).
+- `keda_trigger_totals` - Total number of triggers per trigger type.
 - Metrics exposed by the `Operator SDK` framework as explained [here](https://sdk.operatorframework.io/docs/building-operators/golang/advanced-topics/#metrics).
 
-### Metrics Adapter
+### Metrics Server
+
+> 💡 **DEPRECATED:** Prometheus Metrics exposed from Metrics Server are deprecated, please consume metrics from KEDA Operator.
 
 The KEDA Metrics Adapter exposes Prometheus metrics which can be scraped on port `9022` (this can be changed by setting the `metrics-port` argument for the Metrics Adapter) at `/metrics`. The metrics collected in the Metrics Adapter are only active when the HPA is active (> 0 replicas).