Skip to content

fix: Make the orchestrator plugins list configurable in the default values file [RHDHBUGS-1889] - #194

Merged
rm3l merged 4 commits into
redhat-developer:mainfrom
rm3l:rhdhbugs-1889-techdebt-helm-the-orchestrator-plugins-list-should-be-configurable-in-the-default-values-file
Jul 21, 2025
Merged

fix: Make the orchestrator plugins list configurable in the default values file [RHDHBUGS-1889]#194
rm3l merged 4 commits into
redhat-developer:mainfrom
rm3l:rhdhbugs-1889-techdebt-helm-the-orchestrator-plugins-list-should-be-configurable-in-the-default-values-file

Conversation

@rm3l

@rm3l rm3l commented Jul 18, 2025

Copy link
Copy Markdown
Member

Description of the change

This moves the list of orchestrator plugins to the default values file, allowing them to be configurable without requiring an update to the Chart.

Which issue(s) does this PR fix or relate to

Fixes https://issues.redhat.com/browse/RHDHBUGS-1889

How to test changes / Special notes to the reviewer

No breaking change. The procedure depicted in https://github.com/redhat-developer/rhdh-chart/tree/main/charts/backstage#installing-rhdh-with-orchestrator-on-openshift should work as before.

Checklist

  • For each Chart updated, version bumped in the corresponding Chart.yaml according to Semantic Versioning.
  • For each Chart updated, variables are documented in the values.yaml and added to the corresponding README.md. The pre-commit utility can be used to generate the necessary content. Use pre-commit run -a to apply changes. The pre-commit Workflow will do this automatically for you if needed.
  • JSON Schema template updated and re-generated the raw schema via the pre-commit hook.
  • Tests pass using the Chart Testing tool and the ct lint command.
  • If you updated the orchestrator-infra chart, make sure the versions of the Knative CRDs are aligned with the versions of the CRDs installed by the OpenShift Serverless operators declared in the values.yaml file. See Installing Knative Eventing and Knative Serving CRDs for more details.

Summary by Sourcery

Make the orchestrator plugins list user-configurable by moving it into the default values file and updating the chart templates and documentation accordingly.

Enhancements:

  • Introduce orchestrator.plugins in values.yaml and schema to allow customizing the list of orchestrator plugins
  • Update dynamic-plugins ConfigMap template to iterate over .Values.orchestrator.plugins instead of a hardcoded include
  • Document the new orchestrator.plugins value in README.md and JSON schema
  • Bump the chart version from 4.5.0 to 4.5.1

@sourcery-ai

sourcery-ai Bot commented Jul 18, 2025

Copy link
Copy Markdown

Reviewer's Guide

Expose the orchestrator plugins list in values.yaml for configurability, update related templates and schema, and bump the Helm chart version with corresponding documentation updates.

Entity relationship diagram for orchestrator.plugins configuration

