Conversation
Every published mongodbatlas_stream_connection example used bootstrap_servers = "localhost:9092,localhost:9092". The SSRF validation added for Kafka bootstrapServers rejects loopback, so copy-pasting from the Terraform Registry docs now fails with an HTTP 400 VALIDATION_ERROR. Uses the apex example.com:9092 instead: it is RFC 2606-reserved for documentation, resolves to stable public addresses, and is not blocked, so a copy-pasted example validates. A subdomain such as kafka.example.com is avoided because example.com has no wildcard record, making it NXDOMAIN. Regenerates the stream_processor resource and data source docs, which tfplugindocs renders from examples/. JIRA: CLOUDP-445893
|
APIx bot: a message has been sent to Docs Slack channel |
🤖 Augment PR SummarySummary: Replaces localhost Kafka bootstrap endpoints with the documentation-reserved, resolvable 🤖 Was this summary useful? React with 👍 or 👎 |
There was a problem hiding this comment.
🟡 Changes recommended
Add the required changelog entry for this documentation update.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Updates published Kafka examples to use example.com:9092 instead of localhost.
Changes:
- Updated hand-maintained Kafka examples.
- Regenerated stream processor documentation.
File summaries
| File | Description |
|---|---|
examples/mongodbatlas_stream_processor/main.tf |
Updated Kafka bootstrap server |
examples/mongodbatlas_stream_connection/main.tf |
Updated Kafka bootstrap servers |
docs/resources/stream_processor.md |
Regenerated example |
docs/resources/stream_connection.md |
Updated published Kafka examples |
docs/data-sources/stream_processors.md |
Regenerated example |
docs/data-sources/stream_processor.md |
Regenerated example |
Review details
Suppressed comments (1)
examples/mongodbatlas_stream_connection/main.tf:45
- This PR changes user-facing published examples, but no
.changelog/<PR_NUMBER>.txtentry is included. Please add the required release-note entry for this documentation update so it is represented in the provider’s release notes.
bootstrap_servers = "example.com:9092"
- Files reviewed: 6/6 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Description
Replaces the Kafka
bootstrap_serversvalue in every publishedmongodbatlas_stream_connectionexample with the apexexample.com:9092.Why the apex
example.comexample.comis RFC 2606-reserved for documentation, resolves to stable public addresses, so a copy-pasted example passes validation. It will not connect to a broker, which is expected of an example.This is a follow-up from test updates made in #4738
Changes
Hand-maintained, edited directly:
docs/resources/stream_connection.md— no template exists for this page (3 occurrences)Examples:
examples/mongodbatlas_stream_connection/main.tf(3 occurrences)examples/mongodbatlas_stream_processor/main.tf(1 occurrence)Generated from the examples above via
make generate-doc resource_name=stream_processor:docs/resources/stream_processor.mddocs/data-sources/stream_processor.mddocs/data-sources/stream_processors.mdLink to any related issue(s)
CLOUDP-445893
Related: CLOUDP-434920, CLOUDP-445878, CLOUDP-445892.
Type of change:
Required Checklist:
Further comments