Changing Axual Configurations
Configuration Options
The installation guide gives a step-by-step guide of preparing the initial Axual configuration. The goal of this page is to specify how to make configuration changes in the Axual Platform.
Certificates
Please view the Certificates Page.
Broker/Zookeeper (Strimzi)
The default configuration is for one broker and one zookeeper instance please read the Strimzi page for information on add a new broker.
Again please reference the Strimzi page for information on setting broker properties
|
false |
Enable auto creation of topic on the server Type: boolean Default: true Valid Values: Importance: high Update Mode: read-only |
|
false |
Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss Type: boolean Default: false Valid Values: Importance: high Update Mode: cluster-wide |
|
16 |
The number of threads to use for various background processing tasks Type: int Default: 10 Valid Values: [1,…] Importance: high Update Mode: cluster-wide |
|
4 |
Number of fetcher threads used to replicate messages from a source broker. Increasing this value can increase the degree of I/O parallelism in the follower broker. Type: int Default: 1 Valid Values: Importance: high Update Mode: cluster-wide |
|
20000 |
If a follower hasn’t sent any fetch requests or hasn’t consumed up to the leaders log end offset for at least this time, the leader will remove the follower from isr Type: long Default: 30000 (30 seconds) Valid Values: Importance: high Update Mode: read-only |
|
1000012 |
The maximum amount of data per-partition the server will return. Records are fetched in batches by the consumer. If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). See fetch.max.bytes for limiting the consumer request size. Type: int Default: 1048576 (1 mebibyte) Valid Values: [0,…] Importance: high |
|
1048576 |
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. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). Type: int Default: 1048576 (1 mebibyte) Valid Values: [0,…] Importance: medium Update Mode: read-only |
|
65536 |
The socket receive buffer for network requests Type: int Default: 65536 (64 kibibytes) Valid Values: Importance: high Update Mode: read-only |
|
20160 |
After a consumer group loses all its consumers (i.e. becomes empty) its offsets will be kept for this retention period before getting discarded. For standalone consumers (using manual assignment), offsets will be expired after the time of last commit plus this retention period. Type: int Default: 10080 Valid Values: [1,…] Importance: high Update Mode: read-only |
|
1 |
The replication factor for the offsets topic (set higher to ensure availability). Internal topic creation will fail until the cluster size meets this replication factor requirement. Type: short Default: 3 Valid Values: [1,…] Importance: high Update Mode: read-only |
|
1 |
The replication factor for the transaction topic (set higher to ensure availability). Internal topic creation will fail until the cluster size meets this replication factor requirement. Type: short Default: 3 Valid Values: [1,…] Importance: high Update Mode: read-only |
|
1 |
Overridden min.insync.replicas config for the transaction topic. Type: int Default: 2 Valid Values: [1,…] Importance: high Update Mode: read-only |
|
3 |
The number of partitions for the transaction topic (should not change after deployment). Type: int Default: 50 Valid Values: [1,…] Importance: high Update Mode: read-only |
|
- |
The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted. Type: long Default: 9223372036854775807 Valid Values: Importance: medium Update Mode: cluster-wide |
Instances/Tenants (Self Service)
Generally each customer installation consist of one tenant. (The customer.) Each customer installation generally consists of multiple Instances. Generally each customer will create instances for a test environment and production environment.
Instances are created within the Self Service Application. The customer can configure base Topic/Stream settings inside of the Instance to be defaulted in the creation of each Topic/Stream within the Instance. Please reference the Stream Configuration on this page to view possible settings.
For each instance the customer can also decide on the type of security to use. They can choose between SSL (certificates), SASL or both. This configuration option exists at the Instance Level.
On createing a Stream/Topic the user can override the default instance settings.
Axual Connect
Each Connect Application contains its own set of Properties to be setup. You will need to reference each Connector for information on how to setup the Connect Application. To view the Connect Settings, go to the Connect Application and in the middle of the page click the cog on the connector application graphic.
There do exist base configuration settings shared by most connectors.
|
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the keys in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. Type: class Default: Valid Values: Importance: high |
|
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. Type: class Default: Valid Values: Importance: high |
|
HeaderConverter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the header values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. By default, the SimpleHeaderConverter is used to serialize header values to strings and deserialize them by inferring the schemas. Type: class Default: org.apache.kafka.connect.storage.SimpleHeaderConverter Valid Values: Importance: low |
Sink Connector Settings
|
Globally unique name to use for this connector. Type: string Default: Valid Values: non-empty string without ISO control characters Importance: high |
|
Maximum number of tasks to use for this connector. Type: int Default: 1 Valid Values: [1,…] Importance: high |
|
List of topics to consume, separated by commas Type: list Default: "" Valid Values: Importance: high |
|
Regular expression giving topics to consume. Under the hood, the regex is compiled to a java.util.regex.Pattern. Only one of topics or topics.regex should be specified. Type: string Default: "" Valid Values: valid regex Importance: high |
|
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the keys in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. Type: class Default: null Valid Values: Importance: low |
|
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. Type: class Default: null Valid Values: Importance: low |
|
HeaderConverter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the header values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. By default, the SimpleHeaderConverter is used to serialize header values to strings and deserialize them by inferring the schemas. Type: class Default: null Valid Values: Importance: low |
|
The action that Connect should take on the connector when changes in external configuration providers result in a change in the connector’s configuration properties. A value of 'none' indicates that Connect will do nothing. A value of 'restart' indicates that Connect should restart/reload the connector with the updated configuration properties.The restart may actually be scheduled in the future if the external configuration provider indicates that a configuration value will expire in the future. Type: string Default: restart Valid Values: [none, restart] Importance: low |
|
Aliases for the transformations to be applied to records. Type: list Default: "" Valid Values: non-null string, unique transformation aliases Importance: low predicates Aliases for the predicates used by transformations. Type: list Default: "" Valid Values: non-null string, unique predicate aliases Importance: low |
|
The maximum duration in milliseconds that a failed operation will be reattempted. The default is 0, which means no retries will be attempted. Use -1 for infinite retries. Type: long Default: 0 Valid Values: Importance: medium |
|
The maximum duration in milliseconds between consecutive retry attempts. Jitter will be added to the delay once this limit is reached to prevent thundering herd issues. Type: long Default: 60000 (1 minute) Valid Values: Importance: medium |
|
Behavior for tolerating errors during connector operation. 'none' is the default value and signals that any error will result in an immediate connector task failure; 'all' changes the behavior to skip over problematic records. Type: string Default: none Valid Values: [none, all] Importance: medium |
|
If true, write each error and the details of the failed operation and problematic record to the Connect application log. This is 'false' by default, so that only errors that are not tolerated are reported. Type: boolean Default: false Valid Values: Importance: medium |
|
Whether to the include in the log the Connect record that resulted in a failure. This is 'false' by default, which will prevent record keys, values, and headers from being written to log files, although some information such as topic and partition number will still be logged. Type: boolean Default: false Valid Values: Importance: medium |
|
The name of the topic to be used as the dead letter queue (DLQ) for messages that result in an error when processed by this sink connector, or its transformations or converters. The topic name is blank by default, which means that no messages are to be recorded in the DLQ. Type: string Default: "" Valid Values: Importance: medium |
|
Replication factor used to create the dead letter queue topic when it doesn’t already exist. Type: short Default: 3 Valid Values: Importance: medium |
|
If true, add headers containing error context to the messages written to the dead letter queue. To avoid clashing with headers from the original record, all error context header keys, all error context header keys will start with __connect.errors. Type: boolean Default: false Valid Values: Importance: medium |
Source Connector Settings
|
Globally unique name to use for this connector. Type: string Default: Valid Values: non-empty string without ISO control characters Importance: high connector.class Name or alias of the class for this connector. Must be a subclass of org.apache.kafka.connect.connector.Connector. If the connector is org.apache.kafka.connect.file.FileStreamSinkConnector, you can either specify this full name, or use "FileStreamSink" or "FileStreamSinkConnector" to make the configuration a bit shorter Type: string Default: Valid Values: Importance: high |
|
Maximum number of tasks to use for this connector. Type: int Default: 1 Valid Values: [1,…] Importance: high |
|
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the keys in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. Type: class Default: null Valid Values: Importance: low |
|
Converter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. Type: class Default: null Valid Values: Importance: low |
|
HeaderConverter class used to convert between Kafka Connect format and the serialized form that is written to Kafka. This controls the format of the header values in messages written to or read from Kafka, and since this is independent of connectors it allows any connector to work with any serialization format. Examples of common formats include JSON and Avro. By default, the SimpleHeaderConverter is used to serialize header values to strings and deserialize them by inferring the schemas. Type: class Default: null Valid Values: Importance: low |
|
The action that Connect should take on the connector when changes in external configuration providers result in a change in the connector’s configuration properties. A value of 'none' indicates that Connect will do nothing. A value of 'restart' indicates that Connect should restart/reload the connector with the updated configuration properties.The restart may actually be scheduled in the future if the external configuration provider indicates that a configuration value will expire in the future. Type: string Default: restart Valid Values: [none, restart] Importance: low |
|
Aliases for the transformations to be applied to records. Type: list Default: "" Valid Values: non-null string, unique transformation aliases Importance: low predicates Aliases for the predicates used by transformations. Type: list Default: "" Valid Values: non-null string, unique predicate aliases Importance: low |
|
The maximum duration in milliseconds that a failed operation will be reattempted. The default is 0, which means no retries will be attempted. Use -1 for infinite retries. Type: long Default: 0 Valid Values: Importance: medium |
|
The maximum duration in milliseconds between consecutive retry attempts. Jitter will be added to the delay once this limit is reached to prevent thundering herd issues. Type: long Default: 60000 (1 minute) Valid Values: Importance: medium |
|
Behavior for tolerating errors during connector operation. 'none' is the default value and signals that any error will result in an immediate connector task failure; 'all' changes the behavior to skip over problematic records. Type: string Default: none Valid Values: [none, all] Importance: medium |
|
If true, write each error and the details of the failed operation and problematic record to the Connect application log. This is 'false' by default, so that only errors that are not tolerated are reported. Type: boolean Default: false Valid Values: Importance: medium |
|
Whether to the include in the log the Connect record that resulted in a failure. This is 'false' by default, which will prevent record keys, values, and headers from being written to log files, although some information such as topic and partition number will still be logged. Type: boolean Default: false Valid Values: Importance: medium |
|
Groups of configurations for topics created by source connectors Type: list Default: "" Valid Values: non-null string, unique topic creation groups Importance: low |
Please reference the Axual-Connect operator documentation for additional instructions.
Security - Keycloak.
The Helm installation guide describes how to setup Keycloak for the first time, with an initial tenant. Users log into the Axual system give the authentication defined in the Keycload User Realm. It is advisable to configure Keycloak to forward authentication requests to the companys authentication server. This process is called User Federation. (This is often Active Directory.) Please follow the Keycloak documentation when doing this.
Stream Settings
Stream properties are set inside Self Service page. After creating a stream, hover your mouse over the Stream graphic and click on Configure. On the first confugration you are prompted to give a retention time (milliseconds) and number of partitions. The number of partition can only be changed the first time that a stream is configured. At any time the retention time can be changed. Also, extra settings can be added manually. Below is a list of settings that can be added/modified.
The topic type - cleanup.policy is set when you create the stream:
A string that is either "delete" or "compact" or both. This string designates the retention policy to use on old log segments. The default policy ("delete") will discard old segments when their retention time or size limit has been reached. The "compact" setting will enable log compaction on the topic.Please note the importance of the setting, max.compaction.lag.ms with regards to removing old/duplicate enries from a stream.
|
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. Type: string Default: producer Valid Values: [uncompressed, zstd, lz4, snappy, gzip, producer] Server Default Property: compression.type Importance: medium |
|
The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan). Type: long Default: 86400000 (1 day) Valid Values: [0,…] Server Default Property: log.cleaner.delete.retention.ms Importance: medium |
|
The time to wait before deleting a file from the filesystem Type: long Default: 60000 (1 minute) Valid Values: [0,…] Server Default Property: log.segment.delete.delay.ms Importance: medium |
|
This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system’s background flush capabilities as it is more efficient. This setting can be overridden on a per-topic basis (see the per-topic configuration section). Type: long Default: 9223372036854775807 Valid Values: [0,…] Server Default Property: log.flush.interval.messages Importance: medium |
|
This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system’s background flush capabilities as it is more efficient. Type: long Default: 9223372036854775807 Valid Values: [0,…] Server Default Property: log.flush.interval.ms Importance: medium |
|
This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don’t need to change this. Type: int Default: 4096 (4 kibibytes) Valid Values: [0,…] Server Default Property: log.index.interval.bytes Importance: medium |
|
The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted. Type: long Default: 9223372036854775807 Valid Values: [1,…] Server Default Property: log.cleaner.max.compaction.lag.ms Importance: medium |
|
The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime. Type: long Default: 9223372036854775807 Valid Values: [0,…] Server Default Property: log.message.timestamp.difference.max.ms Importance: medium |
|
Define whether the timestamp in the message is message create time or log append time. The value should be either Type: string Default: CreateTime Valid Values: [CreateTime, LogAppendTime] Server Default Property: log.message.timestamp.type Importance: medium |
|
This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period. Type: double Default: 0.5 Valid Values: [0,…,1] Server Default Property: log.cleaner.min.cleanable.ratio Importance: medium |
|
The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. Type: long Default: 0 Valid Values: [0,…] Server Default Property: log.cleaner.min.compaction.lag.ms Importance: medium |
|
When a producer sets acks to "all" (or "-1"), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of "all". This will ensure that the producer raises an exception if a majority of replicas do not receive a write. Type: int Default: 1 Valid Values: [1,…] Server Default Property: min.insync.replicas Importance: medium |
|
This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the "delete" retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. Type: long Default: -1 Valid Values: Server Default Property: log.retention.bytes Importance: medium |
|
This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the "delete" retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied. Type: long Default: 604800000 (7 days) Valid Values: [-1,…] Server Default Property: log.retention.ms Importance: medium |
|
This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Type: int Default: 1073741824 (1 gibibyte) Valid Values: [14,…] Server Default Property: log.segment.bytes Importance: medium |
|
This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting. Type: int Default: 10485760 (10 mebibytes) Valid Values: [0,…] Server Default Property: log.index.size.max.bytes Importance: medium |
|
The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling Type: long Default: 0 Valid Values: [0,…] Server Default Property: log.roll.jitter.ms Importance: medium |
|
This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn’t full to ensure that retention can delete or compact old data. Type: long Default: 604800000 (7 days) Valid Values: [1,…] Server Default Property: log.roll.ms Importance: medium |
|
Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss. Type: boolean Default: false Valid Values: Server Default Property: unclean.leader.election.enable Importance: medium |
|
This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configurationdoes not apply to any message format conversion that might be required for replication to followers. Type: boolean Default: true Valid Values: Server Default Property: log.message.downconversion.enable Importance: low |
Logging
The changing of log levels is described within the Changing Log Levels document.