Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: enhance best practices for cluster-wide resources reconciliation #4423

Conversation

ionicsolutions
Copy link
Contributor

@ionicsolutions ionicsolutions commented Feb 12, 2025

Problem Statement

The description of options for controlling the reconciliation and CRD installation of cluster-wide resources in the "Security Best Practices" guide is incomplete.

  • If the CRD installation is disabled in the Helm chart but the reconcilers are not, the core controller produces errors in its logs because it cannot find the CRDs.
  • The docs don't explain how to disable reconciliation in the Helm chart. There's an easy-to-miss naming inconsistency between the Helm chart key for ClusterSecretStore CRD installation and reconciliation (the latter following the name of the core controller flag rather than the resource name), which makes listing the options in full especially useful.
  • The core controller flags have to be set to false to disable reconciliation.

Related Issue

N/A

Proposed Changes

I've completed the description by adding missing options. Instead of running make test, I've built and verified the generated docs.

Checklist

  • I have read the contribution guidelines
  • All commits are signed with git commit --signoff
  • My changes have reasonable test coverage
  • All tests pass with make test
  • I ensured my PR is ready for review with make reviewable

@ionicsolutions ionicsolutions requested a review from a team as a code owner February 12, 2025 23:06
Copy link
Member

@moolen moolen left a comment

Choose a reason for hiding this comment

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

Hey! Thank you for fixing the documentation on that end, very much appreciated 🙇

@moolen moolen merged commit 4286d27 into external-secrets:main Feb 12, 2025
9 of 10 checks passed
@ionicsolutions ionicsolutions deleted the enhance-cluster-wide-resources-best-practices branch February 12, 2025 23:18
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