Skip to content

Commit 0fc50e6

Browse files
authored
DOC-962 Field additions and deprecations for redpanda_migrator_offsets output (#152)
1 parent 73fe2b5 commit 0fc50e6

File tree

1 file changed

+42
-14
lines changed

1 file changed

+42
-14
lines changed

modules/components/pages/outputs/redpanda_migrator_offsets.adoc

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ component_type_dropdown::[]
1515
Use the `redpanda_migrator_offsets` output in conjunction with a `kafka_franz` input that is configured to read the `__consumer_offsets` topic.
1616
This output uses the https://github.com/twmb/franz-go[Franz Kafka client library^].
1717

18+
Alternatively, use the `redpanda_migrator_bundle` xref:components:inputs/redpanda_migrator_bundle.adoc[input] and xref:components:outputs/redpanda_migrator_bundle.adoc[output] to complete the migration of topics, messages, and schemas to a Redpanda cluster.
19+
1820

1921
ifndef::env-cloud[]
2022
Introduced in version 4.37.0.
@@ -27,13 +29,16 @@ Common::
2729
--
2830
2931
```yml
30-
# Common config fields, showing default values
32+
# Common configuration fields, showing default values
3133
output:
3234
label: ""
3335
redpanda_migrator_offsets:
3436
seed_brokers: [] # No default (required)
35-
kafka_key: ${! @kafka_key }
36-
max_in_flight: 1
37+
offset_topic: ${! @kafka_offset_topic }
38+
offset_group: ${! @kafka_offset_group }
39+
offset_partition: ${! @kafka_offset_partition }
40+
offset_commit_timestamp: ${! @kafka_offset_commit_timestamp }
41+
offset_metadata: ${! @kafka_offset_metadata }
3742
```
3843
3944
--
@@ -42,7 +47,7 @@ Advanced::
4247
--
4348
4449
```yml
45-
# All config fields, showing default values
50+
# All configuration fields, showing default values
4651
output:
4752
label: ""
4853
redpanda_migrator_offsets:
@@ -57,8 +62,11 @@ output:
5762
client_certs: []
5863
sasl: [] # No default (optional)
5964
metadata_max_age: 5m
60-
kafka_key: ${! @kafka_key }
61-
max_in_flight: 1
65+
offset_topic: ${! @kafka_offset_topic }
66+
offset_group: ${! @kafka_offset_group }
67+
offset_partition: ${! @kafka_offset_partition }
68+
offset_commit_timestamp: ${! @kafka_offset_commit_timestamp }
69+
offset_metadata: ${! @kafka_offset_metadata }
6270
timeout: 10s
6371
max_message_bytes: 1MB
6472
broker_write_max_bytes: 100MB
@@ -443,25 +451,45 @@ The maximum period of time after which metadata is refreshed.
443451

444452
*Default*: `5m`
445453

454+
=== offset_topic
455+
456+
The name of the Kafka offset topic to process. This field supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions].
457+
458+
*Type*: `string`
446459

447-
=== `kafka_key`
460+
*Default*: `${! @kafka_offset_topic }`
448461

449-
The Kafka message key.
462+
=== offset_group
450463

451-
This field supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions].
464+
The name of the Kafka offset consumer group to process. This field supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions].
452465

453466
*Type*: `string`
454467

455-
*Default*: `${! @kafka_key }`
468+
*Default*: `${! @kafka_offset_group }`
456469

470+
=== offset_partition
457471

458-
=== `max_in_flight`
472+
The Kafka offset partition ID to process. This field supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions].
459473

460-
The maximum number of message batches to send in parallel at any given time.
474+
*Type*: `string`
461475

462-
*Type*: `int`
476+
*Default*: `${! @kafka_offset_partition }`
477+
478+
=== offset_commit_timestamp
479+
480+
The Kafka offset commit timestamp to process. This field supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions].
481+
482+
*Type*: `string`
483+
484+
*Default*: `${! @kafka_offset_commit_timestamp }`
485+
486+
=== offset_metadata
487+
488+
The Kafka offset metadata value to process. This field supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions].
489+
490+
*Type*: `string`
463491

464-
*Default*: `1`
492+
*Default*: `${! @kafka_offset_metadata }`
465493

466494
=== `timeout`
467495

0 commit comments

Comments
 (0)