For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configurations

Streambased K.S.I. is configured by the standard Kroxylicious configuration scheme here or by equivalent environment variables documented here:

Environment Variables

KSI_BOOTSTRAP_SERVERS

Bootstrap servers for the underlying Kafka cluster

  • Type: string

  • Example:

    KSI_BOOTSTRAP_SERVERS=kafka1:9092

KSI_GATEWAY_BOOTSTRAP_ADDRESS

The address that clients should connect to to access the proxy.

  • Type: string

  • Example:

    KSI_GATEWAY_BOOTSTRAP_ADDRESS=ksi:9192


KSI_COLD_STORAGE_TYPE

The method in which K.S.I. will interact with Iceberg, supported values are:

* spark-connect

* iceberg

  • Type: string

  • Example:


The Url of Spark-Connect, this should only be used when KSI_COLD_STORAGE_TYPE is spark-connect.

  • Type: string

  • Example:


The maximum number of Iceberg records to return for any signle FETCH response.

  • Type: integer

  • Example:


The maximum time K.S.I. will wait for records from Iceberg before returning to Kroxylicious

  • Type: integer

  • Example:


The type of Iceberg catalog used to provide coldset data. Vendor managed catalogs have different auth, metadata column renames etc. Supported types are: * default - Minio + Rest catalog with Sigv4 authentication * iceberg-rest-fixture - Minio + Rest Catalog implemented by Iceberg Rest Fixture - Sigv4 auth, requires metadata.json relocation on Coldset / Merged set proxying * tableflow - Confluent Tableflow with Confluent managed Iceberg Catalog and storage * snowflake - Snowflake managed Iceberg

  • Type: string

  • Example:

  • Environment Variable: ISK_COLDSET_CLIENT_COLDSET-TYPE


Iceberg namespace to use for Coldset

  • Type: string

  • Example:

  • Environment Variable: ISK_COLDSET_CLIENT_COLDSET-NS


Iceberg namespace to use for Coldset

  • Type: string

  • Example:

  • Environment Variable: ISK_COLDSET_CLIENT_COLDSET-NS

A Schema Registry REST endpoint Streambased I.S.K. can fetch topic schemas and metadata from.

  • Type: string

  • Example:

  • Importance: high

Configuration prefixes

The remaining configurations represent prefixes that are used to determine configurations for external services used by Streambased


A prefix used to pass Kafka connection configurations to Streambased I.S.K. This applies only when config.provider is set to properties and [name] is included in config.sources.

  • Example:

  • Environment Prefix: ISK_CONFIG_SOURCE_[name]_


Additional properties for connecting to an Iceberg provider for coldset data

  • Example:

  • Environment Prefix: ISK_CONFIG_SOURCE_[name]_

Last updated