From ad3d7cd8ac03d85059636a575a05f0f92bdc6acb Mon Sep 17 00:00:00 2001 From: Corneil du Plessis Date: Tue, 17 May 2022 21:09:45 +0200 Subject: [PATCH] Improve indentation in docs Added description for building local container images. Fixes #241 --- README.adoc | 7 +++++ .../source/cdc-debezium-source/README.adoc | 26 +++++++++---------- build-images.sh => local/build-images.sh | 0 3 files changed, 20 insertions(+), 13 deletions(-) rename build-images.sh => local/build-images.sh (100%) diff --git a/README.adoc b/README.adoc index 3b1b1fbc..675a6b82 100644 --- a/README.adoc +++ b/README.adoc @@ -221,6 +221,13 @@ cd applications/sink/log-sink/apps/log-sink-rabbit ./mvnw clean package ---- +Rebuild all container images. + +[source,shell] +---- +./local/build-images.sh +---- + === Additional Resources Here is a list of resources where you can find out more about using and developing functions and stream applications: diff --git a/applications/source/cdc-debezium-source/README.adoc b/applications/source/cdc-debezium-source/README.adoc index 4df8572c..be561704 100644 --- a/applications/source/cdc-debezium-source/README.adoc +++ b/applications/source/cdc-debezium-source/README.adoc @@ -27,7 +27,7 @@ $$connector$$:: $$Shortcut for the cdc.config.connector.class property. Either o $$name$$:: $$Unique name for this sourceConnector instance.$$ *($$String$$, default: `$$$$`)* $$schema$$:: $$Include the schema's as part of the outbound message.$$ *($$Boolean$$, default: `$$false$$`)* -==== cdc.flattening +=== cdc.flattening $$add-fields$$:: $$Comma separated list of metadata fields to add to the flattened message. The fields will be prefixed with "__" or "__[<]struct]__", depending on the specification of the struct.$$ *($$String$$, default: `$$$$`)* $$add-headers$$:: $$Comma separated list specify a list of metadata fields to add to the header of the flattened message. The fields will be prefixed with "__" or "__[struct]__".$$ *($$String$$, default: `$$$$`)* @@ -35,23 +35,19 @@ $$delete-handling-mode$$:: $$Options for handling deleted records: (1) none - pa $$drop-tombstones$$:: $$By default Debezium generates tombstone records to enable Kafka compaction on deleted records. The dropTombstones can suppress the tombstone records.$$ *($$Boolean$$, default: `$$true$$`)* $$enabled$$:: $$Enable flattening the source record events (https://debezium.io/docs/configuration/event-flattening).$$ *($$Boolean$$, default: `$$true$$`)* -==== cdc.offset +=== cdc.offset $$commit-timeout$$:: $$Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt.$$ *($$Duration$$, default: `$$5000ms$$`)* $$flush-interval$$:: $$Interval at which to try committing offsets. The default is 1 minute.$$ *($$Duration$$, default: `$$60000ms$$`)* $$policy$$:: $$Offset storage commit policy.$$ *($$OffsetPolicy$$, default: `$$$$`)* $$storage$$:: $$Kafka connector tracks the number processed records and regularly stores the count (as "offsets") in a preconfigured metadata storage. On restart the connector resumes the reading from the last recorded source offset.$$ *($$OffsetStorageType$$, default: `$$$$`, possible values: `memory`,`file`,`kafka`,`metadata`)* -==== cdc.stream.header +=== cdc.stream.header $$convert-connect-headers$$:: $$When true the {@link org.apache.kafka.connect.header.Header} are converted into message headers with the {@link org.apache.kafka.connect.header.Header#key()} as name and {@link org.apache.kafka.connect.header.Header#value()}.$$ *($$Boolean$$, default: `$$true$$`)* $$offset$$:: $$Serializes the source record's offset metadata into the outbound message header under cdc.offset.$$ *($$Boolean$$, default: `$$false$$`)* -=== metadata.store - -$$type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* - -==== metadata.store.dynamo-db +=== metadata.store.dynamo-db $$create-delay$$:: $$Delay between create table retries.$$ *($$Integer$$, default: `$$1$$`)* $$create-retries$$:: $$Retry number for create table request.$$ *($$Integer$$, default: `$$25$$`)* @@ -60,24 +56,28 @@ $$table$$:: $$Table name for metadata.$$ *($$String$$, default: `$$$$`)* $$time-to-live$$:: $$TTL for table entries.$$ *($$Integer$$, default: `$$$$`)* $$write-capacity$$:: $$Write capacity on the table.$$ *($$Long$$, default: `$$1$$`)* -==== metadata.store.gemfire +=== metadata.store.gemfire $$region$$:: $$Gemfire region name for metadata.$$ *($$String$$, default: `$$$$`)* -==== metadata.store.jdbc +=== metadata.store.jdbc $$region$$:: $$Unique grouping identifier for messages persisted with this store.$$ *($$String$$, default: `$$DEFAULT$$`)* $$table-prefix$$:: $$Prefix for the custom table name.$$ *($$String$$, default: `$$$$`)* -==== metadata.store.mongo-db +=== metadata.store.mongo-db $$collection$$:: $$MongoDB collection name for metadata.$$ *($$String$$, default: `$$metadataStore$$`)* -==== metadata.store.redis +=== metadata.store.redis $$key$$:: $$Redis key for metadata.$$ *($$String$$, default: `$$$$`)* -==== metadata.store.zookeeper +=== metadata.store + +$$type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* + +=== metadata.store.zookeeper $$connect-string$$:: $$Zookeeper connect string in form HOST:PORT.$$ *($$String$$, default: `$$127.0.0.1:2181$$`)* $$encoding$$:: $$Encoding to use when storing data in Zookeeper.$$ *($$Charset$$, default: `$$UTF-8$$`)* diff --git a/build-images.sh b/local/build-images.sh similarity index 100% rename from build-images.sh rename to local/build-images.sh