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

Fix controller ingress class and equalize router ingress tls secret #122

Merged
merged 1 commit into from
Mar 20, 2025

Conversation

mangelajo
Copy link
Member

@mangelajo mangelajo commented Mar 20, 2025

Summary by CodeRabbit

  • New Features
    • Enabled dynamic network routing settings by conditionally assigning the routing class based on defined parameters.
    • Improved TLS configuration flexibility by conditionally including certificate details, ensuring a clearer and more customizable secure connection setup.

Copy link

coderabbitai bot commented Mar 20, 2025

Walkthrough

The changes update two Helm template files by conditionally rendering specific fields in Ingress resources. In the controller template, an ingressClassName field is added when .Values.grpc.ingress.class is defined. In the router template, the TLS configuration is reorganized so that the hosts field appears first, and the secretName field is conditionally included if .Values.grpc.tls.routerCertSecret is provided.

Changes

File(s) Change Summary
deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/controller-ingress.yaml Conditionally adds ingressClassName: {{ .Values.grpc.ingress.class }} to the Ingress specification when the corresponding value is defined.
deploy/helm/jumpstarter/charts/jumpstarter-controller/.../router-ingress.yaml Reorders TLS configuration: ensures hosts is defined first and conditionally includes secretName after hosts if .Values.grpc.tls.routerCertSecret is provided.

Sequence Diagram(s)

sequenceDiagram
    participant H as Helm Engine
    participant C as Controller Ingress Template
    H->>C: Process template
    alt .Values.grpc.ingress.class is defined
        C->>C: Add ingressClassName field
    else
        C->>C: Omit ingressClassName field
    end
Loading
sequenceDiagram
    participant H as Helm Engine
    participant R as Router Ingress Template
    H->>R: Process template
    R->>R: Render hosts field
    alt .Values.grpc.tls.routerCertSecret is defined
        R->>R: Add secretName field after hosts
    else
        R->>R: Omit secretName field
    end
Loading

Possibly related PRs

Suggested reviewers

  • bennyz

Poem

I'm a rabbit hopping along the code lane,
Fields dance in YAML, in sunshine and rain.
Conditional branches, a skip and a hop,
Making our configurations perfectly pop!
Hop on board, let's celebrate this change without a flop!
🐰✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between be48119 and 373dac3.

📒 Files selected for processing (2)
  • deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/controller-ingress.yaml (2 hunks)
  • deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/router-ingress.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: e2e-tests (ubuntu-24.04-arm)
  • GitHub Check: e2e-tests-28d6b1cc3b49ab9ae176918ab9709a2e2522c97e
🔇 Additional comments (4)
deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/controller-ingress.yaml (2)

14-16: Dynamic Ingress Class Inclusion
The conditional block that adds the ingressClassName field when .Values.grpc.ingress.class is defined meets the PR objective and enhances configuration flexibility. Please verify that the Helm templating renders the YAML with proper indentation under spec:.


39-41: Conditional TLS Secret for Controller
The conditional inclusion of the secretName field using .Values.grpc.tls.controllerCertSecret is clear and aligns with the design goals. Ensure that when the condition is false, the generated YAML does not include any extraneous whitespace that might affect the YAML structure.

deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/router-ingress.yaml (2)

14-16: Consistent Ingress Class Configuration
The same conditional block for ingressClassName as seen in the controller template has been applied to the router template. This promotes consistency across components. As before, please ensure that the rendered YAML maintains correct indentation.


33-41: Restructured TLS Block for Router
The TLS configuration has been reorganized so that the hosts field is declared first, followed by the conditional secretName field (using .Values.grpc.tls.routerCertSecret). This change improves clarity and aligns with the PR objective of "equalizing router ingress tls secret" handling. Verify that the YAML output is valid when the secret value is omitted.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@mangelajo mangelajo force-pushed the ingress-class-continuation2 branch from 3fb82cb to 373dac3 Compare March 20, 2025 09:17
@mangelajo mangelajo requested a review from bennyz March 20, 2025 10:02
@mangelajo mangelajo merged commit 73628b2 into main Mar 20, 2025
8 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