-
Notifications
You must be signed in to change notification settings - Fork 545
docs: update Kafka MSK IAM authentication configuration #2294
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
WalkthroughDocumentation for AWS MSK IAM authentication in the Kafka input and output docs was rewritten and expanded: sections reorganized, configuration parameters and examples added, credential guidance clarified, and a concrete IAM policy with explicit ARNs and placeholders provided. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Suggested labels
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
pipeline/outputs/kafka.md (4)
5-5: Fix plugin reference: output doc incorrectly says “Kafka input plugin”.
Line 5 should refer to the Kafka output plugin (producer), not the input plugin.-In Fluent Bit 4.0.4 and later, the Kafka input plugin supports authentication with AWS MSK IAM, enabling integration with Amazon MSK (Managed Streaming for Apache Kafka) clusters that require IAM-based access. +In Fluent Bit 4.0.4 and later, the Kafka output plugin supports authentication with AWS MSK IAM, enabling integration with Amazon MSK (Managed Streaming for Apache Kafka) clusters that require IAM-based access.
27-27: Typo:librdfkafka→librdkafka.
Line 27 has a misspelling that may confuse readers searching for the right library knobs.-Setting `rdkafka.log.connection.close` to `false` and `rdkafka.request.required.acks` to `1` are examples of recommended settings of `librdfkafka` properties. +Setting `rdkafka.log.connection.close` to `false` and `rdkafka.request.required.acks` to `1` are examples of recommended settings of `librdkafka` properties.
48-58: Example config useshost(and a malformed IP) instead ofbrokers.
Line 56 has192.1681.3:9092(missing dot) and the key should match the documented parameterbrokers.outputs: - name: kafka match: '*' - host: 192.1681.3:9092 + brokers: 192.168.1.3:9092 topics: test
191-191: Minor formatting: add space in “rawformat”.-#### Kafka configuration file with `raw`format +#### Kafka configuration file with `raw` format
4db76b7 to
9101aab
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pipeline/outputs/kafka.md (1)
5-6: Doc bug: “Kafka input plugin” should be “Kafka Producer output plugin” here.
This is in the producer/output page and is likely a copy/paste slip.
🧹 Nitpick comments (1)
pipeline/inputs/kafka.md (1)
149-165: Config parameters table/examples: consider explicitly stating whetheraws_msk_iam_cluster_arnis no longer needed (and why).
Right now the table + examples implyrdkafka.sasl.mechanism=aws_msk_iamis sufficient, but users familiar with older docs will look for the removed ARN parameter and may be unsure what changed.Also applies to: 173-183
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pipeline/inputs/kafka.md(1 hunks)pipeline/outputs/kafka.md(1 hunks)
🔇 Additional comments (2)
pipeline/inputs/kafka.md (1)
195-225: IAM permissions + ARN formats look solid and much safer (scoped resources + CLUSTER_UUID note).
The consumer actions list (DescribeGroup/AlterGroup) and the CLUSTER_UUID guidance are the right level of specificity.pipeline/outputs/kafka.md (1)
347-374: Producer IAM policy example is clear and appropriately scoped.
Nice improvement over overly-broadResource: "*"style examples.
Signed-off-by: Arbin <[email protected]>
Change 'Kafka input plugin' to 'Kafka output plugin' in the introduction Signed-off-by: Arbin <[email protected]>
9101aab to
a767991
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pipeline/inputs/kafka.md(1 hunks)pipeline/outputs/kafka.md(2 hunks)
🔇 Additional comments (2)
pipeline/inputs/kafka.md (1)
199-227: Approved: IAM permissions policy is now correct.The policy correctly includes the cluster UUID in ARN paths and specifies all required actions for a consumer (Connect, DescribeTopic, ReadData, DescribeGroup, AlterGroup). The guidance to substitute REGION, ACCOUNT, CLUSTER_NAME, and CLUSTER_UUID is clear.
pipeline/outputs/kafka.md (1)
351-376: Approved: Producer IAM permissions policy is correct.The policy correctly specifies producer-only actions (Connect, DescribeTopic, WriteData) with cluster and topic ARNs that include the CLUSTER_UUID segment. The guidance to substitute placeholders is clear.
|
@alexakreizinger review request for you! |
|
I want to give this my full attention, but I have to finish early for the day for an appointment so I'm setting a reminder to review it on Monday 😄 |
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.