Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Apache Kafka: Document FromEnv parameters #1312

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Apache Kafka: Document FromEnv parameters #1312

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions content/docs/2.13/scalers/apache-kafka.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,17 @@ partition will be scaled to zero. See the [discussion](https://github.com/kedaco
- `tls` - To enable SSL auth for Kafka, set this to `enable`. If not set, TLS for Kafka is not used. (Values: `enable`, `disable`, Default: `disable`, Optional). This parameter could also be specified in `tls` in TriggerAuthentication
- `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional)

*Parameters from Environment Variables*

You can access some of the above parameters using environment variables. When you specify the parameter in metadata with a suffix of `FromEnv`,
the scaler will use the value from the environment variable. The environment variable must be available to the manifest.
These take precedence over the direct parameters - `bootstrapServersFromEnv` will override `bootstrapServers`, for example.
If you have multiple containers you may need to specify the `envSourceContainerName` parameter in the `ScaledObject`'s `scaleTargetRef`.

- `bootstrapServersFromEnv` - The name of the environment variable listing the Kafka boostrap servers.
- `consumerGroup` - The name of the environment variable set with consumer group name.
- `topicFromEnv` - The name of the environment variable set with topic name.

> **Note:**
>
> When `topic` is unspecified, total offset lag will be calculated with all topics within the consumer group.
Expand Down
Loading