diff --git a/content/docs/2.10/authentication-providers/azure-ad-workload-identity.md b/content/docs/2.10/authentication-providers/azure-ad-workload-identity.md index 0ba258274..31a29da2d 100644 --- a/content/docs/2.10/authentication-providers/azure-ad-workload-identity.md +++ b/content/docs/2.10/authentication-providers/azure-ad-workload-identity.md @@ -22,8 +22,40 @@ following flags - 2. `--set podIdentity.azureWorkload.clientId={azure-ad-client-id}` 3. `--set podIdentity.azureWorkload.tenantId={azure-ad-tenant-id}` -You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. +You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. -Note, that you must "federate" the Azure AD Managed Identity (that the TriggerAuthentication `podIdentity.identityId` points to) with the 'subject' of the KEDA Operator service account. This will be similar to `system:serviceaccount:keda:keda-operator`. +## Considerations about Federations and Overrides +The concept of "overrides" can be somewhat confusing in certain scenarios, as it may not always be clear which service account needs to be federated with a specific Azure identity to ensure proper functionality. + +Let's clarify this with two examples: + +### Case 1 + +Imagine you have an identity for KEDA that has access to ServiceBus A, ServiceBus B, and ServiceBus C. Additionally, you have separate identities for various workloads, resulting in the following setup: + +- KEDA's identity with access to ServiceBus A, ServiceBus B, and ServiceBus C (the identity set during installation and not overridden). +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, KEDA's Managed Service Identity should only be federated with KEDA's service account. + +### Case 2 + +To avoid granting too many permissions to KEDA's identity, you have a KEDA identity without access to any Service Bus (perhaps unrelated, such as Key Vault). Similar to the previous scenario, you also have separate identities for your workloads: + +- KEDA's identity without access to any Service Bus. +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, you are overriding the default identity set during installation through the "TriggerAuthentication" option (`.spec.podIdentity.identityId`). Each "ScaledObject" now uses its own "TriggerAuthentication," with each specifying an override (Workload A's TriggerAuthentication sets the identityId for Workload A, Workload B's for Workload B, and so on). Consequently, you don't need to stack excessive permissions on KEDA's identity. However, in this scenario, KEDA's service account must be federated with all the identities it may attempt to assume: + +- TriggerAuthentications without overrides will use KEDA's identity (for tasks such as accessing the Key Vault). +- TriggerAuthentications with overrides will use the identity specified in the TriggerAuthentication (requiring KEDA's service account to be federated with them). + + +> Note, that you must "federate" the Azure AD Managed Identity (that the TriggerAuthentication `podIdentity.identityId` points to) with the 'subject' of the KEDA Operator service account. This will be similar to `system:serviceaccount:keda:keda-operator`. > 📝 The service account for the target deployment is not used here. + diff --git a/content/docs/2.11/authentication-providers/azure-ad-workload-identity.md b/content/docs/2.11/authentication-providers/azure-ad-workload-identity.md index 0ba258274..93e9d76f1 100644 --- a/content/docs/2.11/authentication-providers/azure-ad-workload-identity.md +++ b/content/docs/2.11/authentication-providers/azure-ad-workload-identity.md @@ -22,8 +22,39 @@ following flags - 2. `--set podIdentity.azureWorkload.clientId={azure-ad-client-id}` 3. `--set podIdentity.azureWorkload.tenantId={azure-ad-tenant-id}` -You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. +You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. -Note, that you must "federate" the Azure AD Managed Identity (that the TriggerAuthentication `podIdentity.identityId` points to) with the 'subject' of the KEDA Operator service account. This will be similar to `system:serviceaccount:keda:keda-operator`. +## Considerations about Federations and Overrides +The concept of "overrides" can be somewhat confusing in certain scenarios, as it may not always be clear which service account needs to be federated with a specific Azure identity to ensure proper functionality. + +Let's clarify this with two examples: + +### Case 1 + +Imagine you have an identity for KEDA that has access to ServiceBus A, ServiceBus B, and ServiceBus C. Additionally, you have separate identities for various workloads, resulting in the following setup: + +- KEDA's identity with access to ServiceBus A, ServiceBus B, and ServiceBus C (the identity set during installation and not overridden). +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, KEDA's Managed Service Identity should only be federated with KEDA's service account. + +### Case 2 + +To avoid granting too many permissions to KEDA's identity, you have a KEDA identity without access to any Service Bus (perhaps unrelated, such as Key Vault). Similar to the previous scenario, you also have separate identities for your workloads: + +- KEDA's identity without access to any Service Bus. +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, you are overriding the default identity set during installation through the "TriggerAuthentication" option (`.spec.podIdentity.identityId`). Each "ScaledObject" now uses its own "TriggerAuthentication," with each specifying an override (Workload A's TriggerAuthentication sets the identityId for Workload A, Workload B's for Workload B, and so on). Consequently, you don't need to stack excessive permissions on KEDA's identity. However, in this scenario, KEDA's service account must be federated with all the identities it may attempt to assume: + +- TriggerAuthentications without overrides will use KEDA's identity (for tasks such as accessing the Key Vault). +- TriggerAuthentications with overrides will use the identity specified in the TriggerAuthentication (requiring KEDA's service account to be federated with them). + +> Note, that you must "federate" the Azure AD Managed Identity (that the TriggerAuthentication `podIdentity.identityId` points to) with the 'subject' of the KEDA Operator service account. This will be similar to `system:serviceaccount:keda:keda-operator`. > 📝 The service account for the target deployment is not used here. + diff --git a/content/docs/2.12/authentication-providers/azure-ad-workload-identity.md b/content/docs/2.12/authentication-providers/azure-ad-workload-identity.md index 0ba258274..93e9d76f1 100644 --- a/content/docs/2.12/authentication-providers/azure-ad-workload-identity.md +++ b/content/docs/2.12/authentication-providers/azure-ad-workload-identity.md @@ -22,8 +22,39 @@ following flags - 2. `--set podIdentity.azureWorkload.clientId={azure-ad-client-id}` 3. `--set podIdentity.azureWorkload.tenantId={azure-ad-tenant-id}` -You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. +You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. -Note, that you must "federate" the Azure AD Managed Identity (that the TriggerAuthentication `podIdentity.identityId` points to) with the 'subject' of the KEDA Operator service account. This will be similar to `system:serviceaccount:keda:keda-operator`. +## Considerations about Federations and Overrides +The concept of "overrides" can be somewhat confusing in certain scenarios, as it may not always be clear which service account needs to be federated with a specific Azure identity to ensure proper functionality. + +Let's clarify this with two examples: + +### Case 1 + +Imagine you have an identity for KEDA that has access to ServiceBus A, ServiceBus B, and ServiceBus C. Additionally, you have separate identities for various workloads, resulting in the following setup: + +- KEDA's identity with access to ServiceBus A, ServiceBus B, and ServiceBus C (the identity set during installation and not overridden). +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, KEDA's Managed Service Identity should only be federated with KEDA's service account. + +### Case 2 + +To avoid granting too many permissions to KEDA's identity, you have a KEDA identity without access to any Service Bus (perhaps unrelated, such as Key Vault). Similar to the previous scenario, you also have separate identities for your workloads: + +- KEDA's identity without access to any Service Bus. +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, you are overriding the default identity set during installation through the "TriggerAuthentication" option (`.spec.podIdentity.identityId`). Each "ScaledObject" now uses its own "TriggerAuthentication," with each specifying an override (Workload A's TriggerAuthentication sets the identityId for Workload A, Workload B's for Workload B, and so on). Consequently, you don't need to stack excessive permissions on KEDA's identity. However, in this scenario, KEDA's service account must be federated with all the identities it may attempt to assume: + +- TriggerAuthentications without overrides will use KEDA's identity (for tasks such as accessing the Key Vault). +- TriggerAuthentications with overrides will use the identity specified in the TriggerAuthentication (requiring KEDA's service account to be federated with them). + +> Note, that you must "federate" the Azure AD Managed Identity (that the TriggerAuthentication `podIdentity.identityId` points to) with the 'subject' of the KEDA Operator service account. This will be similar to `system:serviceaccount:keda:keda-operator`. > 📝 The service account for the target deployment is not used here. + diff --git a/content/docs/2.13/authentication-providers/azure-ad-workload-identity.md b/content/docs/2.13/authentication-providers/azure-ad-workload-identity.md index 136f5531c..24e465d1f 100644 --- a/content/docs/2.13/authentication-providers/azure-ad-workload-identity.md +++ b/content/docs/2.13/authentication-providers/azure-ad-workload-identity.md @@ -23,3 +23,34 @@ following flags - 3. `--set podIdentity.azureWorkload.tenantId={azure-ad-tenant-id}` You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. + +## Considerations about Federations and Overrides + +The concept of "overrides" can be somewhat confusing in certain scenarios, as it may not always be clear which service account needs to be federated with a specific Azure identity to ensure proper functionality. + +Let's clarify this with two examples: + +### Case 1 + +Imagine you have an identity for KEDA that has access to ServiceBus A, ServiceBus B, and ServiceBus C. Additionally, you have separate identities for various workloads, resulting in the following setup: + +- KEDA's identity with access to ServiceBus A, ServiceBus B, and ServiceBus C (the identity set during installation and not overridden). +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, KEDA's Managed Service Identity should only be federated with KEDA's service account. + +### Case 2 + +To avoid granting too many permissions to KEDA's identity, you have a KEDA identity without access to any Service Bus (perhaps unrelated, such as Key Vault). Similar to the previous scenario, you also have separate identities for your workloads: + +- KEDA's identity without access to any Service Bus. +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, you are overriding the default identity set during installation through the "TriggerAuthentication" option (`.spec.podIdentity.identityId`). Each "ScaledObject" now uses its own "TriggerAuthentication," with each specifying an override (Workload A's TriggerAuthentication sets the identityId for Workload A, Workload B's for Workload B, and so on). Consequently, you don't need to stack excessive permissions on KEDA's identity. However, in this scenario, KEDA's service account must be federated with all the identities it may attempt to assume: + +- TriggerAuthentications without overrides will use KEDA's identity (for tasks such as accessing the Key Vault). +- TriggerAuthentications with overrides will use the identity specified in the TriggerAuthentication (requiring KEDA's service account to be federated with them). diff --git a/content/docs/2.8/authentication-providers/azure-ad-workload-identity.md b/content/docs/2.8/authentication-providers/azure-ad-workload-identity.md index 136f5531c..24e465d1f 100644 --- a/content/docs/2.8/authentication-providers/azure-ad-workload-identity.md +++ b/content/docs/2.8/authentication-providers/azure-ad-workload-identity.md @@ -23,3 +23,34 @@ following flags - 3. `--set podIdentity.azureWorkload.tenantId={azure-ad-tenant-id}` You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. + +## Considerations about Federations and Overrides + +The concept of "overrides" can be somewhat confusing in certain scenarios, as it may not always be clear which service account needs to be federated with a specific Azure identity to ensure proper functionality. + +Let's clarify this with two examples: + +### Case 1 + +Imagine you have an identity for KEDA that has access to ServiceBus A, ServiceBus B, and ServiceBus C. Additionally, you have separate identities for various workloads, resulting in the following setup: + +- KEDA's identity with access to ServiceBus A, ServiceBus B, and ServiceBus C (the identity set during installation and not overridden). +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, KEDA's Managed Service Identity should only be federated with KEDA's service account. + +### Case 2 + +To avoid granting too many permissions to KEDA's identity, you have a KEDA identity without access to any Service Bus (perhaps unrelated, such as Key Vault). Similar to the previous scenario, you also have separate identities for your workloads: + +- KEDA's identity without access to any Service Bus. +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, you are overriding the default identity set during installation through the "TriggerAuthentication" option (`.spec.podIdentity.identityId`). Each "ScaledObject" now uses its own "TriggerAuthentication," with each specifying an override (Workload A's TriggerAuthentication sets the identityId for Workload A, Workload B's for Workload B, and so on). Consequently, you don't need to stack excessive permissions on KEDA's identity. However, in this scenario, KEDA's service account must be federated with all the identities it may attempt to assume: + +- TriggerAuthentications without overrides will use KEDA's identity (for tasks such as accessing the Key Vault). +- TriggerAuthentications with overrides will use the identity specified in the TriggerAuthentication (requiring KEDA's service account to be federated with them). diff --git a/content/docs/2.9/authentication-providers/azure-ad-workload-identity.md b/content/docs/2.9/authentication-providers/azure-ad-workload-identity.md index 136f5531c..24e465d1f 100644 --- a/content/docs/2.9/authentication-providers/azure-ad-workload-identity.md +++ b/content/docs/2.9/authentication-providers/azure-ad-workload-identity.md @@ -23,3 +23,34 @@ following flags - 3. `--set podIdentity.azureWorkload.tenantId={azure-ad-tenant-id}` You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. + +## Considerations about Federations and Overrides + +The concept of "overrides" can be somewhat confusing in certain scenarios, as it may not always be clear which service account needs to be federated with a specific Azure identity to ensure proper functionality. + +Let's clarify this with two examples: + +### Case 1 + +Imagine you have an identity for KEDA that has access to ServiceBus A, ServiceBus B, and ServiceBus C. Additionally, you have separate identities for various workloads, resulting in the following setup: + +- KEDA's identity with access to ServiceBus A, ServiceBus B, and ServiceBus C (the identity set during installation and not overridden). +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, KEDA's Managed Service Identity should only be federated with KEDA's service account. + +### Case 2 + +To avoid granting too many permissions to KEDA's identity, you have a KEDA identity without access to any Service Bus (perhaps unrelated, such as Key Vault). Similar to the previous scenario, you also have separate identities for your workloads: + +- KEDA's identity without access to any Service Bus. +- Workload A's identity with access to Service Bus A. +- Workload B's identity with access to Service Bus B. +- Workload C's identity with access to Service Bus C. + +In this case, you are overriding the default identity set during installation through the "TriggerAuthentication" option (`.spec.podIdentity.identityId`). Each "ScaledObject" now uses its own "TriggerAuthentication," with each specifying an override (Workload A's TriggerAuthentication sets the identityId for Workload A, Workload B's for Workload B, and so on). Consequently, you don't need to stack excessive permissions on KEDA's identity. However, in this scenario, KEDA's service account must be federated with all the identities it may attempt to assume: + +- TriggerAuthentications without overrides will use KEDA's identity (for tasks such as accessing the Key Vault). +- TriggerAuthentications with overrides will use the identity specified in the TriggerAuthentication (requiring KEDA's service account to be federated with them).