chore: Update docs to reflect changes in eventhub after the SDK migration #1313
Conversation
…tion Signed-off-by: Jorge Turrado <jorge_turrado@hotmail.es>
✅ Deploy Preview for keda ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Thank you for your contribution! 🙏 We will review your PR as soon as possible.
Learn more about:
|
| # Required when cloud = Private. | ||
| activeDirectoryEndpoint: https://login.airgap.example/ | ||
| # Required when cloud = Private. | ||
| eventHubResourceURL: https://eventhubs.airgap.example/ |
There was a problem hiding this comment.
So how do they configure this then?
There was a problem hiding this comment.
New SDK gets the ENV var AZURE_AUTHORITY_HOST in the configuration chain (although we can provide it explicitly) for activeDirectoryEndpoint and that var is provided by workload identity webhook during the mutating process. Maybe I'm wrong at any point, but that's what I've understood reading the code
For the eventHubResourceURL there are 2 ways:
- It's explicitly provided by connection string
- it's generated by
eventHubNamespace+endpointSuffix
There was a problem hiding this comment.
Should we document it that way then?
There was a problem hiding this comment.
IDK, I'd say that it's something internal, I mean, you have to set them if you are using private cloud with msi, so I think that it's implicit
There was a problem hiding this comment.
Do they have it documented? If so, let's mention it and point to their docs.
Our end-users don't know our underlying tech (and should not) but should at least know where to configure it
There was a problem hiding this comment.
This picture if from their docs:
Is it enough?
There was a problem hiding this comment.
There was a problem hiding this comment.
Where would you like to include the reference? I don't get where it can match, as it's part of pod identity itself 🤷
| @@ -58,8 +54,6 @@ triggers: | |||
| - `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`). | |||
| - `storageEndpointSuffix` - Blob Storage endpoint of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `airgap.example`. Do not include the `blob` part of the endpoint.) | |||
| - `activeDirectoryEndpoint` - Active Directory endpoint of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `https://login.microsoftonline.de/` for `AzureGermanCloud`). | |||
| - `eventHubResourceURL` - Event Hub resource URL of the cloud environment. (Required when `cloud` is set to `Private`, e.g. `https://eventhubs.azure.net/` for known Azure Clouds). | |||
|
|
|||
| > 💡 Learn more about the checkpointing behaviour in this [section](#checkpointing-behaviour). | |||
There was a problem hiding this comment.
Let's add a pointer here to look at the workload identity trigger auth docs maybe?
Signed-off-by: Jorge Turrado <jorge_turrado@hotmail.es>
Checklist
Fixes #