Skip to content

Commit

Permalink
DBZ-7921 Updated docs and k8s descriptors
Browse files Browse the repository at this point in the history
  • Loading branch information
@jcechace
jcechace committed Aug 1, 2024
1 parent 820420b commit 8773ef3
Show file tree
Hide file tree
Showing 2 changed files with 119 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/reference.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,39 @@ Used in: <<debezium-operator-schema-reference-metrics, `+Metrics+`>>
| [[debezium-operator-schema-reference-jmxexporter-configfrom]]<<debezium-operator-schema-reference-jmxexporter-configfrom, `+configFrom+`>> | ConfigMapKeySelector | | Config map key reference which value will be used as configuration file
|===

[#debezium-operator-schema-reference-kafkaoffsetstore]
==== KafkaOffsetStore Schema Reference
Used in: <<debezium-operator-schema-reference-offset, `+Offset+`>>


.KafkaOffsetStore properties
[cols="20%a,25%s,15%a,40%a",options="header"]
|===
| Property | Type | Default | Description
| [[debezium-operator-schema-reference-kafkaoffsetstore-props]]<<debezium-operator-schema-reference-kafkaoffsetstore-props, `+props+`>> | Map | | Additional Kafka client properties.
| [[debezium-operator-schema-reference-kafkaoffsetstore-bootstrapservers]]<<debezium-operator-schema-reference-kafkaoffsetstore-bootstrapservers, `+bootstrapServers+`>> | String | | A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster
| [[debezium-operator-schema-reference-kafkaoffsetstore-topic]]<<debezium-operator-schema-reference-kafkaoffsetstore-topic, `+topic+`>> | String | | The name of the Kafka topic where offsets are to be stored
| [[debezium-operator-schema-reference-kafkaoffsetstore-partitions]]<<debezium-operator-schema-reference-kafkaoffsetstore-partitions, `+partitions+`>> | int | | The number of partitions used when creating the offset storage topic
| [[debezium-operator-schema-reference-kafkaoffsetstore-replicationfactor]]<<debezium-operator-schema-reference-kafkaoffsetstore-replicationfactor, `+replicationFactor+`>> | int | | Replication factor used when creating the offset storage topic
| [[debezium-operator-schema-reference-kafkaoffsetstore-config]]<<debezium-operator-schema-reference-kafkaoffsetstore-config, `+config+`>> | Map | | Additional store configuration properties.
|===

[#debezium-operator-schema-reference-kafkaschemahistorystore]
==== KafkaSchemaHistoryStore Schema Reference
Used in: <<debezium-operator-schema-reference-schemahistory, `+SchemaHistory+`>>


.KafkaSchemaHistoryStore properties
[cols="20%a,25%s,15%a,40%a",options="header"]
|===
| Property | Type | Default | Description
| [[debezium-operator-schema-reference-kafkaschemahistorystore-bootstrapservers]]<<debezium-operator-schema-reference-kafkaschemahistorystore-bootstrapservers, `+bootstrapServers+`>> | String | | A list of host/port pairs that the connector uses for establishing an initial connection to the Kafka cluster
| [[debezium-operator-schema-reference-kafkaschemahistorystore-topic]]<<debezium-operator-schema-reference-kafkaschemahistorystore-topic, `+topic+`>> | String | | The name of the Kafka topic where offsets are to be stored
| [[debezium-operator-schema-reference-kafkaschemahistorystore-partitions]]<<debezium-operator-schema-reference-kafkaschemahistorystore-partitions, `+partitions+`>> | int | | The number of partitions used when creating the offset storage topic
| [[debezium-operator-schema-reference-kafkaschemahistorystore-replicationfactor]]<<debezium-operator-schema-reference-kafkaschemahistorystore-replicationfactor, `+replicationFactor+`>> | int | | Replication factor used when creating the offset storage topic
| [[debezium-operator-schema-reference-kafkaschemahistorystore-config]]<<debezium-operator-schema-reference-kafkaschemahistorystore-config, `+config+`>> | Map | | Additional store configuration properties.
|===

[#debezium-operator-schema-reference-metadatatemplate]
==== MetadataTemplate Schema Reference
Used in: <<debezium-operator-schema-reference-podtemplate, `+PodTemplate+`>>
Expand Down Expand Up @@ -268,6 +301,7 @@ Used in: <<debezium-operator-schema-reference-source, `+Source+`>>
| [[debezium-operator-schema-reference-offset-file]]<<debezium-operator-schema-reference-offset-file, `+file+`>> | <<debezium-operator-schema-reference-fileoffsetstore, `+FileOffsetStore+`>> | | File backed offset store configuration
| [[debezium-operator-schema-reference-offset-memory]]<<debezium-operator-schema-reference-offset-memory, `+memory+`>> | <<debezium-operator-schema-reference-inmemoryoffsetstore, `+InMemoryOffsetStore+`>> | | Memory backed offset store configuration
| [[debezium-operator-schema-reference-offset-redis]]<<debezium-operator-schema-reference-offset-redis, `+redis+`>> | <<debezium-operator-schema-reference-redisoffsetstore, `+RedisOffsetStore+`>> | | Redis backed offset store configuration
| [[debezium-operator-schema-reference-offset-kafka]]<<debezium-operator-schema-reference-offset-kafka, `+kafka+`>> | <<debezium-operator-schema-reference-kafkaoffsetstore, `+KafkaOffsetStore+`>> | | Kafka backing store configuration
| [[debezium-operator-schema-reference-offset-store]]<<debezium-operator-schema-reference-offset-store, `+store+`>> | <<debezium-operator-schema-reference-customstore, `+CustomStore+`>> | | Arbitrary offset store configuration
| [[debezium-operator-schema-reference-offset-flushms]]<<debezium-operator-schema-reference-offset-flushms, `+flushMs+`>> | long | 60000 | Interval at which to try commiting offsets
|===
Expand Down Expand Up @@ -446,7 +480,9 @@ Used in: <<debezium-operator-schema-reference-source, `+Source+`>>
| [[debezium-operator-schema-reference-schemahistory-file]]<<debezium-operator-schema-reference-schemahistory-file, `+file+`>> | <<debezium-operator-schema-reference-fileschemahistorystore, `+FileSchemaHistoryStore+`>> | | File backed schema history store configuration
| [[debezium-operator-schema-reference-schemahistory-memory]]<<debezium-operator-schema-reference-schemahistory-memory, `+memory+`>> | <<debezium-operator-schema-reference-inmemoryschemahistorystore, `+InMemorySchemaHistoryStore+`>> | | Memory backed schema history store configuration
| [[debezium-operator-schema-reference-schemahistory-redis]]<<debezium-operator-schema-reference-schemahistory-redis, `+redis+`>> | <<debezium-operator-schema-reference-redisschemahistorystore, `+RedisSchemaHistoryStore+`>> | | Redis backed schema history store configuration
| [[debezium-operator-schema-reference-schemahistory-kafka]]<<debezium-operator-schema-reference-schemahistory-kafka, `+kafka+`>> | <<debezium-operator-schema-reference-kafkaschemahistorystore, `+KafkaSchemaHistoryStore+`>> | | Kafka backed schema history store configuration
| [[debezium-operator-schema-reference-schemahistory-store]]<<debezium-operator-schema-reference-schemahistory-store, `+store+`>> | <<debezium-operator-schema-reference-customstore, `+CustomStore+`>> | | Arbitrary schema history store configuration
| [[debezium-operator-schema-reference-schemahistory-config]]<<debezium-operator-schema-reference-schemahistory-config, `+config+`>> | Map | | Additional common schema history store configuration properties.
|===

[#debezium-operator-schema-reference-sink]
Expand Down
83 changes: 83 additions & 0 deletions k8/debeziumservers.debezium.io-v1.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1586,6 +1586,47 @@ spec:
flushMs:
description: Interval at which to try commiting offsets
type: integer
kafka:
description: Kafka backing store configuration
properties:
bootstrapServers:
description: A list of host/port pairs that the connector
uses for establishing an initial connection to the Kafka
cluster
type: string
config:
description: Additional store configuration properties.
properties:
props:
additionalProperties:
type: object
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
x-kubernetes-preserve-unknown-fields: true
partitions:
description: The number of partitions used when creating
the offset storage topic
type: integer
props:
description: Additional Kafka client properties.
properties:
props:
additionalProperties:
type: object
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
x-kubernetes-preserve-unknown-fields: true
replicationFactor:
description: Replication factor used when creating the
offset storage topic
type: integer
topic:
description: The name of the Kafka topic where offsets
are to be stored
type: string
type: object
memory:
description: Memory backed offset store configuration
properties:
Expand Down Expand Up @@ -1669,6 +1710,17 @@ spec:
schemaHistory:
description: Schema history store configuration
properties:
config:
description: Additional common schema history store configuration
properties.
properties:
props:
additionalProperties:
type: object
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
x-kubernetes-preserve-unknown-fields: true
file:
description: File backed schema history store configuration
properties:
Expand All @@ -1687,6 +1739,37 @@ spec:
root)
type: string
type: object
kafka:
description: Kafka backed schema history store configuration
properties:
bootstrapServers:
description: A list of host/port pairs that the connector
uses for establishing an initial connection to the Kafka
cluster
type: string
config:
description: Additional store configuration properties.
properties:
props:
additionalProperties:
type: object
type: object
x-kubernetes-preserve-unknown-fields: true
type: object
x-kubernetes-preserve-unknown-fields: true
partitions:
description: The number of partitions used when creating
the offset storage topic
type: integer
replicationFactor:
description: Replication factor used when creating the
offset storage topic
type: integer
topic:
description: The name of the Kafka topic where offsets
are to be stored
type: string
type: object
memory:
description: Memory backed schema history store configuration
properties:
Expand Down

0 comments on commit 8773ef3

Please sign in to comment.