Skip to content

ci: Add CI values file for testing the Orchestrator flavor [RHIDP-7469] - #177

Merged
rm3l merged 3 commits into
redhat-developer:mainfrom
rm3l:rhidp-7469-add-ci-values-file-testing-the-helm-chart-with-the-orchestrator-enabled
Jun 30, 2025
Merged

ci: Add CI values file for testing the Orchestrator flavor [RHIDP-7469]#177
rm3l merged 3 commits into
redhat-developer:mainfrom
rm3l:rhidp-7469-add-ci-values-file-testing-the-helm-chart-with-the-orchestrator-enabled

Conversation

@rm3l

@rm3l rm3l commented Jun 26, 2025

Copy link
Copy Markdown
Member

Description of the change

This PR adds a CI values file in the backstage chart for testing this Chart with the Orchestrator enabled. Since installing the Orchestrator flavor requires the orchestrator-infra chart, and the operators the orchestrator-infra chart installs are only available in the RH CatalogSource, this tries to install the bare minimum requirements (Knative and SonataFlow CRDs) to have a running instance of the app.
The scope of the tests in the backstage chart is not to have complete app E2E tests, but instead to make sure that the chart is installable and the app starts as expected. So this should be fine for having some minimal testing of this. There is a different Story for full E2E orchestrator testing.

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

Fixes https://issues.redhat.com/browse/RHIDP-7469

How to test changes / Special notes to the reviewer

We can see in the workflow run that the new CI values is being picked in the CI.

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

Add CI support for testing the Orchestrator flavor by introducing a dedicated values file, extending the test workflow to detect Backstage chart changes and install required CRDs, and bump the Backstage chart version.

Enhancements:

  • Introduce a with-orchestrator-values.yaml file to define minimal configuration for testing the Orchestrator flavor

CI:

  • Detect Backstage chart changes in the test workflow and conditionally install Knative and SonataFlow CRDs for Orchestrator tests

Chores:

  • Bump Backstage Helm chart version to 4.2.12

@sourcery-ai

sourcery-ai Bot commented Jun 26, 2025

Copy link
Copy Markdown

Reviewer's Guide

Adds CI support for the Orchestrator flavor by introducing a dedicated values file and enhancing the GitHub Actions workflow to detect Backstage chart changes and install required CRDs.

Class diagram for new Orchestrator CI values file structure

classDiagram
  class OrchestratorCIValues {
    route: enabled (bool)
    upstream.postgresql.primary.persistence.enabled (bool)
    global.dynamic.plugins (list)
    orchestrator.enabled (bool)
  }
  class Plugin {
    package: string
    disabled: bool
  }
  OrchestratorCIValues "1" -- "*" Plugin : dynamic.plugins
Loading

File-Level Changes

Change Details Files
Refactor CI workflow to detect Backstage chart changes and install CRDs
  • Rename list-changed output variable
  • Add conditional flag when Backstage chart is modified
  • Insert step to apply Knative and SonataFlow CRDs before testing
.github/workflows/test.yaml
Introduce Orchestrator-specific CI values file
  • Create with-orchestrator-values.yaml under charts/backstage/ci
  • Enable orchestrator feature and disable default route
  • Configure upstream postgresql persistence and dynamic plugins
charts/backstage/ci/with-orchestrator-values.yaml
Bump Backstage chart version and update documentation badge
  • Increment Chart.yaml version from 4.2.11 to 4.2.12
  • Update README.md version badge to 4.2.12
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 added 3 commits June 26, 2025 12:36
The Orchestrator flavor requires installing the
orchestrator-infra chart as a prerequisite, but
the OpenShift Serverless and Serverless Operators
installed by this chart are available only on OCP
(from the Red Hat Catalog).
And we cannot install the orchestrator-infra-chart
directly here using the
charts/orchestrator-infra/ci/upstream-olm-values.yaml
file because `ct install` on the orchestrator-infra chart
would then fail to install it due to mismatching
resource labels.

For the simple testing that we are doing here on
a vanilla K8s cluster, we only need both the
Knative and SonataFlow CRDs.

Additional nOTES:
- Serverless 1.35 corresponds to Knative 1.18
- Serverless Logic 1.35 corresponds to Sonataflow 1.43
@rm3l
rm3l force-pushed the rhidp-7469-add-ci-values-file-testing-the-helm-chart-with-the-orchestrator-enabled branch from 7753202 to a33c97b Compare June 26, 2025 10:38
@rm3l
rm3l force-pushed the rhidp-7469-add-ci-values-file-testing-the-helm-chart-with-the-orchestrator-enabled branch from a33c97b to c00ae90 Compare June 26, 2025 12:43
@sonarqubecloud

Copy link
Copy Markdown

@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 - here's some feedback:

  • The workflow currently triggers the CRD install step on any Backstage chart change; consider specifically checking for changes to the new ci/with-orchestrator-values.yaml file to avoid unnecessary CRD installs.
  • Rather than pulling the SonataFlow operator manifest unpinned, pin it to a specific digest or vendor the CRD files locally to guard against upstream changes breaking the CI.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The workflow currently triggers the CRD install step on any Backstage chart change; consider specifically checking for changes to the new `ci/with-orchestrator-values.yaml` file to avoid unnecessary CRD installs.
- Rather than pulling the SonataFlow operator manifest unpinned, pin it to a specific digest or vendor the CRD files locally to guard against upstream changes breaking the CI.

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 changed the title [WIP] ci: Add CI values file for testing the Orchestrator flavor [RHIDP-7469] ci: Add CI values file for testing the Orchestrator flavor [RHIDP-7469] Jun 26, 2025
@rm3l
rm3l marked this pull request as ready for review June 26, 2025 13:24
@openshift-ci
openshift-ci Bot requested review from gazarenkov and zdrapela June 26, 2025 13:24

@rm3l rm3l left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This only adds a CI values file, with no impact on the actual chart. Merging to close out https://issues.redhat.com/browse/RHIDP-6159

@rm3l
rm3l merged commit 470b510 into redhat-developer:main Jun 30, 2025
7 of 8 checks passed
@rm3l
rm3l deleted the rhidp-7469-add-ci-values-file-testing-the-helm-chart-with-the-orchestrator-enabled branch June 30, 2025 09:41
rm3l added a commit that referenced this pull request Jun 30, 2025
openshift-merge-bot Bot pushed a commit that referenced this pull request Jun 30, 2025
* chore: Bump `backstage` chart version to fix release workflow

Follow-up to #177

* chore(pre-commit): Auto-fix hooks

Co-authored-by: rm3l <rm3l@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: rm3l <rm3l@users.noreply.github.com>
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.

1 participant