Skip to content

Commit

Permalink
azure pod identity provider is not supported (#1479)
Browse files Browse the repository at this point in the history
Signed-off-by: Zbynek Roubalik <[email protected]>
  • Loading branch information
zroubalik authored Oct 3, 2024
1 parent ef1e5dd commit 159afa1
Show file tree
Hide file tree
Showing 26 changed files with 48 additions and 48 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The `cloud` parameter can be used to specify cloud environments besides `Azure P
azureKeyVault: # Optional.
vaultUri: {key-vault-address} # Required.
podIdentity: # Optional.
provider: azure | azure-workload # Required.
provider: azure-workload # Required.
identityId: <identity-id> # Optional
credentials: # Optional.
clientId: {azure-ad-client-id} # Required.
Expand Down
6 changes: 3 additions & 3 deletions content/docs/2.15/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,12 @@ spec:
serviceAccount: {path-to-service-account-file} # Optional.
secrets: # Required.
- parameter: {scaledObject-parameter-name} # Required.
key: {hashicorp-vault-secret-key-name} # Required.
path: {hashicorp-vault-secret-path} # Required.
key: {hashicorp-vault-secret-key-name} # Required.
path: {hashicorp-vault-secret-path} # Required.
azureKeyVault: # Optional.
vaultUri: {key-vault-address} # Required.
podIdentity: # Optional. Required when using pod identity.
provider: azure | azure-workload # Required.
provider: azure-workload # Required.
identityId: <identity-id> # Optional
credentials: # Optional. Required when not using pod identity.
clientId: {azure-ad-client-id} # Required.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.15/operate/cloud-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Here is an overview of the supported authentication types:
- `accessKey` - Access key string for the Azure Event Grid connection auth.

#### Pod identity based authentication
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

```yaml
apiVersion: keda.sh/v1alpha1
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/scalers/azure-app-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The principal will need `Monitoring Reader` access to query metrics from the App

**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 in place of credential based authentication. The following section contains an example of a `TriggerAuthentication` using pod identity.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used in place of credential based authentication. The following section contains an example of a `TriggerAuthentication` using pod identity.

### Example

Expand Down Expand Up @@ -112,7 +112,7 @@ spec:
key: tenantId
# or Pod Identity, kind: Secret is not required in case of pod Identity
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/scalers/azure-data-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The AD identity that will be used requires `DatabaseViewer` role to query metric

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Examples

Expand Down Expand Up @@ -144,7 +144,7 @@ metadata:
name: azure-data-explorer-trigger-auth
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ You can authenticate by using pod identity or connection string authentication.

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

```yaml
apiVersion: keda.sh/v1alpha1
Expand All @@ -90,7 +90,7 @@ metadata:
namespace: default
spec:
podIdentity:
provider: Azure | azure-workload
provider: 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.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/scalers/azure-log-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ You can use `TriggerAuthentication` CRD to configure the authentication by provi

You can use managed identity to request access token for Log Analytics API. The advantage of this approach is that there is no need to store secrets in Kubernetes. Read [more](https://docs.microsoft.com/en-us/azure/aks/use-managed-identity) about managed identities in Azure Kubernetes Service.

[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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Example

Expand Down Expand Up @@ -248,7 +248,7 @@ metadata:
namespace: kedaloganalytics
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/scalers/azure-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The user will need access to read data from the Azure resource.

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Example

Expand All @@ -100,7 +100,7 @@ spec:
key: activeDirectoryClientPassword
# or Pod Identity, kind: Secret is not required in case of pod Identity
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.15/scalers/azure-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ As an alternative to using environment variables, you can authenticate with Azur

**Pod Identity Authentication**

[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### How to determine your pool ID

Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/scalers/azure-service-bus.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ You can authenticate by using pod identity or connection string authentication.

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Example

Expand All @@ -82,7 +82,7 @@ metadata:
name: azure-servicebus-auth
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/scalers/azure-storage-blob.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can authenticate by using pod identity or connection string authentication.

**Pod Identity 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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

- `accountName` - Name of the Azure Storage Account.

Expand All @@ -69,7 +69,7 @@ metadata:
name: azure-blob-auth
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/scalers/azure-storage-queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ You can authenticate by using pod identity or connection string authentication.

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Example

Expand All @@ -57,7 +57,7 @@ metadata:
name: azure-queue-auth
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.15/scalers/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ To gain a better understanding of creating a Prometheus trigger for Amazon Manag
#### Azure Monitor Managed Service for Prometheus

Azure has a [managed service for Prometheus](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/prometheus-metrics-overview) and Prometheus scaler can be used to run prometheus query against that.
- [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 in `authenticationRef` - see later in example.
- [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used in `authenticationRef` - see later in example.
- `Monitoring Data Reader` role needs to be assigned to workload identity (or pod identity) on the `Azure Monitor Workspace`.
- No other auth (via `authModes`) can be provided with Azure Pod/Workload Identity Auth.
- Prometheus query endpoint can be retreived from [Azure Monitor Workspace](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/azure-monitor-workspace-overview) that was configured to ingest prometheus metrics.
Expand Down Expand Up @@ -406,7 +406,7 @@ metadata:
name: azure-managed-prometheus-trigger-auth
spec:
podIdentity:
provider: azure | azure-workload # use "azure" for pod identity and "azure-workload" for workload identity
provider: azure-workload
identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.
---
apiVersion: keda.sh/v1alpha1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The `cloud` parameter can be used to specify cloud environments besides `Azure P
azureKeyVault: # Optional.
vaultUri: {key-vault-address} # Required.
podIdentity: # Optional.
provider: azure | azure-workload # Required.
provider: azure-workload # Required.
identityId: <identity-id> # Optional
credentials: # Optional.
clientId: {azure-ad-client-id} # Required.
Expand Down
6 changes: 3 additions & 3 deletions content/docs/2.16/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,12 @@ spec:
serviceAccount: {path-to-service-account-file} # Optional.
secrets: # Required.
- parameter: {scaledObject-parameter-name} # Required.
key: {hashicorp-vault-secret-key-name} # Required.
path: {hashicorp-vault-secret-path} # Required.
key: {hashicorp-vault-secret-key-name} # Required.
path: {hashicorp-vault-secret-path} # Required.
azureKeyVault: # Optional.
vaultUri: {key-vault-address} # Required.
podIdentity: # Optional. Required when using pod identity.
provider: azure | azure-workload # Required.
provider: azure-workload # Required.
identityId: <identity-id> # Optional
credentials: # Optional. Required when not using pod identity.
clientId: {azure-ad-client-id} # Required.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.16/operate/cloud-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Here is an overview of the supported authentication types:
- `accessKey` - Access key string for the Azure Event Grid connection auth.

#### Pod identity based authentication
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

```yaml
apiVersion: keda.sh/v1alpha1
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.16/scalers/azure-app-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The principal will need `Monitoring Reader` access to query metrics from the App

**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 in place of credential based authentication. The following section contains an example of a `TriggerAuthentication` using pod identity.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used in place of credential based authentication. The following section contains an example of a `TriggerAuthentication` using pod identity.

### Example

Expand Down Expand Up @@ -112,7 +112,7 @@ spec:
key: tenantId
# or Pod Identity, kind: Secret is not required in case of pod Identity
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.16/scalers/azure-data-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The AD identity that will be used requires `DatabaseViewer` role to query metric

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Examples

Expand Down Expand Up @@ -144,7 +144,7 @@ metadata:
name: azure-data-explorer-trigger-auth
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.16/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ You can authenticate by using pod identity or connection string authentication.

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

```yaml
apiVersion: keda.sh/v1alpha1
Expand All @@ -90,7 +90,7 @@ metadata:
namespace: default
spec:
podIdentity:
provider: Azure | azure-workload
provider: 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.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.16/scalers/azure-log-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ You can use `TriggerAuthentication` CRD to configure the authentication by provi

You can use managed identity to request access token for Log Analytics API. The advantage of this approach is that there is no need to store secrets in Kubernetes. Read [more](https://docs.microsoft.com/en-us/azure/aks/use-managed-identity) about managed identities in Azure Kubernetes Service.

[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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Example

Expand Down Expand Up @@ -248,7 +248,7 @@ metadata:
namespace: kedaloganalytics
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.16/scalers/azure-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The user will need access to read data from the Azure resource.

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Example

Expand All @@ -100,7 +100,7 @@ spec:
key: activeDirectoryClientPassword
# or Pod Identity, kind: Secret is not required in case of pod Identity
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.16/scalers/azure-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ As an alternative to using environment variables, you can authenticate with Azur

**Pod Identity Authentication**

[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) providers can be used.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### How to determine your pool ID

Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.16/scalers/azure-service-bus.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ You can authenticate by using pod identity or connection string authentication.

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Example

Expand All @@ -82,7 +82,7 @@ metadata:
name: azure-servicebus-auth
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.16/scalers/azure-storage-blob.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can authenticate by using pod identity or connection string authentication.

**Pod Identity 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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

- `accountName` - Name of the Azure Storage Account.

Expand All @@ -69,7 +69,7 @@ metadata:
name: azure-blob-auth
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 2 additions & 2 deletions content/docs/2.16/scalers/azure-storage-queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ You can authenticate by using pod identity or connection string authentication.

**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.
[Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/) provider can be used.

### Example

Expand All @@ -57,7 +57,7 @@ metadata:
name: azure-queue-auth
spec:
podIdentity:
provider: azure | azure-workload
provider: azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
Loading

0 comments on commit 159afa1

Please sign in to comment.