Skip to content

Update Redpanda Console configuration to include URL schemes for endpoints#1082

Merged
JakeSCahill merged 2 commits intomainfrom
DOC-1254
Apr 21, 2025
Merged

Update Redpanda Console configuration to include URL schemes for endpoints#1082
JakeSCahill merged 2 commits intomainfrom
DOC-1254

Conversation

@JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Apr 17, 2025

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1254
Review deadline: April 18

This pull request updates documentation for Redpanda and Redpanda Console configuration to improve clarity and ensure consistency in specifying URL schemes (http:// or https://) for various endpoints. It also reorganizes and enhances the listener configuration section to better describe how to handle DNS hostnames and multiple listeners.

Updates to Redpanda Console config:

  • Updated all examples of Kafka broker, Schema Registry, and Admin API configurations to include the URL scheme (http:// or https://) in endpoint definitions. This ensures clarity and consistency in how endpoints are specified. [1] [2] [3] [4] [5] [6] [7]

Improvements to listener configuration docs:

  • Reorganized the listener configuration section to clarify key concepts, such as defining listeners, advertising addresses, and supporting multiple configurations. Simplified explanations and added examples for better comprehension.
  • Enhanced descriptions of listener properties, including the importance of using valid hostnames or IPs for advertised addresses and ensuring compatibility with TLS certificates.
  • Added examples for advanced configurations, such as multiple listeners, TLS listeners, and mixed-mode authentication, to support a variety of use cases.

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@JakeSCahill JakeSCahill requested a review from a team as a code owner April 17, 2025 13:03
@netlify
Copy link

netlify bot commented Apr 17, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 26e89c6
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/6800fef3339deb0008eff771
😎 Deploy Preview https://deploy-preview-1082--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@JakeSCahill JakeSCahill requested a review from WesWWagner April 17, 2025 13:10
Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

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

lgtm!

@JakeSCahill JakeSCahill merged commit 6bafa1a into main Apr 21, 2025
7 checks passed
@JakeSCahill JakeSCahill deleted the DOC-1254 branch April 21, 2025 07:04
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