docs: document remaining pulsar_source / pulsar_sink arguments in README - #205
Closed
david-streamlio wants to merge 2 commits into
Closed
docs: document remaining pulsar_source / pulsar_sink arguments in README#205david-streamlio wants to merge 2 commits into
david-streamlio wants to merge 2 commits into
Conversation
The README's `pulsar_source` and `pulsar_sink` property tables lagged the actual schema: `secrets` (and, for sources, `custom_runtime_options` and `schema_type`) have been supported since v0.2.0 (PRs streamnative#96/streamnative#97) but were never added to the README, leading users to believe credentials could only be passed via the plaintext `configs` field. - Add the missing `secrets`, `custom_runtime_options`, and `schema_type` rows to the source/sink property tables. - Add `secrets` usage to the README examples and the runnable examples under examples/sources and examples/sinks, demonstrating how to keep credentials (GSA keys, DB passwords) out of `configs` — which is persisted in plaintext in the function metadata topic, `pulsar-admin ... get` output, and state. - Add a credential-handling note explaining the SecretsProvider contract. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Follow-up to the secrets/custom_runtime_options docs fix. The README property tables were still missing several supported arguments, leaving users unaware of producer/crypto tuning and dead-letter handling. - pulsar_source: add producer config (max_pending_messages, max_pending_messages_across_partitions, use_thread_local_producers, batch_builder, compression_type) and crypto config (crypto_key_reader_classname, crypto_key_reader_config, encryption_keys, producer_crypto_failure_action, consumer_crypto_failure_action) rows. - pulsar_sink: add classname, dead_letter_topic, max_redeliver_count, negative_ack_redelivery_delay_ms, retain_key_ordering, and sink_type rows. Descriptions match the schema descriptions in the resource Go files. Every top-level argument in resource_pulsar_source.go / resource_pulsar_sink.go is now represented in the README tables. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
@david-streamlio:Thanks for your contribution. For this PR, do we need to update docs? |
github-actions
Bot
added
the
doc-info-missing
Author
Open
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Follow-up to #204. After that PR documents
secrets/custom_runtime_options/schema_type, the README property tables still omitted several other supported arguments. This PR documents the rest so every top-level argument inresource_pulsar_source.go/resource_pulsar_sink.gois represented in the README.pulsar_source— added rowsProducer config:
max_pending_messages,max_pending_messages_across_partitions,use_thread_local_producers,batch_builder,compression_type.Crypto config:
crypto_key_reader_classname,crypto_key_reader_config,encryption_keys,producer_crypto_failure_action,consumer_crypto_failure_action.pulsar_sink— added rowsclassname,dead_letter_topic,max_redeliver_count,negative_ack_redelivery_delay_ms,retain_key_ordering,sink_type.Notes
docs/resources/*.md.🤖 Generated with Claude Code