Skip to content

feat: add extensions support to local-setup#993

Open
silvi-t wants to merge 1 commit into
Kuadrant:mainfrom
silvi-t:local-setup-with-extension
Open

feat: add extensions support to local-setup#993
silvi-t wants to merge 1 commit into
Kuadrant:mainfrom
silvi-t:local-setup-with-extension

Conversation

@silvi-t

@silvi-t silvi-t commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Important

This PR modifies shared/core testsuite code that could potentially affect multiple test areas. 2 reviewers should review this PR to ensure adequate coverage.

Description

  • Add opt-in support for deploying Kuadrant extensions during local-setup via INSTALL_EXTENSIONS=true
  • The new deploy-extensions Make target patches the operator deployment with an init container that injects extension binaries from a configurable container image
  • Extensions are disabled by default and require a user-provided manifests file (extensions-manifests.yaml)

Changes

New Features

  • New deploy-extensions target in make/kuadrant.mk that applies CRDs/RBAC from a manifests file and patches kuadrant-operator-controller-manager with an init container and emptyDir volume at /extensions
  • New variables in make/vars.mk: INSTALL_EXTENSIONS, EXTENSIONS_IMAGE, EXTENSIONS_MANIFESTS
  • Extensions step integrated into local-setup target in make/local-setup.mk (runs between deploy-kuadrant-operator and deploy-kuadrant-cr)
  • Setup summary now shows extensions status when enabled

Documentation

  • Added .claude/rules/extensions-setup.md with usage guide, environment variables, and manifests format
  • Updated CLAUDE.md with extensions usage example
  • Added extensions-manifests.yaml to .gitignore (user-specific content)

Verification steps

  • No test files were added or modified in this PR
  • Prerequisites: Before running with extensions, place your extensions-manifests.yaml file in the repository root, or specify a custom path via EXTENSIONS_MANIFESTS=/path/to/manifests.yaml
  • Verify extensions deployment manually:
    # Without extensions (default, should work as before)
    make local-setup
    
    # With extensions (manifests in repo root)
    INSTALL_EXTENSIONS=true make local-setup
    
    # With extensions (custom manifests path)
    INSTALL_EXTENSIONS=true EXTENSIONS_MANIFESTS=~/my-extensions/manifests.yaml make local-setup
    
    # Deploy extensions to existing cluster
    INSTALL_EXTENSIONS=true make deploy-extensions
  • Verify error handling when manifests file is missing:
    INSTALL_EXTENSIONS=true EXTENSIONS_MANIFESTS=nonexistent.yaml make deploy-extensions

Closes #992

Summary by CodeRabbit

  • New Features

    • Added optional extensions support for Kuadrant, enabling users to deploy extensions during local setup via INSTALL_EXTENSIONS=true parameter. Extensions are disabled by default.
  • Documentation

    • Added comprehensive guides covering extensions setup, configuration variables, and usage examples for local and cluster deployments.

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@silvi-t, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 27 minutes and 6 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a472aa64-6467-4d02-bf14-57ba7db154d7

📥 Commits

Reviewing files that changed from the base of the PR and between 2051ef9 and e97464b.

📒 Files selected for processing (6)
  • .claude/rules/extensions-setup.md
  • .gitignore
  • CLAUDE.md
  • make/kuadrant.mk
  • make/local-setup.mk
  • make/vars.mk
📝 Walkthrough

Walkthrough

This PR adds opt-in extension support to the Kuadrant local Kind cluster setup, enabling custom controller binaries to be injected into the operator container via init containers and emptyDir volumes. Configuration is controlled by three new make variables, a deploy-extensions target patches the operator deployment, and integration into the local-setup workflow is conditional on the INSTALL_EXTENSIONS flag.

Changes

Extensions Support for Local Kind Setup

Layer / File(s) Summary
Configuration variables
make/vars.mk
Introduces INSTALL_EXTENSIONS, EXTENSIONS_IMAGE, and EXTENSIONS_MANIFESTS variables with sensible defaults to control whether extensions are deployed and from where.
Deploy-extensions implementation
make/kuadrant.mk
Implements the deploy-extensions target that validates manifests file existence, applies extension CRDs/RBAC, and patches the kuadrant-operator-controller-manager deployment to add an emptyDir volume, init container that copies extension binaries from a container image, and mounts the binaries at /extensions in the manager container.
Local setup wiring
make/local-setup.mk
Conditionally calls deploy-extensions from local-setup when INSTALL_EXTENSIONS=true, executing after base operator deployment, and extends completion output to report extensions status.
Documentation and repository configuration
.claude/rules/extensions-setup.md, CLAUDE.md, .gitignore
Adds comprehensive documentation explaining extensions setup, environment variables, usage examples, and manifest file format; adds quick-start guidance to setup docs; and ignores user-specific extensions-manifests.yaml file.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested labels

documentation

Suggested reviewers

  • emmaaroche

Poem

🐰 Extensions now hop into Kind with ease,
Binaries bundled, operators please!
Init containers copy what's needed in haste,
Opt-in deployment, no setup to waste.
Make local-setup, and watch extensions bloom! 🌱

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main feature addition—extensions support for local-setup—and follows conventional commits format.
Description check ✅ Passed The PR description is comprehensive, covering objectives, changes, documentation, and verification steps. It includes all key information despite the important note about test suite modifications.
Linked Issues check ✅ Passed All coding requirements from issue #992 are met: opt-in extensions via INSTALL_EXTENSIONS, deploy-extensions target with deployment patching, manifest validation, rollout wait, variables in vars.mk, and integration into local-setup.
Out of Scope Changes check ✅ Passed All changes directly support extensions deployment as specified in issue #992. Documentation, make targets, variables, and gitignore updates are all within scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@silvi-t

silvi-t commented Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@make/kuadrant.mk`:
- Around line 102-113: The JSON Patch used in the kubectl patch command will
fail if /spec/template/spec/initContainers already exists because the add
operation targets "/spec/template/spec/initContainers" instead of appending;
update the kubectl patch invocation that modifies the
kuadrant-operator-controller-manager deployment so it either appends to the
initContainers array (use the "/spec/template/spec/initContainers/-" path) or
switch to a strategic merge patch to merge/init/create initContainers safely
(apply the change that references the same containers block where volumes and
containers/0/volumeMounts are handled, keeping the copy-extensions init
container using $(EXTENSIONS_IMAGE) and the extensions-binary-volume
volumeMount).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2b2fba7b-e3e2-4f3d-a86c-0cc8b6681c96

📥 Commits

Reviewing files that changed from the base of the PR and between 4796963 and 2051ef9.

📒 Files selected for processing (6)
  • .claude/rules/extensions-setup.md
  • .gitignore
  • CLAUDE.md
  • make/kuadrant.mk
  • make/local-setup.mk
  • make/vars.mk

Comment thread make/kuadrant.mk Outdated
Signed-off-by: Silvia Tarabova <starabov@redhat.com>
@silvi-t silvi-t force-pushed the local-setup-with-extension branch from 2051ef9 to e97464b Compare June 4, 2026 10:31
@silvi-t silvi-t self-assigned this Jun 4, 2026
@silvi-t silvi-t requested a review from a team June 4, 2026 10:37
@silvi-t silvi-t added this to Kuadrant Jun 4, 2026
@silvi-t silvi-t moved this to Ready For Review in Kuadrant Jun 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Ready For Review

Development

Successfully merging this pull request may close these issues.

Add extension support to local Kind setup

1 participant