Skip to content

Added a new subsection configuring certificates in the configuration …#8692

Merged
tiffany76 merged 28 commits intoopen-telemetry:mainfrom
pratik-mahalle:configure-certificates
Jan 16, 2026
Merged

Added a new subsection configuring certificates in the configuration …#8692
tiffany76 merged 28 commits intoopen-telemetry:mainfrom
pratik-mahalle:configure-certificates

Conversation

@pratik-mahalle
Copy link
Copy Markdown
Contributor

@pratik-mahalle pratik-mahalle commented Dec 20, 2025

Changes Made

Added a new subsection "Using certificates in the Collector" after the certificate generation steps, which includes:

  1. TLS configuration for receivers (server-side) - Shows how to configure cert_file and key_file for the OTLP receiver to encrypt incoming connections

  2. TLS configuration for exporters (client-side) - Shows how to configure ca_file to verify the server's certificate, and optionally cert_file/key_file to present a client certificate

  3. mTLS configuration (mutual TLS) - Demonstrates how to set up mutual authentication where:

    • The receiver uses client_ca_file to verify client certificates
    • The exporter provides both CA and client certificate
  4. Common TLS settings table - A reference table with all available TLS configuration options:

    • ca_file, cert_file, key_file, client_ca_file
    • insecure, insecure_skip_verify
    • min_version, max_version
    • reload_interval
  5. Link to configtls documentation - Points to the official Go package documentation for more details

Closes: #8003

…file

Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
@pratik-mahalle pratik-mahalle requested a review from a team as a code owner December 20, 2025 13:13
@otelbot-docs otelbot-docs Bot requested review from a team and dmathieu and removed request for a team December 20, 2025 13:13
Copy link
Copy Markdown
Member

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

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

@open-telemetry/collector-approvers, PTAL. Thanks.

@tiffany76 tiffany76 added the missing:sig-approval Co-owning SIG didn't provide an approval label Dec 23, 2025
Copy link
Copy Markdown
Contributor

@jade-guiton-dd jade-guiton-dd left a comment

Choose a reason for hiding this comment

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

The explanation seems good, if a bit redundant, especially since there are already examples here

@pratik-mahalle
Copy link
Copy Markdown
Contributor Author

The explanation seems good, if a bit redundant, especially since there are already examples here

Thanks for the feedback — that makes sense 👍

I took another look at this section alongside the existing configtls README, and I agree there’s some overlap in terms of explanations and examples. My initial intent was to make this document self-contained, but I see how that can become redundant given the dedicated TLS docs.

One possible approach could be to trim this section down to:

  • briefly explain when and why TLS is needed here,

  • keep the certificate generation example (since it’s more procedural),

  • and link out to the configtls README for the full set of options and examples.

That said, I’m happy to align with whatever level of detail you think is appropriate for this doc. Let me know if you’d prefer a more concise version that defers to the existing TLS documentation, and I can update it according

@jade-guiton-dd
Copy link
Copy Markdown
Contributor

I think this is fine as-is, my only worry would be about the two docs getting out-of-sync, but I doubt configtls will see changes in the short term anyway.

@pratik-mahalle
Copy link
Copy Markdown
Contributor Author

That makes sense — thanks for the clarification.
I agree the risk of them getting out of sync is fairly low, and I’m happy to keep this as-is for now. If configtls does evolve in the future, we can always revisit and realign the docs then.

Comment thread content/en/docs/collector/configuration.md Outdated
Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
@otelbot-docs otelbot-docs Bot requested a review from a team January 6, 2026 13:20
Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
@pratik-mahalle
Copy link
Copy Markdown
Contributor Author

/fix:refcache

@otelbot-docs
Copy link
Copy Markdown
Contributor

otelbot-docs Bot commented Jan 6, 2026

fix:refcache applied successfully in run 20750190111.

pratik-mahalle and others added 6 commits January 8, 2026 07:36
…file

Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
@vitorvasc vitorvasc force-pushed the configure-certificates branch from 72084a6 to 6956a41 Compare January 8, 2026 10:36
Comment thread content/en/docs/collector/configuration.md Outdated
@pratik-mahalle
Copy link
Copy Markdown
Contributor Author

/fix:refcache

@otelbot-docs
Copy link
Copy Markdown
Contributor

otelbot-docs Bot commented Jan 12, 2026

fix:refcache applied successfully in run 20923025742.

@vitorvasc
Copy link
Copy Markdown
Member

/fix:all

@otelbot
Copy link
Copy Markdown
Contributor

otelbot Bot commented Jan 15, 2026

ℹ️ fix:all made no changes. Nothing to commit.

Comment thread content/en/docs/collector/configuration.md Outdated
Comment thread content/en/docs/collector/configuration.md Outdated
Comment thread content/en/docs/collector/configuration.md Outdated
Comment thread content/en/docs/collector/configuration.md Outdated
Comment thread content/en/docs/collector/configuration.md Outdated
Comment thread content/en/docs/collector/configuration.md
@vitorvasc
Copy link
Copy Markdown
Member

/fix:refcache

@otelbot-docs
Copy link
Copy Markdown
Contributor

otelbot-docs Bot commented Jan 16, 2026

fix:refcache applied successfully in run 21062858058.

Copy link
Copy Markdown
Member

@vitorvasc vitorvasc left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for taking this one, @pratik-mahalle.

@tiffany76 @jade-guiton-dd let me know if there are any further comments. Otherwise, we can merge it. 🙂

Copy link
Copy Markdown
Member

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

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

LGTM!

@tiffany76 tiffany76 added this pull request to the merge queue Jan 16, 2026
Merged via the queue into open-telemetry:main with commit 60b0dc1 Jan 16, 2026
22 checks passed
@pratik-mahalle pratik-mahalle deleted the configure-certificates branch January 17, 2026 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

[Page feedback]: Missing information on how to configure the certificates for TLS or mTLS

4 participants