Skip to content

doc: Replaces Kafka bootstrap_servers in docs and examples - #4745

Open
Gabri3l wants to merge 1 commit into
masterfrom
CLOUDP-445893-kafka-docs
Open

Gabri3l wants to merge 1 commit into
masterfrom
CLOUDP-445893-kafka-docs

Conversation

@Gabri3l

@Gabri3l Gabri3l commented Sep 18, 2026

Copy link
Copy Markdown
Collaborator

Description

Replaces the Kafka bootstrap_servers value in every published mongodbatlas_stream_connection example with the apex example.com:9092.

Why the apex example.com

example.com is 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.md
  • docs/data-sources/stream_processor.md
  • docs/data-sources/stream_processors.md

Link to any related issue(s)

CLOUDP-445893

Related: CLOUDP-434920, CLOUDP-445878, CLOUDP-445892.

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contributing guides
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fix and verified my code
  • If changes include deprecations or removals I have added appropriate changelog entries.
  • If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

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
@Gabri3l Gabri3l changed the title CLOUDP-445893: Replace loopback Kafka bootstrap_servers in docs and examples doc: CLOUDP-445893 -- Replaces loopback Kafka bootstrap_servers in docs and examples Sep 18, 2026
@Gabri3l Gabri3l changed the title doc: CLOUDP-445893 -- Replaces loopback Kafka bootstrap_servers in docs and examples doc: Replaces loopback Kafka bootstrap_servers in docs and examples Sep 18, 2026
@Gabri3l Gabri3l changed the title doc: Replaces loopback Kafka bootstrap_servers in docs and examples doc: Replaces Kafka bootstrap_servers in docs and examples Sep 18, 2026
@Gabri3l
Gabri3l marked this pull request as ready for review September 18, 2026 14:24
@Gabri3l
Gabri3l requested review from a team as code owners September 18, 2026 14:24
Copilot AI lite review requested due to automatic review settings September 18, 2026 14:24
@github-actions

Copy link
Copy Markdown
Contributor

APIx bot: a message has been sent to Docs Slack channel

@augmentcode

augmentcode Bot commented Sep 18, 2026

Copy link
Copy Markdown
🤖 Augment PR Summary

Summary: Replaces localhost Kafka bootstrap endpoints with the documentation-reserved, resolvable example.com:9092 across stream connection documentation and source examples.
Technical Notes: Updates the hand-maintained connection resource page and regenerates stream-processor resource/data-source docs from the corresponding example.

🤖 Was this summary useful? React with 👍 or 👎

@augmentcode augmentcode Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review completed. No suggestions at this time.

Comment augment review to trigger a new review at any time.

Copilot AI left a comment

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.

🟡 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>.txt entry 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.

Comment thread docs/resources/stream_connection.md
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.

3 participants