Skip to content

Commit

Permalink
Update eventhub scaler docs with information for non public clouds. (#…
Browse files Browse the repository at this point in the history
…719)

Signed-off-by: Vighnesh Shenoy <vshenoy@microsoft.com>
  • Loading branch information
v-shenoy authored Mar 22, 2022
1 parent 7550dc0 commit beed31f
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions content/docs/2.7/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,29 @@ triggers:
consumerGroup: $Default
unprocessedEventThreshold: '64'
blobContainer: 'name_of_container'
# Optional (Default: AzurePublicCloud)
cloud: private
# Required when cloud = Private
endpointSuffix: servicebus.airgap.example
# Required when cloud = Private.
activeDirectoryEndpoint: https://login.airgap.example/
```
**Parameter list:**
- `connectionFromEnv` - Name of the environment variable your deployment uses to get the connection string appended with `EntityPath=<event_hub_name>`.
- `storageConnectionFromEnv` - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
- `consumerGroup` - Consumer group of Azure Event Hub consumer. (default: `$default`)
- `consumerGroup` - Consumer group of Azure Event Hub consumer. (default: `$default`, Optional)
- `unprocessedEventThreshold` - Average target value to trigger scaling actions. (Default: `64`, Optional)
- `blobContainer` - Container name to store checkpoint. This is needed for every `checkpointStrategy` except of `AzureFunction`. With Azure Functions the `blobContainer` is autogenerated and cannot be overridden.
- `checkpointStrategy` - configure the checkpoint behaviour of different Event Hub SDKs. (default: `""`)
- `checkpointStrategy` - configure the checkpoint behaviour of different Event Hub SDKs. (Values: `azureFunction`, `blobMetadata`, `goSdk`, default: `""`, Optional)
- `azureFunction` - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified.
- `blobMetadata` - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- `goSdk` - For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing, for example Dapr.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required.
- `cloud` - Name of the cloud environment that the Event Hub belongs to. (Values: `AzurePublicCloud`, `AzureUSGovernmentCloud`, `AzureChinaCloud`, `AzureGermanCloud`, `Private`, Default: `AzurePublicCloud`)
- `endpointSuffix` - Service Bus endpoint suffix of the cloud environment. (Required when `cloud` is set to `private`, e.g. `servicebus.cloudapi.de` for `AzureGermanCloud`).
- `activeDirectoryEndpoint` - Active Directory endpoint of the cloud environment. (Required when `cloud` is set to `private`, e.g. `https://login.microsoftonline.de/` for `AzureGermanCloud`).

> 💡 Learn more about the checkpointing behaviour in this [section](#checkpointing-behaviour).

Expand Down

0 comments on commit beed31f

Please sign in to comment.