Skip to content

ROX-33119: Allow operator install method on non-OpenShift platforms#19446

Draft
sachaudh wants to merge 6 commits intomasterfrom
ROX-33119/operator-instructions-non-openshift
Draft

ROX-33119: Allow operator install method on non-OpenShift platforms#19446
sachaudh wants to merge 6 commits intomasterfrom
ROX-33119/operator-instructions-non-openshift

Conversation

@sachaudh
Copy link
Contributor

@sachaudh sachaudh commented Mar 16, 2026 •
edited
Loading

Description

Jira: ROX-33119

The Operator installation method was restricted to OpenShift only. Users selecting EKS, AKS, or GKE were forced to use Helm chart, even though the RHACS Operator now supports non-OpenShift platforms.

Changes

  • Remove platform gating that disabled the Operator option for non-OpenShift platforms in InitBundleForm
  • Remove onChangePlatform logic that force-switched installation to Helm when a non-OpenShift platform was selected
  • Narrow InstallationKey and PlatformKey types with oneOf validation in the Yup schema instead of loose string types
  • Update operator instruction text in both Init Bundles and Cluster Registration Secrets flows:
    • Add "(OpenShift)" labels to documentation links to clarify they are OpenShift-specific
    • Replace OpenShift-specific prerequisite language with platform-neutral instructions and nested sub-bullets for OpenShift (OperatorHub) vs other platforms (Helm chart)
    • Add kubectl command option alongside the existing oc command
    • Use generic placeholder filenames (<init-bundle-file>.yaml, <cluster-registration-secret-file>.yaml)
    • Tighten and simplify wording throughout

User-facing documentation

Testing and quality

  • the change is production ready: the change is GA, or otherwise the functionality is gated by a feature flag
  • CI results are inspected

Automated testing

  • added unit tests
  • added e2e tests
  • added regression tests
  • added compatibility tests
  • modified existing tests

How I validated my change

  • Verified Operator option remains enabled when selecting EKS, AKS, or GKE platforms
  • Verified dropdown shows both "Operator (recommended)" and "Helm chart" for all platforms
  • Verified operator instruction text renders correctly with platform-neutral language, nested sub-bullets, and kubectl commands on both Init Bundles and Cluster Registration Secrets flows
  • No type errors or lint warnings

Visuals

Screen.Recording.2026-03-17.at.12.12.00.PM.mov
Screenshot 2026-03-17 at 12 10 49 PM Screenshot 2026-03-17 at 12 10 59 PM Screenshot 2026-03-17 at 12 13 22 PM Screenshot 2026-03-17 at 12 13 29 PM

sachaudh added 2 commits March 16, 2026 13:54
@sachaudh
feat(clusters): allow operator install method on non-OpenShift platforms
e744bb2 
ROX-33119: Remove platform gating that restricted the Operator
installation method to OpenShift only. Update instruction text in
both Init Bundles and CRS flows to be platform-neutral, with
qualified sub-bullets for OpenShift vs other platforms and kubectl
as an alternative to oc.

Signed-off-by: Saif Chaudhry <schaudhr@redhat.com>
@sachaudh
fix(clusters): simplify onChangePlatform and fix ClipboardCopy whites…
01b1c35 
…pace

Simplify onChangePlatform to only set the platform field instead of
resetting installation to Operator on every platform switch, which
silently overrode the user's selection. Also fix ClipboardCopy in
CRS operator instructions where line wrapping caused whitespace in
the copied command text.

Signed-off-by: Saif Chaudhry <schaudhr@redhat.com>
@openshift-ci
Copy link

openshift-ci bot commented Mar 16, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

sachaudh added 4 commits March 16, 2026 15:37
@sachaudh
refactor(clusters): narrow InstallationKey and PlatformKey types
550afd8 
Remove Record<string, string> annotations that widened as const
types, so InstallationKey resolves to 'Operator' | 'Helm' and
PlatformKey to 'OpenShift' | 'EKS' | 'AKS' | 'GKE'. Add oneOf
validators to the yup schema for compile-time and runtime safety.

Signed-off-by: Saif Chaudhry <schaudhr@redhat.com>
@sachaudh
fix(clusters): correct grammar in operator instruction text
aec708c 
Add missing article in heading ("using the Operator installation
method"), replace awkward colon with comma in OpenShift web console
bullet, remove redundant clause, and fix plural "secrets" to
singular "secret" in CRS apply step.

Signed-off-by: Saif Chaudhry <schaudhr@redhat.com>
@sachaudh
fix(clusters): simplify operator prerequisite wording
d95da09 
Rewrite "In the cluster that you are securing, you have installed
the RHACS Operator" to lead with the action for clarity.

Signed-off-by: Saif Chaudhry <schaudhr@redhat.com>
@sachaudh
fix(clusters): tighten wordy instruction text
edf5a64 
Remove "by" from "by using", replace redundant "YAML file for the
init bundle/cluster registration secret" with "its YAML file",
shorten "Perform one of the following tasks to apply..." to "Apply
it using one of the following methods:", and simplify the final
install step.

Signed-off-by: Saif Chaudhry <schaudhr@redhat.com>
@rhacs-bot
Copy link
Contributor

rhacs-bot commented Mar 16, 2026 •
edited
Loading

Images are ready for the commit at edf5a64.

To use with deploy scripts, first export MAIN_IMAGE_TAG=4.11.x-344-gedf5a648e4.

@codecov
Copy link

codecov bot commented Mar 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.56%. Comparing base (7593465) to head (edf5a64).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #19446      +/-   ##
==========================================
- Coverage   49.56%   49.56%   -0.01%     
==========================================
  Files        2711     2711              
  Lines      204849   204849              
==========================================
- Hits       101528   101527       -1     
+ Misses      95741    95740       -1     
- Partials     7580     7582       +2
Flag Coverage Δ
go-unit-tests 49.56% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sachaudh
Copy link
Contributor Author

sachaudh commented Mar 17, 2026

test

@sachaudh sachaudh requested a review from porridge March 17, 2026 19:27
@sachaudh sachaudh changed the title feat(clusters): allow operator install method on non-OpenShift platforms ROX-33119: Allow operator install method on non-OpenShift platforms Mar 17, 2026
sachaudh
sachaudh commented Mar 17, 2026
View reviewed changes
ui/apps/platform/src/Containers/Clusters/InitBundles/SecureClusterUsingOperator.tsx
</p>
</ListItem>
<ListItem>
<p>You have installed the RHACS Operator on the cluster you are securing.</p>
Copy link
Contributor Author

@sachaudh sachaudh Mar 17, 2026

Choose a reason for hiding this comment

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

@porridge, I changed this from the suggested: "In the cluster that you are securing, you have installed the RHACS Operator". This puts the action first and tacks on the location as a simple prepositional phrase at the end, which feels more direct.

I see that we use fronted prepositional phrases with a relative clause in other areas too. Your suggestion probably followed the same pattern, but I wonder if we could make this page a bit clearer.

Do you know who we could ask about that? @mansursyed @zhenpesky, this might be relevant for you both, too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@porridge porridge Awaiting requested review from porridge

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

area/ui do-not-merge/work-in-progress

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sachaudh @rhacs-bot