Skip to content

Commit

Permalink
Kafka - Update Advanced parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
Hemant-Mulchandani authored Nov 28, 2023
1 parent 8c5f233 commit 071fc1a
Showing 1 changed file with 132 additions and 0 deletions.
132 changes: 132 additions & 0 deletions includes/config-kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,36 @@

**Allow access to selected service ports from private networks**

``kafka``
~~~~~~~~~
*boolean*

**Allow clients to connect to kafka with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**

``kafka_connect``
~~~~~~~~~~~~~~~~~
*boolean*

**Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**

``kafka_rest``
~~~~~~~~~~~~~~
*boolean*

**Allow clients to connect to kafka_rest with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**

``prometheus``
~~~~~~~~~~~~~~
*boolean*

**Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**

``schema_registry``
~~~~~~~~~~~~~~~~~~~
*boolean*

**Allow clients to connect to schema_registry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations**



``public_access``
Expand Down Expand Up @@ -235,6 +259,18 @@

**log.index.size.max.bytes** The maximum size in bytes of the offset index

``log_local_retention_ms``
~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**log.local.retention.ms** The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value.

``log_local_retention_bytes``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**log.local.retention.bytes** The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value.

``log_message_downconversion_enable``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*boolean*
Expand Down Expand Up @@ -349,6 +385,30 @@

**producer.purgatory.purge.interval.requests** The purge interval (in number of requests) of the producer request purgatory(defaults to 1000).

``sasl_oauthbearer_expected_audience``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*string*

**sasl.oauthbearer.expected.audience** The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences.

``sasl_oauthbearer_expected_issuer``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*string*

**sasl.oauthbearer.expected.issuer** Optional setting for the broker to use to verify that the JWT was created by the expected issuer.

``sasl_oauthbearer_jwks_endpoint_url``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*string*

**sasl.oauthbearer.jwks.endpoint.url** OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC.

``sasl_oauthbearer_sub_claim_name``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*string*

**sasl.oauthbearer.sub.claim.name** Name of the scope from which to extract the subject claim from the JWT. Defaults to sub.

``socket_request_max_bytes``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*
Expand All @@ -367,6 +427,12 @@

**transaction.remove.expired.transaction.cleanup.interval.ms** The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)).

``transaction_partition_verification_enable``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*boolean*

**transaction.partition.verification.enable** Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition



``kafka_authentication_methods``
Expand Down Expand Up @@ -457,18 +523,42 @@

**Offset flush timeout** Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).

``producer_batch_size``
~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**The batch size in bytes the producer will attempt to collect for the same partition before publishing to broker** This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will 'linger' for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).

``producer_buffer_memory``
~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**The total bytes of memory the producer can use to buffer records waiting to be sent to the broker** The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).

``producer_compression_type``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*string*

**The default compression type for producers** Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.

``producer_linger_ms``
~~~~~~~~~~~~~~~~~~~~~~
*integer*

**Wait for up to the given delay to allow batching records together** This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will 'linger' for the specified time waiting for more records to show up. Defaults to 0.

``producer_max_request_size``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**The maximum size of a request in bytes** This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests.

``scheduled_rebalance_max_delay_ms``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**The maximum delay of rebalancing connector workers** The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.

``session_timeout_ms``
~~~~~~~~~~~~~~~~~~~~~~
*integer*
Expand Down Expand Up @@ -501,6 +591,14 @@



``kafka_rest_authorization``
----------------------------
*boolean*

**Enable authorization in Kafka-REST service**



``kafka_rest_config``
---------------------
*object*
Expand All @@ -513,12 +611,24 @@

**producer.acks** The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set to 'all' or '-1', the leader will wait for the full set of in-sync replicas to acknowledge the record.

``producer_compression_type``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*string*

**producer.compression.type** Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.

``producer_linger_ms``
~~~~~~~~~~~~~~~~~~~~~~
*integer*

**producer.linger.ms** Wait for up to the given delay to allow batching records together

``producer_max_request_size``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*integer*

**producer.max.request.size** The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size.

``consumer_enable_auto_commit``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*boolean*
Expand All @@ -545,6 +655,20 @@



``tiered_storage``
------------------
*object*

**Tiered storage configuration**

``enabled``
~~~~~~~~~~~
*boolean*

**Enabled** Whether to enable the tiered storage functionality



``schema_registry_config``
--------------------------
*object*
Expand All @@ -565,3 +689,11 @@



``aiven_kafka_topic_messages``
------------------------------
*boolean*

**Allow access to read Kafka topic messages in the Aiven Console and REST API.**



0 comments on commit 071fc1a

Please sign in to comment.