Skip to content

fix: Enable to slow rollout of additional api ingress routes #398

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

Merged
merged 3 commits into from
Apr 30, 2025

Conversation

dacbd
Copy link
Contributor

@dacbd dacbd commented Apr 30, 2025

ref: INFRA-888

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Added configurable options to enable additional API path prefixes (such as analytics, oidc, proxy, files, debug, service_redirect, service_dangerzone, scim, and admin) for ingress routing.
  • Chores
    • Updated the Helm chart version to 0.29.1.

Copy link
Contributor

coderabbitai bot commented Apr 30, 2025

Walkthrough

This update introduces new configurable ingress paths for the API service in the operator-wandb Helm chart. A new additionalPaths section is added to values.yaml, allowing users to enable or disable specific API-related ingress paths such as /analytics, /oidc, /proxy, and others. The ingress template is updated to conditionally create these paths based on the values provided. The Helm chart version is incremented from 0.29.0 to 0.29.1.

Changes

File(s) Change Summary
charts/operator-wandb/Chart.yaml Bumped Helm chart version from 0.29.0 to 0.29.1.
charts/operator-wandb/templates/_ingress.tpl Updated ingress template to conditionally add multiple API path prefixes based on new values.
charts/operator-wandb/values.yaml Added global.api.additionalPaths section with boolean flags for various API-related ingress paths.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Ingress Controller
    participant API Service

    User->>Ingress Controller: Request to /api/{path}
    alt Path enabled in additionalPaths
        Ingress Controller->>API Service: Forward to backend (port 8081)
    else Path not enabled
        Ingress Controller-->>User: Path not found/handled by other rules
    end
Loading

Suggested reviewers

  • jsbroks
  • vanpelt
  • danielpanzella

Poem

🐇
A hop and a skip, new paths appear,
Ingress rules now crystal clear.
Toggle your routes, just set a flag,
Helm chart updated—no need to lag.
Version’s up, the chart’s refined,
More control for peace of mind!


📜 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 9983a75 and 6b13ab6.

📒 Files selected for processing (1)
  • charts/operator-wandb/templates/_ingress.tpl (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • charts/operator-wandb/templates/_ingress.tpl
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: Test Chart (v1.29.14, separate-pods)
  • GitHub Check: Test Chart (v1.29.14, user-defined-secrets)
  • GitHub Check: Test Chart (v1.29.14, executor-enabled)
  • GitHub Check: Test Chart (v1.29.14, default)
  • GitHub Check: Test Chart (v1.30.10, separate-pods)
  • GitHub Check: Test Chart (v1.30.10, user-defined-secrets)
  • GitHub Check: Test Chart (v1.30.10, executor-enabled)
  • GitHub Check: Test Chart (v1.30.10, default)
  • GitHub Check: Test Chart (v1.31.6, separate-pods)
  • GitHub Check: Test Chart (v1.31.6, user-defined-secrets)
  • GitHub Check: Test Chart (v1.31.6, executor-enabled)
  • GitHub Check: Test Chart (v1.31.6, default)
  • GitHub Check: Test Chart (v1.32.2, separate-pods)
  • GitHub Check: Test Chart (v1.32.2, user-defined-secrets)
  • GitHub Check: Test Chart (v1.32.2, executor-enabled)
  • GitHub Check: Test Chart (v1.32.2, default)

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
charts/operator-wandb/templates/_ingress.tpl (1)

76-156: Consider documenting the purpose of each path.

The implementation logic is clean, but it would be helpful to have comments that briefly describe the purpose of each API path and when users might want to enable it.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0cf0457 and 9983a75.

📒 Files selected for processing (3)
  • charts/operator-wandb/Chart.yaml (1 hunks)
  • charts/operator-wandb/templates/_ingress.tpl (1 hunks)
  • charts/operator-wandb/values.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (16)
  • GitHub Check: Test Chart (v1.29.14, separate-pods)
  • GitHub Check: Test Chart (v1.29.14, user-defined-secrets)
  • GitHub Check: Test Chart (v1.29.14, executor-enabled)
  • GitHub Check: Test Chart (v1.29.14, default)
  • GitHub Check: Test Chart (v1.30.10, separate-pods)
  • GitHub Check: Test Chart (v1.30.10, user-defined-secrets)
  • GitHub Check: Test Chart (v1.30.10, executor-enabled)
  • GitHub Check: Test Chart (v1.30.10, default)
  • GitHub Check: Test Chart (v1.31.6, separate-pods)
  • GitHub Check: Test Chart (v1.31.6, user-defined-secrets)
  • GitHub Check: Test Chart (v1.31.6, executor-enabled)
  • GitHub Check: Test Chart (v1.31.6, default)
  • GitHub Check: Test Chart (v1.32.2, separate-pods)
  • GitHub Check: Test Chart (v1.32.2, user-defined-secrets)
  • GitHub Check: Test Chart (v1.32.2, executor-enabled)
  • GitHub Check: Test Chart (v1.32.2, default)
🔇 Additional comments (2)
charts/operator-wandb/values.yaml (1)

209-219: Well-structured addition of configurable API paths.

The new additionalPaths section provides a clean way to selectively enable specific API routes. Setting all paths to false by default is a good practice that ensures a controlled rollout of these additional routes.

charts/operator-wandb/Chart.yaml (1)

5-5: Appropriate version bump for the feature addition.

The chart version has been correctly incremented from 0.29.0 to 0.29.1, which follows semantic versioning principles for a non-breaking feature addition.

Copy link

linear bot commented Apr 30, 2025

@dacbd dacbd changed the title chore: Enable to slow rollout of additional api ingress routes fix: Enable to slow rollout of additional api ingress routes Apr 30, 2025
@dacbd dacbd merged commit fa80ece into main Apr 30, 2025
19 checks passed
@dacbd dacbd deleted the dacbd/ingress-rollout branch April 30, 2025 20:51
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