Skip to content

feat(supervisor): optionally strip digests from image refs #2410

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 2 commits into from
Aug 18, 2025

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Aug 18, 2025

This can be switched on to help fix pull-through cache issues.

Copy link

changeset-bot bot commented Aug 18, 2025

⚠️ No Changeset found

Latest commit: 518fe8b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Aug 18, 2025

Walkthrough

  • Adds KUBERNETES_STRIP_IMAGE_DIGEST: BoolEnv.default(false) to the Env schema in apps/supervisor/src/env.ts.
  • In apps/supervisor/src/workloadManager/kubernetes.ts, adds a private helper stripImageDigest(imageRef: string) that conditionally removes the portion after the last "@" when the env flag is true.
  • Updates the image used in pod creation to pass opts.image through stripImageDigest based on the environment flag.
  • No public API signatures changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/k8s-strip-digest

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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: 0

🧹 Nitpick comments (2)
apps/supervisor/src/env.ts (1)

79-79: Update documentation and deployment templates for KUBERNETES_STRIP_IMAGE_DIGEST

  • Add the new flag to docs/self-hosting/env/supervisor.mdx under “Kubernetes settings” (currently only DOCKER_STRIP_IMAGE_DIGEST appears). For example:

    | KUBERNETES_STRIP_IMAGE_DIGEST | No | false | Strip image digest in Kubernetes. Turning on will remove the digest from pulled images. |
    
  • Review your Helm charts/values.yaml and any deployment templates to expose KUBERNETES_STRIP_IMAGE_DIGEST alongside the Docker equivalent.

  • If you maintain an env-var schema or CLI reference, include the new flag there as well so operators see its default and description.

apps/supervisor/src/workloadManager/kubernetes.ts (1)

52-64: Digest stripping helper is straightforward; consider mild hardening and reuse

This does the job and matches the PR intent. Two optional improvements:

  • Safety: optionally only strip when what follows “@” looks like an OCI digest (e.g., algo:hex), to guard against any unexpected “@” usage.
  • Reuse: we already have DOCKER_STRIP_IMAGE_DIGEST semantics elsewhere; consider centralizing stripping logic in a tiny shared util to keep behavior consistent across orchestrators.

Optional tweak within this method to gate on a digest-like pattern:

   private stripImageDigest(imageRef: string): string {
     if (!env.KUBERNETES_STRIP_IMAGE_DIGEST) {
       return imageRef;
     }

-    const atIndex = imageRef.lastIndexOf("@");
+    const atIndex = imageRef.lastIndexOf("@");
     if (atIndex === -1) {
       return imageRef;
     }
-
-    return imageRef.substring(0, atIndex);
+    const digest = imageRef.slice(atIndex + 1);
+    // Only strip if the remainder looks like an OCI digest: "<algo>:<hex>"
+    if (!/^[a-z0-9]+:[A-Fa-f0-9]{32,}$/.test(digest)) {
+      return imageRef;
+    }
+    return imageRef.slice(0, atIndex);
   }
📜 Review details

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

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0b35cc3 and 518fe8b.

📒 Files selected for processing (2)
  • apps/supervisor/src/env.ts (1 hunks)
  • apps/supervisor/src/workloadManager/kubernetes.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

**/*.{ts,tsx}: Always prefer using isomorphic code like fetch, ReadableStream, etc. instead of Node.js specific code
For TypeScript, we usually use types over interfaces
Avoid enums
No default exports, use function declarations

Files:

  • apps/supervisor/src/env.ts
  • apps/supervisor/src/workloadManager/kubernetes.ts
🧬 Code Graph Analysis (2)
apps/supervisor/src/env.ts (2)
apps/supervisor/src/envUtil.ts (1)
  • BoolEnv (15-17)
apps/webapp/app/utils/boolEnv.ts (1)
  • BoolEnv (12-14)
apps/supervisor/src/workloadManager/kubernetes.ts (2)
apps/supervisor/src/env.ts (1)
  • env (105-105)
apps/webapp/app/env.server.ts (1)
  • env (1065-1065)
⏰ 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). (14)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: typecheck / typecheck
🔇 Additional comments (1)
apps/supervisor/src/workloadManager/kubernetes.ts (1)

91-91: Verified: stripImageDigest covers all Kubernetes image assignments — LGTM

I ran rg -n '\bopts\.image\b' apps/supervisor/src/workloadManager and confirmed that the only Kubernetes spec referencing opts.image is in kubernetes.ts (line 91), where stripImageDigest(opts.image) is applied. All current container images are handled correctly. If you add initContainers or sidecars in the future, please ensure they also use stripImageDigest.

@matt-aitken matt-aitken merged commit 112f6f6 into main Aug 18, 2025
31 checks passed
@matt-aitken matt-aitken deleted the feat/k8s-strip-digest branch August 18, 2025 14:08
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