Skip to content

Add minimum Kafka ACL permissions for Kafka Monitoring and Messages#35817

Open
piochelepiotr wants to merge 1 commit intomasterfrom
pwolski/kafka-acl-permissions
Open

Add minimum Kafka ACL permissions for Kafka Monitoring and Messages#35817
piochelepiotr wants to merge 1 commit intomasterfrom
pwolski/kafka-acl-permissions

Conversation

@piochelepiotr
Copy link
Copy Markdown
Contributor

Summary

  • Add a "Kafka ACL permissions" subsection to the Kafka Monitoring setup page documenting the minimum ACL permissions required for the Datadog Agent (Describe/DescribeConfigs on Cluster, Topic, and Group resources)
  • Add a "Kafka ACL permissions" section to the Kafka Messages page documenting the additional Read on Topic permission required for message retrieval

Test plan

  • Verify the permissions tables render correctly in the preview
  • Verify the cross-link from messages.md to the main page anchor works

🤖 Generated with Claude Code

Document the minimum Kafka ACL permissions required for the Datadog Agent
when connecting to ACL-enabled Kafka clusters.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@piochelepiotr piochelepiotr requested a review from a team as a code owner April 7, 2026 20:24
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2026

Copy link
Copy Markdown
Contributor

@domalessi domalessi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! Left some feedback. Let me know if you have any Qs.


Go to the [Kafka Monitoring setup page][1] and click {{< ui >}}Get Started{{< / ui >}}. Then choose your environment and follow the instructions. To request assistance, choose {{< ui >}}Request a pairing session{{< /ui >}}.

### Kafka ACL permissions
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ACL section is inserted between the setup paragraph and the kafka_setup-2.png image, which breaks the flow — that image illustrates the setup dialog described in the paragraph above it. I think the move would be to shift the ### Kafka ACL permissions to after the image and its following paragraph

1. In Datadog, under [Remote Configuration][13], check that remote configuration is enabled at the organization level.
2. In Datadog, under [Remote Configuration][13], check that the agent running the Kafka Consumer integration has remote configuration enabled, and is using an API key with remote configuration enabled.

## Kafka ACL permissions
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having ## Kafka ACL permissions immediately followed by ## Required permissions is confusing — both are about permissions but they cover different things (Kafka cluster access for the Agent vs. Datadog RBAC for the user), and there's nothing to explain the distinction.

I'd suggest one of:

  1. Group under a single section: Wrap both under ## Permissions with H3 subsections, and rename ## Required permissions to ### Datadog user permissions.
  2. Move into Prerequisites: Since Kafka ACL permissions are a prerequisite for the feature to work, nest ### Kafka ACL permissions under ## Prerequisites alongside the existing Agent version and remote configuration prerequisites. Then ## Required permissions stands alone covering only Datadog RBAC.
  3. Keep the structure but add a framing sentence to ## Required permissions: "In addition to Kafka ACL permissions, you must have the following Datadog account permissions:" — this at least signals the distinction without reorganizing.

I think option 2 perhaps is the best move.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants