Skip to content

Conversation

@puretension
Copy link
Contributor

@puretension puretension commented Jul 22, 2025

Summary

This PR adds TLS Configuration Quick Reference tables to improve the usability of the TLS configuration documentation.

Motivation

The current TLS configuration documentation contains comprehensive information but lacks a quick reference for users to understand the differences between ArgoCD components at a glance. Users often need to read through lengthy sections to find specific information about:

  • Which components support certificate hot reload
  • Required secret names for each component
  • Required SAN entries
  • Inter-component TLS parameters

Changes

Added two comparison tables to docs/operator-manual/tls.md:

  1. Certificate Configuration Overview Table

    • Shows hot reload support, secret names, SAN requirements
    • Provides quick comparison across argocd-server, argocd-repo-server, argocd-dex-server
  2. Inter-Component TLS Parameters Table

    • Shows strict TLS and plaintext parameters
    • Clarifies default behavior (non-validating TLS)

Before vs After

Before: Current comprehensive documentation

before

After: Enhanced with quick reference tables

after

Table Preview

Certificate Configuration Overview

cert-table

Inter-Component TLS Parameters

component-table

Benefits

  • Improved usability: Users can quickly find relevant information
  • Better onboarding: New users understand TLS architecture faster
  • Enhanced troubleshooting: Clear overview helps identify configuration issues
  • Reduced support burden: Fewer questions about certificate configuration

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

@puretension puretension requested review from a team as code owners July 22, 2025 20:04
@bunnyshell
Copy link

bunnyshell bot commented Jul 22, 2025

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

@agaudreault agaudreault merged commit fed3c7e into argoproj:master Sep 12, 2025
25 checks passed
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