erDiagram
    ORCHESTRATOR ||--o{ PLUGIN : contains
    PLUGIN {
        bool disabled
        string package
        string integrity
        object pluginConfig
    }
Loading

Class diagram for the new orchestrator.plugins structure in values.yaml

classDiagram
    class OrchestratorConfig {
        +bool enabled
        +list plugins
        +bool serverlessLogicOperator.enabled
        +bool serverlessOperator.enabled
        +string sonataflowPlatform.createDBJobImage
    }
    class OrchestratorPlugin {
        +bool disabled
        +string package
        +string integrity
        +object pluginConfig
    }
    OrchestratorConfig "1" o-- "*" OrchestratorPlugin : plugins
Loading

File-Level Changes

Change Details Files
Expose orchestrator plugins as configurable parameters
  • Add orchestrator.plugins list to values.yaml
  • Document new parameter in README.md
  • Update values.schema.json and values.schema.tmpl.json for plugin list
  • Remove unused partials template
charts/backstage/values.yaml
charts/backstage/README.md
charts/backstage/values.schema.json
charts/backstage/values.schema.tmpl.json
charts/backstage/templates/_partials.tpl
Refactor dynamic plugin configmap template
  • Iterate directly over .Values.orchestrator.plugins
  • Remove include-based plugin parsing
charts/backstage/templates/dynamic-plugins-configmap.yaml
Bump Helm chart version
  • Update version to 4.5.1 in Chart.yaml
  • Refresh version badge in README.md
charts/backstage/Chart.yaml
charts/backstage/README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@rm3l
rm3l force-pushed the rhdhbugs-1889-techdebt-helm-the-orchestrator-plugins-list-should-be-configurable-in-the-default-values-file branch from 1249bf5 to 699fa98 Compare July 18, 2025 08:25
@rm3l

rm3l commented Jul 18, 2025

Copy link
Copy Markdown
Member Author

@sourcery-ai review

@sourcery-ai sourcery-ai 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.

Hey @rm3l - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@rm3l
rm3l marked this pull request as ready for review July 18, 2025 09:13
@rm3l

rm3l commented Jul 18, 2025

Copy link
Copy Markdown
Member Author

/cc @elai-shalev

@openshift-ci

openshift-ci Bot commented Jul 18, 2025

Copy link
Copy Markdown

@rm3l: GitHub didn't allow me to request PR reviews from the following users: elai-shalev.

Note that only redhat-developer members and repo collaborators can review this PR, and authors cannot review their own PRs.

Details

In response to this:

/cc @elai-shalev

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@elai-shalev elai-shalev 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.

Looks good, added some questions.

Comment thread charts/backstage/values.schema.json Outdated
Comment thread charts/backstage/values.yaml
Comment thread charts/backstage/values.yaml
…r local and OCI packages

Co-authored-by: Elai Shalev <129178340+elai-shalev@users.noreply.github.com>
@sonarqubecloud

Copy link
Copy Markdown

@rm3l
rm3l requested a review from elai-shalev July 21, 2025 09:52
@rm3l rm3l added the lgtm label Jul 21, 2025
@rm3l
rm3l enabled auto-merge (squash) July 21, 2025 10:08
@rm3l

rm3l commented Jul 21, 2025

Copy link
Copy Markdown
Member Author

/cherry-pick release-1.7

@openshift-cherrypick-robot

Copy link
Copy Markdown

@rm3l: once the present PR merges, I will cherry-pick it on top of release-1.7 in a new PR and assign it to you.

Details

In response to this:

/cherry-pick release-1.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@rm3l
rm3l merged commit b2370c6 into redhat-developer:main Jul 21, 2025
7 of 8 checks passed
@openshift-cherrypick-robot

Copy link
Copy Markdown

@rm3l: #194 failed to apply on top of branch "release-1.7":

Applying: Move Orchestrator plugins to the default values file
Applying: Update schema template
Applying: Bump Chart and regenerate README and schema
Using index info to reconstruct a base tree...
M	charts/backstage/Chart.yaml
M	charts/backstage/README.md
Falling back to patching base and 3-way merge...
Auto-merging charts/backstage/README.md
CONFLICT (content): Merge conflict in charts/backstage/README.md
Auto-merging charts/backstage/Chart.yaml
CONFLICT (content): Merge conflict in charts/backstage/Chart.yaml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0003 Bump Chart and regenerate README and schema

Details

In response to this:

/cherry-pick release-1.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@rm3l
rm3l deleted the rhdhbugs-1889-techdebt-helm-the-orchestrator-plugins-list-should-be-configurable-in-the-default-values-file branch July 21, 2025 11:15
rm3l added a commit to rm3l/rhdh-chart that referenced this pull request Jul 21, 2025
…alues file [RHDHBUGS-1889] (redhat-developer#194)

Co-authored-by: Elai Shalev <129178340+elai-shalev@users.noreply.github.com>
rm3l added a commit that referenced this pull request Jul 21, 2025
… the default values file [RHDHBUGS-1889] (#194) (#196)

Co-authored-by: Elai Shalev <129178340+elai-shalev@users.noreply.github.com>
Co-authored-by: rm3l <rm3l@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants