-
Notifications
You must be signed in to change notification settings - Fork 4
feat: Add configurable algorithm option for heimdall key generation #94
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
feat: Add configurable algorithm option for heimdall key generation #94
Conversation
- Change key_type to algorithm in values.yaml to match template expectations - Default algorithm is now 'rsa' instead of hardcoded configuration - Update template comment to reflect configurable algorithm option - Fix inconsistency between values.yaml field name and template reference 🤖 Generated with [GitHub Copilot](https://github.com/features/copilot) (via Zed) Signed-off-by: Eric Searcy <[email protected]>
WalkthroughThe pull request makes the Heimdall signer certificate key generation algorithm configurable. A new configuration parameter is introduced in values.yaml with a default value of "rsa", and the Heimdall signer certificate template is updated to use this configurable algorithm instead of a hardcoded "ecdsa" value. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR enhances the Helm chart by making the private key generation algorithm configurable for the Heimdall signer certificate. Previously, the algorithm was hardcoded to "ecdsa" in the template. Now users can specify their preferred algorithm through the values.yaml configuration file, with "rsa" as the default.
Key Changes:
- Added configurable
algorithmparameter tolfx.generateHeimdallSignerCertin values.yaml with "rsa" as the default - Updated the template to use the configurable algorithm value instead of hardcoded "ecdsa"
- Updated template comment to reflect the generic nature of the private key generation (removed specific P-256 curve reference)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| charts/lfx-platform/values.yaml | Added algorithm: rsa configuration field with explanatory comment under lfx.generateHeimdallSignerCert |
| charts/lfx-platform/templates/heimdall/heimdall-signer-cert.yaml | Updated genPrivateKey call to use configurable algorithm parameter and generalized the comment |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
charts/lfx-platform/values.yaml (1)
24-25: Document supported algorithm values in the configuration comment.The Sprig
genPrivateKeyfunction acceptsrsa,dsa, andecdsa, but the comment and PR description mentioned25519as an option. If no argument is supplied, it defaults to RSA. Consider updating the comment to clarify which algorithms are supported to prevent configuration errors from invalid values.generateHeimdallSignerCert: enabled: true name: heimdall-signer-cert - # algorithm will be passed as the parameter to Sprig's genPrivateKey. - algorithm: rsa + # algorithm will be passed as the parameter to Sprig's genPrivateKey. + # Supported values: rsa, dsa, ecdsa (defaults to rsa if not specified) + algorithm: rsa
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
charts/lfx-platform/templates/heimdall/heimdall-signer-cert.yaml(1 hunks)charts/lfx-platform/values.yaml(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Upload results
- GitHub Check: MegaLinter
🔇 Additional comments (1)
charts/lfx-platform/templates/heimdall/heimdall-signer-cert.yaml (1)
6-9: LGTM!The template has been properly updated to use the configurable algorithm from values. The comment update from "P-256 curve key" to "private key" is appropriate, and the Helm template syntax correctly accesses
.Values.lfx.generateHeimdallSignerCert.algorithm.
Summary
This PR adds a configurable algorithm option for heimdall key generation that defaults to "rsa" instead of hardcoded behavior.
Changes Made
key_typetoalgorithminvalues.yamlto match what the template was already expectingConfiguration
Users can now configure the private key algorithm by setting:
The algorithm defaults to "rsa" if not specified.
Testing
🤖 Generated with GitHub Copilot (via Zed)