Skip to content

Commit

Permalink
Fix pod identity links in Azure docs. (#906)
Browse files Browse the repository at this point in the history
Signed-off-by: Vighnesh Shenoy <[email protected]>

Signed-off-by: Vighnesh Shenoy <[email protected]>
  • Loading branch information
v-shenoy authored Aug 21, 2022
1 parent 3c3ce0b commit 211900d
Show file tree
Hide file tree
Showing 23 changed files with 63 additions and 33 deletions.
2 changes: 1 addition & 1 deletion content/docs/2.1/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ triggers:

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.

To use Pod Identity, you have to add a [TriggerAuthentication](https://keda.sh/docs/2.0/concepts/authentication/#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so:
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:

```
apiVersion: keda.sh/v1alpha1
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.2/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ triggers:

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.

To use Pod Identity, you have to add a [TriggerAuthentication](https://keda.sh/docs/2.0/concepts/authentication/#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so:
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:

```
apiVersion: keda.sh/v1alpha1
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.3/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ triggers:

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.

To use Pod Identity, you have to add a [TriggerAuthentication](https://keda.sh/docs/2.0/concepts/authentication/#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so:
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:

```
apiVersion: keda.sh/v1alpha1
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.4/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ triggers:

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.

To use Pod Identity, you have to add a [TriggerAuthentication](https://keda.sh/docs/2.0/concepts/authentication/#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so:
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:

```
apiVersion: keda.sh/v1alpha1
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.5/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ triggers:

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.

To use Pod Identity, you have to add a [TriggerAuthentication](https://keda.sh/docs/2.0/concepts/authentication/#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so:
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:

```
apiVersion: keda.sh/v1alpha1
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.6/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ triggers:

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.

To use Pod Identity, you have to add a [TriggerAuthentication](https://keda.sh/docs/2.0/concepts/authentication/#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so:
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:

```
apiVersion: keda.sh/v1alpha1
Expand Down
2 changes: 1 addition & 1 deletion content/docs/2.7/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ triggers:

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.

To use Pod Identity, you have to add a [TriggerAuthentication](https://keda.sh/docs/2.0/concepts/authentication/#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so:
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:

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

**Pod identity based authentication:**

[Azure Active Directory pod-managed identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) can be used
in place of credential based authentication. The following section contains an example of a `TriggerAuthentication` using pod identity.
[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.

### Example

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

**Pod identity based authentication:**

[Azure Active Directory pod-managed identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) can be used.
[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.

### Examples

Expand Down Expand Up @@ -145,7 +145,7 @@ metadata:
name: azure-data-explorer-trigger-auth
spec:
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
6 changes: 3 additions & 3 deletions content/docs/2.8/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ triggers:
> 💡 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.
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.

To use Pod Identity, you have to add a [TriggerAuthentication](https://keda.sh/docs/2.0/concepts/authentication/#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so:
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:

```
apiVersion: keda.sh/v1alpha1
Expand All @@ -65,7 +65,7 @@ metadata:
namespace: default
spec:
podIdentity:
provider: Azure
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`.
Expand Down
4 changes: 3 additions & 1 deletion content/docs/2.8/scalers/azure-log-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,8 @@ Example result:

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.

### Example

#### Service Principal based authentication
Expand Down Expand Up @@ -242,7 +244,7 @@ metadata:
namespace: kedaloganalytics
spec:
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
6 changes: 5 additions & 1 deletion content/docs/2.8/scalers/azure-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ You can use `TriggerAuthentication` CRD to configure the authentication by provi

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.

### Example

```yaml
Expand All @@ -95,7 +99,7 @@ spec:
key: activeDirectoryClientPassword
# or Pod Identity, kind: Secret is not required in case of pod Identity
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
6 changes: 5 additions & 1 deletion content/docs/2.8/scalers/azure-service-bus.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ You can authenticate by using pod identity or connection string authentication.

- `connection` - Connection string for Azure Service Bus 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.

### Example

Here is an example of how to use managed identity:
Expand All @@ -66,7 +70,7 @@ metadata:
name: azure-servicebus-auth
spec:
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 3 additions & 1 deletion content/docs/2.8/scalers/azure-storage-blob.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ 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.

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

### Example
Expand All @@ -67,7 +69,7 @@ metadata:
name: azure-blob-auth
spec:
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
6 changes: 5 additions & 1 deletion content/docs/2.8/scalers/azure-storage-queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ You can authenticate by using pod identity or connection string authentication.

- `connection` - Connection string for Azure Storage Account.

**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.

### Example

```yaml
Expand All @@ -50,7 +54,7 @@ metadata:
name: azure-queue-auth
spec:
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
5 changes: 2 additions & 3 deletions content/docs/2.9/scalers/azure-app-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,7 @@ The principal will need `Monitoring Reader` access to query metrics from the App

**Pod identity based authentication:**

[Azure Active Directory pod-managed identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) can be used
in place of credential based authentication. The following section contains an example of a `TriggerAuthentication` using pod identity.
[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.

### Example

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

**Pod identity based authentication:**

[Azure Active Directory pod-managed identity](https://docs.microsoft.com/en-us/azure/aks/use-azure-ad-pod-identity) can be used.
[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.

### Examples

Expand Down Expand Up @@ -145,7 +145,7 @@ metadata:
name: azure-data-explorer-trigger-auth
spec:
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
6 changes: 3 additions & 3 deletions content/docs/2.9/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ triggers:
> 💡 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.
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.

To use Pod Identity, you have to add a [TriggerAuthentication](https://keda.sh/docs/2.0/concepts/authentication/#re-use-credentials-and-delegate-auth-with-triggerauthentication) and configure it to use Pod Identity like so:
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:

```
apiVersion: keda.sh/v1alpha1
Expand All @@ -65,7 +65,7 @@ metadata:
namespace: default
spec:
podIdentity:
provider: Azure
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`.
Expand Down
4 changes: 3 additions & 1 deletion content/docs/2.9/scalers/azure-log-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,8 @@ Example result:

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.

### Example

#### Service Principal based authentication
Expand Down Expand Up @@ -242,7 +244,7 @@ metadata:
namespace: kedaloganalytics
spec:
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
6 changes: 5 additions & 1 deletion content/docs/2.9/scalers/azure-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ You can use `TriggerAuthentication` CRD to configure the authentication by provi

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.

### Example

```yaml
Expand All @@ -95,7 +99,7 @@ spec:
key: activeDirectoryClientPassword
# or Pod Identity, kind: Secret is not required in case of pod Identity
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
6 changes: 5 additions & 1 deletion content/docs/2.9/scalers/azure-service-bus.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ You can authenticate by using pod identity or connection string authentication.

- `connection` - Connection string for Azure Service Bus 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.

### Example

Here is an example of how to use managed identity:
Expand All @@ -66,7 +70,7 @@ metadata:
name: azure-servicebus-auth
spec:
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
4 changes: 3 additions & 1 deletion content/docs/2.9/scalers/azure-storage-blob.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ 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.

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

### Example
Expand All @@ -67,7 +69,7 @@ metadata:
name: azure-blob-auth
spec:
podIdentity:
provider: azure
provider: azure | azure-workload
---
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
Expand Down
6 changes: 5 additions & 1 deletion content/docs/2.9/scalers/azure-storage-queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ You can authenticate by using pod identity or connection string authentication.

- `connection` - Connection string for Azure Storage Account.

**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.

### Example

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

0 comments on commit 211900d

Please sign in to comment.