Skip to content

docs: expand clowder/database annotation reconciliation details#1784

Open
mjholder wants to merge 2 commits into
RedHatInsights:masterfrom
mjholder:docs/database-annotation-reconciliation
Open

docs: expand clowder/database annotation reconciliation details#1784
mjholder wants to merge 2 commits into
RedHatInsights:masterfrom
mjholder:docs/database-annotation-reconciliation

Conversation

@mjholder

Copy link
Copy Markdown
Contributor

Summary

  • Expands the app-interface section of docs/providers/database.md to explain the two-tier secret lookup (annotation match → hostname fallback), why the annotation is necessary for restore/migration scenarios, and key details like timing and value requirements.
  • Adds a new subsection to the FAQ database migration entry with restore-specific guidance and an example showing the annotation swap pattern.

Context

Learned from a DR exercise that the existing docs mention the annotation exists but don't explain how the reconciliation logic works or why the hostname fallback fails for restored instances. This caused confusion during a real restore.

Test plan

  • Review rendered markdown for accuracy and formatting
  • Verify code references match current implementation in appinterface.go

🤖 Generated with Claude Code

mjholder and others added 2 commits June 11, 2026 11:29
Clarify how the two-tier secret lookup works in app-interface mode
(annotation-first, hostname fallback) and why the annotation is
required for database restore/migration scenarios where the RDS
hostname does not follow the expected naming pattern.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Show the ClowdApp and app-interface resource side by side to make it
clear the annotation value matches .metadata.name, not database.name.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@mjholder

Copy link
Copy Markdown
Contributor Author

/test-e2e

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.

1 participant