Skip to content

docs: Add ClickHouse scaler documentation#1695

Open
krasnosvar wants to merge 1 commit intokedacore:mainfrom
krasnosvar:add-clickhouse-scaler-docs
Open

docs: Add ClickHouse scaler documentation#1695
krasnosvar wants to merge 1 commit intokedacore:mainfrom
krasnosvar:add-clickhouse-scaler-docs

Conversation

@krasnosvar
Copy link

Description

This PR adds documentation for the new ClickHouse scaler introduced in kedacore/keda#7404.

What does this PR do?

  • Adds documentation for the clickhouse scaler in version 2.19
  • Documents connection options (connection string and individual parameters)
  • Provides examples with TriggerAuthentication
  • Documents all metadata parameters and authentication options
  • Follows the same documentation pattern as PostgreSQL, MySQL, and MSSQL scalers

Documentation Added

  • Trigger Specification: Complete description of the clickhouse trigger
  • Connection Options: Both connection string and individual parameter configurations
  • Authentication Parameters: Connection string and password authentication methods
  • Examples: Multiple examples including TriggerAuthentication usage
  • Parameter Documentation: All metadata parameters with descriptions and defaults

Example Usage

The documentation includes examples for:

  • Using connection string from environment variable
  • Using individual connection parameters (host, port, username, password, database)
  • Using TriggerAuthentication with connection string
  • Using TriggerAuthentication with individual parameters

Checklist

  • Documentation follows the scaler documentation guidelines
  • Added to correct version (2.19 - unreleased)
  • All parameters documented with proper format
  • Examples provided for common use cases
  • Commits are signed with Developer Certificate of Origin (DCO)

Related

- Add documentation for ClickHouse scaler
- Include connection string and individual parameter options
- Add examples with TriggerAuthentication
- Document all metadata parameters and authentication options

Signed-off-by: krasnosvar <[email protected]>
@krasnosvar krasnosvar requested a review from a team as a code owner January 23, 2026 08:30
@github-actions
Copy link

Thank you for your contribution! 🙏 We will review your PR as soon as possible.

While you are waiting, make sure to:

  • Add your contribution to all applicable KEDA versions
  • GitHub checks are passing
  • Is the DCO check failing? Here is how you can fix DCO issues

Learn more about:

@netlify
Copy link

netlify bot commented Jan 23, 2026

Deploy Preview for keda ready!

Name Link
🔨 Latest commit b33e3fe
🔍 Latest deploy log https://app.netlify.com/projects/keda/deploys/6973318c53ea170008710e4d
😎 Deploy Preview https://deploy-preview-1695--keda.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant