Make authentication config a helm value #85
Conversation
WalkthroughThis pull request modifies the authentication configuration in the Jumpstarter Helm chart. In the controller ConfigMap, the previous hardcoded multi-line YAML block for authentication is removed and replaced with a Helm template function that dynamically sources the configuration from Helm values. Additionally, a new parameter named Changes
Sequence Diagram(s)(No sequence diagram generated as the changes pertain solely to configuration updates.) Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
deploy/helm/jumpstarter/values.yaml (1)
77-104: Consider moving sensitive data to a separate secret.The example configuration includes sensitive data (certificate) directly in the values file. While this is just an example, it's good practice to:
- Move sensitive data to a Kubernetes secret
- Reference the secret in the authentication configuration
Here's an example of how to modify the configuration to use a secret:
authenticationConfig: | apiVersion: jumpstarter.dev/v1alpha1 kind: AuthenticationConfiguration # jwt: # - issuer: # url: https://10.239.206.8:5556/dex # audiences: # - jumpstarter # audienceMatchPolicy: MatchAny - # certificateAuthority: | - # -----BEGIN CERTIFICATE----- - # MIIB/DCCAYKgAwIBAgIIcpC2uS+SjEIwCgYIKoZIzj0EAwMwIDEeMBwGA1UEAxMV - # bWluaWNhIHJvb3QgY2EgNzI5MGI2MCAXDTI1MDIwMzE5MzMyNVoYDzIxMjUwMjAz - # MTkzMzI1WjAgMR4wHAYDVQQDExVtaW5pY2Egcm9vdCBjYSA3MjkwYjYwdjAQBgcq - # hkjOPQIBBgUrgQQAIgNiAAQzezKJ4My35HPeoJvvzTjhS2uJMBYrYfrs5csxZjiy - # q8ORrHM539XhWlA6sVZODhzcF2KL4mC9xKz/yIrsws+LKsIWNHGGmIPEKFYnHBGw - # VBGeARvhpzZP/9frJXAN/8ejgYYwgYMwDgYDVR0PAQH/BAQDAgKEMB0GA1UdJQQW - # MBQGCCsGAQUFBwMBBggrBgEFBQcDAjASBgNVHRMBAf8ECDAGAQH/AgEAMB0GA1Ud - # DgQWBBSZRBCUuP3ta2xsfjnWIjvgvz4fojAfBgNVHSMEGDAWgBSZRBCUuP3ta2xs - # fjnWIjvgvz4fojAKBggqhkjOPQQDAwNoADBlAjADql5Ks5wh181iUa1ZBnx4XOVe - # l0l7I+mwlwJSPmkZHxruWZTx7gQU4tfDCr+UuzUCMQC2aDXRb17cphipK4gzbExv - # EDLExjhHAqMPrKDmT0jHIi7Bbos38/1tyZ/IoKjLnv0= - # -----END CERTIFICATE----- + # certificateAuthoritySecret: + # name: oidc-ca-cert + # key: ca.crtThen create a secret with the certificate:
apiVersion: v1 kind: Secret metadata: name: oidc-ca-cert type: Opaque data: ca.crt: <base64-encoded-certificate>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/cms/controller-cm.yaml(1 hunks)deploy/helm/jumpstarter/values.yaml(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: lint-go
- GitHub Check: e2e-tests
- GitHub Check: deploy-kind
- GitHub Check: tests
🔇 Additional comments (2)
deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/cms/controller-cm.yaml (1)
13-13: LGTM! Verify the indentation level.The change correctly moves the authentication configuration to a Helm value. The use of
toYamlandindentfunctions is appropriate for this use case.Run the following script to verify the indentation level:
❌ Verification inconclusive
🏁 Script executed:
#!/bin/bash # Description: Verify the indentation level of the authentication configuration. # Test: Check if the indentation level matches the expected structure. # Expect: The authentication field should be at the same level as other fields under data. helm template . --show-only deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/cms/controller-cm.yaml | yq evalLength of output: 314
Indicate Manual Verification for Indentation Level
The shell script did not produce output because the
helmandyqcommands were not found. This prevents us from automatically verifying the indentation level. Please run this verification command in an environment where bothhelmandyqare installed to confirm that theauthenticationfield is correctly indented.deploy/helm/jumpstarter/values.yaml (1)
39-39: LGTM! Documentation is clear and references official Kubernetes docs.The parameter is well-documented with a clear reference to the official Kubernetes documentation.
|
🚀 |
2 participants
Summary by CodeRabbit