CONSOLE-5288: Add OpenShift Quickstart for JBoss EAP 8#932
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@jmesnil: This pull request references ODC-7555 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.18.0" version, but no target version was set. DetailsIn response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
1 similar comment
|
@jmesnil: This pull request references ODC-7555 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.18.0" version, but no target version was set. DetailsIn response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
|
/retest |
|
/lgtm @opayne1 could you please take a look at this QuickStart. :) |
openshift-ci
Bot
added
lgtm
opayne1
left a comment
opayne1
left a comment
There was a problem hiding this comment.
Looks good! Just had a few comments.
|
|
||
| 1. In the navigation menu, click [Topology]{{highlight qs-nav-topology}}. | ||
| In the Topology view, the **eap8** deployment displays a code icon in the bottom right-hand corner. This icon either represents the Git repository | ||
| of the associated code, or if the appropriate operators are installed, it will bring up the associated code in your IDE. |
There was a problem hiding this comment.
| of the associated code, or if the appropriate operators are installed, it will bring up the associated code in your IDE. | |
| of the associated code, or if the appropriate operators are installed, it will open the associated code in your IDE. |
|
Issues go stale after 90d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle stale |
openshift-ci
Bot
added
the
lifecycle/stale
|
Stale issues rot after 30d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle rotten |
openshift-ci
Bot
added
lifecycle/rotten
|
/retest-required |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: jmesnil The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
openshift-ci
Bot
removed
the
approved
jmesnil
force-pushed
the
ODC-7555_quickstart_jboss_eap8
branch
from
a3a4859 to
829f308
Compare
|
Thanks for the updates. /label docs-approved |
openshift-ci
Bot
added
the
docs-approved
|
Rotten issues close after 30d of inactivity. Reopen the issue by commenting /close |
|
@openshift-bot: Closed this PR. DetailsIn response to this:
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. |
|
/reopen. This feature is still valid and something we want to do |
|
/reopen |
|
/uncc |
openshift-ci
Bot
requested review from
jhadvig
and removed request for
christoph-jerolimov
|
/retest |
|
Issues go stale after 90d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle stale |
openshift-ci
Bot
added
the
lifecycle/stale
|
Stale issues rot after 30d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle rotten |
openshift-ci
Bot
added
lifecycle/rotten
|
Rotten issues close after 30d of inactivity. Reopen the issue by commenting /close |
|
@openshift-bot: Closed this PR. DetailsIn response to this:
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. |
|
/reopen |
|
@jmesnil: Reopened this PR. DetailsIn response to this:
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. |
|
@jmesnil: This pull request references ODC-7555 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
|
This PR has been opened for more than an year with no clear indication on whether it will be merged or not. I've reopened this PR because we still want to provide an OpenShift QuickStart for EAP 8 but how can I proceed to avoid getting this PR become stale again? |
| - description: >- | ||
| To create a JBoss EAP 8 application: | ||
|
|
||
| 1. In the main navigation, click the dropdown menu [perspective switcher]{{highlight qs-perspective-switcher}} and select **Developer**. |
There was a problem hiding this comment.
@jmesnil we dropped the Developer perspective, a few releases ago.
so you can skip this step. actually the steps should be:
1. If present, click on the [perspective switcher]{{highlight qs-perspective-switcher}} and select **Core platform**.
1. In the main navigation menu, select [Ecosystem]{{highlight qs-nav-ecosystem}} and select **Software Catalog**.
1. In the **Software Catalog** page, click **Helm Charts** in the **Type** filter.
1. In the **Helm Charts** catalog, search for **JBoss EAP 8**.basically you need to updated it to follow the eap7 steps
jmesnil
force-pushed
the
ODC-7555_quickstart_jboss_eap8
branch
from
829f308 to
a8803d2
Compare
|
Warning Review limit reached
More reviews will be available in 3 minutes and 38 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 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 configurationConfiguration used: Repository YAML (base), Central YAML (inherited) Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
WalkthroughAdds a new ConsoleQuickStart manifest ( ChangesJBoss EAP 8.1 Helm Quick Start
Sequence Diagram(s)Not applicable. This is a declarative QuickStart manifest describing UI-guided steps rather than a new multi-component runtime control flow requiring external visualization. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 14 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (14 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
jmesnil
changed the title
|
@jmesnil: This pull request references CONSOLE-5288 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@quickstarts/jboss-eap81-with-helm.yaml`:
- Around line 5-9: The metadata.annotations block in the quickstart manifest is
missing the Hypershift cluster-profile annotation; update the annotations (the
metadata.annotations map in quickstarts/jboss-eap81-with-helm.yaml) to add
include.release.openshift.io/hypershift: "true" alongside the existing
include.release.openshift.io/ibm-cloud-managed,
include.release.openshift.io/self-managed-high-availability and
include.release.openshift.io/single-node-developer entries so the CVO manifest
targets the Hypershift profile.
- Around line 174-187: Fix the user-facing typos in the pod-status instructions
by editing the strings shown in the diff: change "Inside the pod circle, it
displays the number of pod." to "Inside the pod circle, it displays the number
of pods.", fix "Does the text inside the pod cirle display **1 Pod**?" to "Does
the text inside the pod circle display **1 Pod**?", and change "When you hover
of the pod circle, does it display **1 Running**?" to "When you hover over the
pod circle, does it display **1 Running**?"; update these exact phrases in the
quickstart YAML so the wording is correct and consistent with the Topology note
and other instructions.
🪄 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: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: a190a993-183d-457d-861f-e48a5b4bb4ea
📒 Files selected for processing (1)
quickstarts/jboss-eap81-with-helm.yaml
📜 Review details
🧰 Additional context used
📓 Path-based instructions (5)
quickstarts/**/*.yaml
📄 CodeRabbit inference engine (ARCHITECTURE.md)
Contribute console quickstarts to the
quickstarts/directory and include required cluster profile annotations:include.release.openshift.io/ibm-cloud-managed,include.release.openshift.io/self-managed-high-availability, andinclude.release.openshift.io/single-node-developer
Files:
quickstarts/jboss-eap81-with-helm.yaml
**/*.{yaml,yml}
📄 CodeRabbit inference engine (Custom checks)
Flag privileged: true, hostPID, hostNetwork, hostIPC, SYS_ADMIN capability, running as root without justification, and allowPrivilegeEscalation: true in container/K8s manifests
Files:
quickstarts/jboss-eap81-with-helm.yaml
⚙️ CodeRabbit configuration file
**/*.{yaml,yml}: If this is a Kubernetes/OpenShift manifest or Helm template:
- securityContext: runAsNonRoot, readOnlyRootFilesystem,
allowPrivilegeEscalation: false- Drop ALL capabilities, add only what is required
- Resource limits (cpu, memory) on every container
- No hostPID, hostNetwork, hostIPC, privileged: true
- NetworkPolicy defined for the namespace
- OpenShift: SCC must be restricted or custom-scoped
- Liveness + readiness probes defined
- automountServiceAccountToken: false unless needed
- RBAC: least privilege; no cluster-admin for workloads
- Helm: no .Values interpolation in shell commands
Files:
quickstarts/jboss-eap81-with-helm.yaml
{manifests,bindata/assets,quickstarts,examples}/**/*.yaml
📄 CodeRabbit inference engine (.claude/skills/manifest-review.md)
{manifests,bindata/assets,quickstarts,examples}/**/*.yaml: CVO manifests MUST include cluster profile annotations: include.release.openshift.io/hypershift, include.release.openshift.io/ibm-cloud-managed, include.release.openshift.io/self-managed-high-availability, include.release.openshift.io/single-node-developer, and capability.openshift.io/name: Console
Console resources should include capability.openshift.io/name: Console annotation
Kubernetes apiGroups in RBAC manifests must be correct (empty string for core API, specific groups for CRDs)
Resources in manifests must maintain namespace consistency: console workload resources in openshift-console namespace, operator resources in openshift-console-operator namespace
YAML manifests must use proper indentation (2 spaces), consistent field ordering, and include --- separators between multiple resources
When binding roles to service accounts, use console-operator SA for cross-namespace permissions and console SA for same-namespace console workload bindings
New manifests must not have missing cluster profile annotations to ensure resources are deployed to appropriate clusters
Files:
quickstarts/jboss-eap81-with-helm.yaml
**/*.yaml
⚙️ CodeRabbit configuration file
**/*.yaml: Review YAML manifests based on content and kind.Refer to /manifest-review when YAML contains:
kind: Roleorkind: ClusterRole(RBAC review)kind: RoleBindingorkind: ClusterRoleBindingannotations:section (check for cluster profiles)verbs: ["*"]or wildcard permissionsapiGroups: ["*"]or overly broad permissions- ServiceAccount references in subjects
Check for required annotations in manifests/:
include.release.openshift.io/hypershiftinclude.release.openshift.io/ibm-cloud-managedinclude.release.openshift.io/self-managed-high-availabilityinclude.release.openshift.io/single-node-developercapability.openshift.io/name: ConsoleFor quickstarts/, additionally check:
- QuickStart spec structure
- Task descriptions and prerequisites
- See quickstarts/README.md for guidelines
Files:
quickstarts/jboss-eap81-with-helm.yaml
**
⚙️ CodeRabbit configuration file
**: # OpenShift Console Operator - AI Context HubThis file serves as the central AI documentation hub for the OpenShift Console Operator project. AI assistants (Claude, Cursor, Copilot, CodeRabbit, etc.) use this and the linked documents to understand project context.
Go Version and Dependencies
Go Version and Dependencies
- Go version: 1.24.0 (toolchain: go1.24.4)
- Dependency management: Uses
go.modwith vendoring- Build flags: Use
GOFLAGS="-mod=vendor"for builds and tests to ensure vendored dependencies are used- Key dependencies: openshift/api, openshift/library-go, k8s.io client libraries
- Go version: 1.24.0 (toolchain: go1.24.4)
- Dependency management: Uses
go.modwith vendoring- Build flags: Use
GOFLAGS="-mod=vendor"for builds and tests to ensure vendored dependencies are used- Key dependencies: openshift/api, openshift/library-go, k8s.io client libraries
Quick Reference
This Repository
Document Purpose ARCHITECTURE.md System architecture, components, repository structure CONVENTIONS.md Go coding standards, patterns, import organization TESTING.md Testing patterns, commands, debugging README.md Project README with setup instructions Console Repository (openshift/console)
For frontend-related guidelines, see the openshift/console repository:
Document Purpose STYLEGUIDE.md Frontend code style guidelines INTERNATIONALIZATION.md i18n patterns and translation guidelines CONTRIBUTING.md Contribution guidelines for the console project Project Summary
The **console-operator...
Files:
quickstarts/jboss-eap81-with-helm.yaml
🔀 Multi-repo context openshift/console
Findings — references to QuickStarts and related consumers
-
Many frontend components import or use QuickStart types/context from PatternFly:
- frontend/packages/console-shared/src/hooks/useQuickStartContext.ts [::openshift/console::]
- frontend/packages/console-app/src/components/quick-starts/loader/QuickStartsLoader.tsx (maps quickStarts by quickstart.metadata.name) [::openshift/console::]
- frontend/packages/console-app/src/components/quick-starts/QuickStartDrawer.tsx (uses Pf QuickStart drawer) [::openshift/console::]
- frontend/packages/console-app/src/components/quick-starts/QuickStartCatalogPage.tsx (uses QuickStartContextValues) [::openshift/console::]
- frontend/packages/console-app/src/components/quick-starts/utils/quick-start-context.tsx (exports QuickStartContextProvider) [::openshift/console::]
-
PatternFly quickstarts package version pinned:
- frontend/package.json -> "
@patternfly/quickstarts": "~6.5.0" [::openshift/console::] - frontend/yarn.lock entries for
@patternfly/quickstarts[::openshift/console::]
- frontend/package.json -> "
-
Console UI feature/CRD and model for console quickstarts exist:
- vendor/github.com/openshift/api/console/v1/zz_generated.featuregated-crd-manifests.yaml references consolequickstarts.console.openshift.io [::openshift/console::]
- frontend/packages/console-app/src/models/index.ts defines plural: 'consolequickstarts' [::openshift/console::]
- frontend/public/components/masthead/masthead-toolbar.tsx guards quickstart UI with FLAGS.CONSOLE_QUICKSTART [::openshift/console::]
-
Helm-related QuickStart IDs and extensions exist (relevant since the new quickstart is Helm-focused):
- frontend/packages/helm-plugin/console-extensions.json contains data-quickstart-id entries for helm nav/buttons [::openshift/console::]
- frontend/packages/helm-plugin/integration-tests support step-definitions reference quickstart nav ids [::openshift/console::]
-
Tests and integration specs reference QuickStarts and the openshift-quickstarts repo:
- frontend/packages/dev-console/integration-tests/testData/add-flow/git-page.json includes "https://github.com/jboss-openshift/openshift-quickstarts" [::openshift/console::]
- frontend/packages/dev-console/integration-tests and other e2e tests reference quickstart drawer selectors and quickstart flows [::openshift/console::]
-
No existing quickstarts directory present on this branch snapshot (attempted to list quickstarts/* returned "No such file or directory") — the new file in the PR (quickstarts/jboss-eap81-with-helm.yaml) likely adds that directory/file [::openshift/console::]
Quality / relevance note
- The repository contains UI code that loads and displays QuickStarts (PatternFly integration), helm-plugin entries referencing quickstart IDs, and tests that exercise quickstart flows. These are direct consumers of added quickstart content. I observed the specific files above that will consume/display quickstarts.
Tag:
jmesnil
force-pushed
the
ODC-7555_quickstart_jboss_eap8
branch
from
a8803d2 to
2bc4761
Compare
This OpenShift Quickstart is similar to the one for JBoss EAP 7 (ODC-7312) but targets EAP 8.1 instead. JIRA: https://issues.redhat.com/browse/CONSOLE-5288 Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>
jmesnil
force-pushed
the
ODC-7555_quickstart_jboss_eap8
branch
from
2bc4761 to
6bea0c7
Compare
|
@jhadvig I've updated the PR to bring it in line with the Console operator UI and I verified it manually. |
|
@jmesnil: The following tests failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. I understand the commands that are listed here. |
|
afaict the failures are not related to the new quick start... |
7 participants
This OpenShift Quickstart is similar to the one for JBoss EAP 7 (ODC-7312) but targets EAP 8 instead.
JIRA: https://issues.redhat.com/browse/ODC-7555
Summary by CodeRabbit