From dbb360a5000885e43cd9168e2bd452c4639c5e0a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 30 Jul 2024 15:57:03 +0000 Subject: [PATCH] chore(updater): bump pkg/dist/*.yml (2024-07-29) (#170) Co-authored-by: GitHub --- pkg/dist/integration_types.yml | 12 +++ pkg/dist/service_types.yml | 135 +++++++++++++++++++++------------ 2 files changed, 100 insertions(+), 47 deletions(-) diff --git a/pkg/dist/integration_types.yml b/pkg/dist/integration_types.yml index 18f105e..7aaf637 100644 --- a/pkg/dist/integration_types.yml +++ b/pkg/dist/integration_types.yml @@ -132,6 +132,13 @@ clickhouse_kafka: minimum: 0 maximum: 1e+09 example: "10000" + poll_max_timeout_ms: + title: Timeout in milliseconds for a single poll from Kafka. Takes the value of the stream_flush_interval_ms server setting by default (500ms). + type: integer + default: "0" + minimum: 0 + maximum: 30000 + example: "1000" skip_broken_messages: title: Skip at least this number of broken messages from Kafka topic per block type: integer @@ -139,6 +146,11 @@ clickhouse_kafka: minimum: 0 maximum: 1e+09 example: "10000" + thread_per_consumer: + title: Provide an independent thread for each consumer. All consumers run in the same thread by default. + type: boolean + default: false + example: true topics: title: Kafka topics type: array diff --git a/pkg/dist/service_types.yml b/pkg/dist/service_types.yml index 474d353..048ec5f 100644 --- a/pkg/dist/service_types.yml +++ b/pkg/dist/service_types.yml @@ -368,6 +368,11 @@ dragonfly: type: string max_length: 2048 example: db1,db2 + ignore_roles: + title: Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment) + type: string + max_length: 2048 + example: role1,role2 method: title: The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types) type: string @@ -1975,6 +1980,15 @@ kafka: - "null" max_length: 255 example: grafana.example.org + follower_fetching: + title: Enable follower fetching + type: object + properties: + enabled: + title: Enabled + description: Whether to enable the follower fetching functionality + type: boolean + example: true ip_filter: title: IP filter description: Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16' @@ -2009,12 +2023,12 @@ kafka: properties: auto_create_topics_enable: title: auto.create.topics.enable - description: Enable auto creation of topics + description: 'Enable auto-creation of topics. (Default: true)' type: boolean example: true compression_type: title: compression.type - description: Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer. + description: 'Specify the final compression type for a given topic. This configuration accepts the standard compression codecs (''gzip'', ''snappy'', ''lz4'', ''zstd''). It additionally accepts ''uncompressed'' which is equivalent to no compression; and ''producer'' which means retain the original compression codec set by the producer.(Default: producer)' type: string enum: - value: gzip @@ -2025,65 +2039,65 @@ kafka: - value: producer connections_max_idle_ms: title: connections.max.idle.ms - description: 'Idle connections timeout: the server socket processor threads close the connections that idle for longer than this.' + description: 'Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. (Default: 600000 ms (10 minutes))' type: integer minimum: 1000 maximum: 3.6e+06 example: "540000" default_replication_factor: title: default.replication.factor - description: Replication factor for autocreated topics + description: 'Replication factor for auto-created topics (Default: 3)' type: integer minimum: 1 maximum: 10 group_initial_rebalance_delay_ms: title: group.initial.rebalance.delay.ms - description: The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. + description: 'The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. (Default: 3000 ms (3 seconds))' type: integer minimum: 0 maximum: 300000 example: "3000" group_max_session_timeout_ms: title: group.max.session.timeout.ms - description: The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. + description: 'The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. Default: 1800000 ms (30 minutes)' type: integer minimum: 0 maximum: 1.8e+06 example: "1800000" group_min_session_timeout_ms: title: group.min.session.timeout.ms - description: The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. + description: 'The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. (Default: 6000 ms (6 seconds))' type: integer minimum: 0 maximum: 60000 example: "6000" log_cleaner_delete_retention_ms: title: log.cleaner.delete.retention.ms - description: How long are delete records retained? + description: 'How long are delete records retained? (Default: 86400000 (1 day))' type: integer minimum: 0 maximum: 3.1556926e+11 example: "86400000" log_cleaner_max_compaction_lag_ms: title: log.cleaner.max.compaction.lag.ms - description: The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted + description: 'The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted. (Default: 9223372036854775807 ms (Long.MAX_VALUE))' type: integer minimum: 30000 log_cleaner_min_cleanable_ratio: title: log.cleaner.min.cleanable.ratio - description: Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. + description: 'Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. (Default: 0.5)' type: number minimum: 0.2 maximum: 0.9 example: "0.5" log_cleaner_min_compaction_lag_ms: title: log.cleaner.min.compaction.lag.ms - description: The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. + description: 'The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. (Default: 0 ms)' type: integer minimum: 0 log_cleanup_policy: title: log.cleanup.policy - description: The default cleanup policy for segments beyond the retention window + description: 'The default cleanup policy for segments beyond the retention window (Default: delete)' type: string enum: - value: delete @@ -2092,202 +2106,202 @@ kafka: example: delete log_flush_interval_messages: title: log.flush.interval.messages - description: The number of messages accumulated on a log partition before messages are flushed to disk + description: 'The number of messages accumulated on a log partition before messages are flushed to disk (Default: 9223372036854775807 (Long.MAX_VALUE))' type: integer minimum: 1 example: "9223372036854775807" log_flush_interval_ms: title: log.flush.interval.ms - description: The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used + description: 'The maximum time in ms that a message in any topic is kept in memory (page-cache) before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used (Default: null)' type: integer minimum: 0 log_index_interval_bytes: title: log.index.interval.bytes - description: The interval with which Kafka adds an entry to the offset index + description: 'The interval with which Kafka adds an entry to the offset index (Default: 4096 bytes (4 kibibytes))' type: integer minimum: 0 maximum: 1.048576e+08 example: "4096" log_index_size_max_bytes: title: log.index.size.max.bytes - description: The maximum size in bytes of the offset index + description: 'The maximum size in bytes of the offset index (Default: 10485760 (10 mebibytes))' type: integer minimum: 1.048576e+06 maximum: 1.048576e+08 example: "10485760" log_local_retention_bytes: title: log.local.retention.bytes - description: 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. + description: '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. (Default: -2)' type: integer minimum: -2 log_local_retention_ms: title: log.local.retention.ms - description: 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. + description: '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. (Default: -2)' type: integer minimum: -2 log_message_downconversion_enable: title: log.message.downconversion.enable - description: 'This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. ' + description: 'This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. (Default: true)' type: boolean example: true log_message_timestamp_difference_max_ms: title: log.message.timestamp.difference.max.ms - description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message + description: 'The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message (Default: 9223372036854775807 (Long.MAX_VALUE))' type: integer minimum: 0 log_message_timestamp_type: title: log.message.timestamp.type - description: Define whether the timestamp in the message is message create time or log append time. + description: 'Define whether the timestamp in the message is message create time or log append time. (Default: CreateTime)' type: string enum: - value: CreateTime - value: LogAppendTime log_preallocate: title: log.preallocate - description: Should pre allocate file when create new segment? + description: 'Should pre allocate file when create new segment? (Default: false)' type: boolean example: false log_retention_bytes: title: log.retention.bytes - description: The maximum size of the log before deleting messages + description: 'The maximum size of the log before deleting messages (Default: -1)' type: integer minimum: -1 log_retention_hours: title: log.retention.hours - description: The number of hours to keep a log file before deleting it + description: 'The number of hours to keep a log file before deleting it (Default: 168 hours (1 week))' type: integer minimum: -1 maximum: 2.147483647e+09 log_retention_ms: title: log.retention.ms - description: The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. + description: 'The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. (Default: null, log.retention.hours applies)' type: integer minimum: -1 log_roll_jitter_ms: title: log.roll.jitter.ms - description: The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used + description: 'The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used (Default: null)' type: integer minimum: 0 log_roll_ms: title: log.roll.ms - description: The maximum time before a new log segment is rolled out (in milliseconds). + description: 'The maximum time before a new log segment is rolled out (in milliseconds). (Default: null, log.roll.hours applies (Default: 168, 7 days))' type: integer minimum: 1 log_segment_bytes: title: log.segment.bytes - description: The maximum size of a single log file + description: 'The maximum size of a single log file (Default: 1073741824 bytes (1 gibibyte))' type: integer minimum: 1.048576e+07 maximum: 1.073741824e+09 log_segment_delete_delay_ms: title: log.segment.delete.delay.ms - description: The amount of time to wait before deleting a file from the filesystem + description: 'The amount of time to wait before deleting a file from the filesystem (Default: 60000 ms (1 minute))' type: integer minimum: 0 maximum: 3.6e+06 example: "60000" max_connections_per_ip: title: max.connections.per.ip - description: The maximum number of connections allowed from each ip address (defaults to 2147483647). + description: 'The maximum number of connections allowed from each ip address (Default: 2147483647).' type: integer minimum: 256 maximum: 2.147483647e+09 max_incremental_fetch_session_cache_slots: title: max.incremental.fetch.session.cache.slots - description: The maximum number of incremental fetch sessions that the broker will maintain. + description: 'The maximum number of incremental fetch sessions that the broker will maintain. (Default: 1000)' type: integer minimum: 1000 maximum: 10000 example: "1000" message_max_bytes: title: message.max.bytes - description: The maximum size of message that the server can receive. + description: 'The maximum size of message that the server can receive. (Default: 1048588 bytes (1 mebibyte + 12 bytes))' type: integer minimum: 0 maximum: 1.000012e+08 example: "1048588" min_insync_replicas: title: min.insync.replicas - description: When a producer sets acks to 'all' (or '-1'), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. + description: 'When a producer sets acks to ''all'' (or ''-1''), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. (Default: 1)' type: integer minimum: 1 maximum: 7 example: "1" num_partitions: title: num.partitions - description: Number of partitions for autocreated topics + description: 'Number of partitions for auto-created topics (Default: 1)' type: integer minimum: 1 maximum: 1000 offsets_retention_minutes: title: offsets.retention.minutes - description: Log retention window in minutes for offsets topic + description: 'Log retention window in minutes for offsets topic (Default: 10080 minutes (7 days))' type: integer minimum: 1 maximum: 2.147483647e+09 example: "10080" producer_purgatory_purge_interval_requests: title: producer.purgatory.purge.interval.requests - description: The purge interval (in number of requests) of the producer request purgatory(defaults to 1000). + description: 'The purge interval (in number of requests) of the producer request purgatory (Default: 1000).' type: integer minimum: 10 maximum: 10000 replica_fetch_max_bytes: title: replica.fetch.max.bytes - description: The number of bytes of messages to attempt to fetch for each partition (defaults to 1048576). This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. + description: 'The number of bytes of messages to attempt to fetch for each partition . This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. (Default: 1048576 bytes (1 mebibytes))' type: integer minimum: 1.048576e+06 maximum: 1.048576e+08 replica_fetch_response_max_bytes: title: replica.fetch.response.max.bytes - description: Maximum bytes expected for the entire fetch response (defaults to 10485760). Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. + description: 'Maximum bytes expected for the entire fetch response. Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. (Default: 10485760 bytes (10 mebibytes))' type: integer minimum: 1.048576e+07 maximum: 1.048576e+09 sasl_oauthbearer_expected_audience: title: sasl.oauthbearer.expected.audience - description: The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. + description: 'The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. (Default: null)' type: string max_length: 128 pattern: ^[^\r\n]*$ sasl_oauthbearer_expected_issuer: title: sasl.oauthbearer.expected.issuer - description: Optional setting for the broker to use to verify that the JWT was created by the expected issuer. + description: 'Optional setting for the broker to use to verify that the JWT was created by the expected issuer.(Default: null)' type: string max_length: 128 pattern: ^[^\r\n]*$ sasl_oauthbearer_jwks_endpoint_url: title: sasl.oauthbearer.jwks.endpoint.url - description: 'OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. ' + description: 'OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. (Default: null)' type: string max_length: 2048 sasl_oauthbearer_sub_claim_name: title: sasl.oauthbearer.sub.claim.name - description: Name of the scope from which to extract the subject claim from the JWT. Defaults to sub. + description: 'Name of the scope from which to extract the subject claim from the JWT.(Default: sub)' type: string max_length: 128 - pattern: ^[^\r\n]*$ + pattern: ^[^\r\n]*\S[^\r\n]*$ socket_request_max_bytes: title: socket.request.max.bytes - description: The maximum number of bytes in a socket request (defaults to 104857600). + description: 'The maximum number of bytes in a socket request (Default: 104857600 bytes).' type: integer minimum: 1.048576e+07 maximum: 2.097152e+08 transaction_partition_verification_enable: title: transaction.partition.verification.enable - description: Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition + description: 'Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition. (Default: false)' type: boolean example: true transaction_remove_expired_transaction_cleanup_interval_ms: title: transaction.remove.expired.transaction.cleanup.interval.ms - description: The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)). + description: 'The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (Default: 3600000 ms (1 hour)).' type: integer minimum: 600000 maximum: 3.6e+06 example: "3600000" transaction_state_log_segment_bytes: title: transaction.state.log.segment.bytes - description: The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (defaults to 104857600 (100 mebibytes)). + description: 'The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (Default: 104857600 bytes (100 mebibytes)).' type: integer minimum: 1.048576e+06 maximum: 2.147483647e+09 @@ -3719,6 +3733,11 @@ mysql: type: string max_length: 2048 example: db1,db2 + ignore_roles: + title: Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment) + type: string + max_length: 2048 + example: role1,role2 method: title: The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types) type: string @@ -4960,6 +4979,11 @@ pg: type: string max_length: 2048 example: db1,db2 + ignore_roles: + title: Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment) + type: string + max_length: 2048 + example: role1,role2 method: title: The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types) type: string @@ -5575,6 +5599,13 @@ pg: example: - extra_float_digits - search_path + max_prepared_statements: + title: PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements defaults to 100, and its maximum is 3000. + type: integer + default: "100" + minimum: 0 + maximum: 3000 + example: "100" min_pool_size: title: Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size. type: integer @@ -5808,6 +5839,11 @@ redis: type: string max_length: 2048 example: db1,db2 + ignore_roles: + title: Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment) + type: string + max_length: 2048 + example: role1,role2 method: title: The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types) type: string @@ -6181,6 +6217,11 @@ valkey: type: string max_length: 2048 example: db1,db2 + ignore_roles: + title: Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment) + type: string + max_length: 2048 + example: role1,role2 method: title: The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types) type: string