NAIS Topic reference¶
This document describes all possible configuration values in the Topic
spec, commonly known as the topic.yaml
file.
acl¶
Type: array
Required: true
Example
acl[].access¶
Access type granted for a application.
Defaults to readwrite
.
Type: enum
Required: true
Allowed values: read
, readwrite
, write
Example
acl[].application¶
The name of the specified application
Type: string
Required: true
Example
acl[].team¶
The team of the specified application
Type: string
Required: true
Example
config¶
Type: object
Required: false
Example
config.cleanupPolicy¶
CleanupPolicy is either "delete" or "compact" or both. This designates the retention policy to use on old log segments.
Relevant information:
Type: enum
Required: false
Default value: delete
Allowed values: compact
, compact,delete
, delete
config.maxCompactionLagMs¶
MaxCompactionLagMs indicates the maximum time a message will remain ineligible for compaction in the log
Relevant information:
Type: integer
Required: false
Default value: Inf
Minimum value: 0
config.maxMessageBytes¶
The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case.
Relevant information:
Type: integer
Required: false
Default value: 1048588
Value range: 1
-5242880
config.minCleanableDirtyRatioPercent¶
MinCleanableDirtyRatio indicates the minimum ratio of dirty log to retention size to initiate log compaction
Relevant information:
Type: integer
or string
Required: false
Default value: 50%
config.minCompactionLagMs¶
MinCompactionLagMs indicates the minimum time a message will remain uncompacted in the log
Relevant information:
Type: integer
Required: false
Default value: 0
Minimum value: 0
config.minimumInSyncReplicas¶
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.
Relevant information:
Type: integer
Required: false
Default value: 2
Value range: 1
-7
config.partitions¶
The default number of log partitions per topic.
Type: integer
Required: false
Default value: 1
Value range: 1
-1000000
config.replication¶
The default replication factor for created topics.
Relevant information:
Type: integer
Required: false
Default value: 3
Minimum value: 2
config.retentionBytes¶
Configuration controls the maximum size a partition 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.
Relevant information:
Type: integer
Required: false
Default value: -1
config.retentionHours¶
The number of hours to keep a log file before deleting it.
Relevant information:
Type: integer
Required: false
Default value: 168
Maximum value: 2562047788015
config.segmentHours¶
The number of hours 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.
Relevant information:
Type: integer
Required: false
Default value: 168
Value range: 1
-8760
pool¶
Type: string
Required: true