Skip to content

Commit 829f308

Browse files
jmesniljmesnil
committed
ODC-7555: Add OpenShift Quickstart for JBoss EAP 8
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 Signed-off-by: Jeff Mesnil <[email protected]>
1 parent 387fe33 commit 829f308

File tree

1 file changed

+215
-0
lines changed

1 file changed

+215
-0
lines changed

‎quickstarts/jboss-eap8-with-helm.yaml‎

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
apiVersion: console.openshift.io/v1
2+
kind: ConsoleQuickStart
3+
metadata:
4+
name: jboss-eap8-with-helm
5+
annotations:
6+
include.release.openshift.io/ibm-cloud-managed: 'true'
7+
include.release.openshift.io/self-managed-high-availability: 'true'
8+
include.release.openshift.io/single-node-developer: 'true'
9+
capability.openshift.io/name: Console
10+
spec:
11+
description: 'Deploy a JBoss EAP 8 application using a Helm Chart.'
12+
displayName: Get started with JBoss EAP 8 using a Helm Chart
13+
durationMinutes: 10
14+
icon: >-
15+
data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMDAgMTAwIj48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2Q3MWUwMDt9LmNscy0ye2ZpbGw6I2MyMWEwMDt9LmNscy0ze2ZpbGw6I2NkY2RjZDt9LmNscy00e2ZpbGw6I2I3YjdiNzt9LmNscy01e2ZpbGw6I2VhZWFlYTt9LmNscy02e2ZpbGw6I2ZmZjt9PC9zdHlsZT48L2RlZnM+PHRpdGxlPkxvZ288L3RpdGxlPjxnIGlkPSJMYXllcl8xIiBkYXRhLW5hbWU9IkxheWVyIDEiPjxjaXJjbGUgY2xhc3M9ImNscy0xIiBjeD0iNTAiIGN5PSI1MCIgcj0iNTAiIHRyYW5zZm9ybT0idHJhbnNsYXRlKC0yMC43MSA1MCkgcm90YXRlKC00NSkiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik04NS4zNiwxNC42NEE1MCw1MCwwLDAsMSwxNC42NCw4NS4zNloiLz48cGF0aCBjbGFzcz0iY2xzLTMiIGQ9Ik02MC4xNyw0My4xM2EzLjQxLDMuNDEsMCwwLDEsLjA3LjY4QTMuNCwzLjQsMCwwLDAsNjAuMTcsNDMuMTNaIi8+PHBhdGggY2xhc3M9ImNscy0zIiBkPSJNNTkuMjEsNDEuMzhBMy40OCwzLjQ4LDAsMCwxLDYwLDQyLjQ3LDMuNDgsMy40OCwwLDAsMCw1OS4yMSw0MS4zOFoiLz48cG9seWdvbiBjbGFzcz0iY2xzLTMiIHBvaW50cz0iNTkuMTMgNDEuMjkgNTkuMTMgNDEuMjkgNTkuMDQgNDEuMjEgNTkuMTMgNDEuMjkiLz48cGF0aCBjbGFzcz0iY2xzLTMiIGQ9Ik01OS4xMiw0Ni4zNCwzMy41NCw2OS43M2wyNS41OC0yMy40YTMuNDUsMy40NSwwLDAsMCwuOTEtMS40QTMuNDUsMy40NSwwLDAsMSw1OS4xMiw0Ni4zNFoiLz48cGF0aCBjbGFzcz0iY2xzLTMiIGQ9Ik0yOC41NCw3MS40OCw1OC44Nyw0MSw1OC43OSw0MWEzLjcsMy43LDAsMCwwLTUuMjEuMkwyOSw2OC4yNmMtMSwxLTEuMTksMi41Mi0uMzUsMy4zMWExLjc1LDEuNzUsMCwwLDAsLjc0LjQxLDEuNzUsMS43NSwwLDAsMS0uNzQtLjQxWiIvPjxwYXRoIGNsYXNzPSJjbHMtNCIgZD0iTTI4LjYyLDcxLjU3QTIuNTIsMi41MiwwLDAsMCwzMiw3MS4xMUw1OS4xMiw0Ni4zNGEzLjQyLDMuNDIsMCwwLDAsMC01TDU4Ljg3LDQxLDI4LjU0LDcxLjQ4WiIvPjxwYXRoIGNsYXNzPSJjbHMtNSIgZD0iTTM0LjQ2LDM0LjcxbC0xMC42LTguNDNhMi42LDIuNiwwLDAsMC00LjIsMi4zM2wuMTksMS42NGExOC4yMSwxOC4yMSwwLDAsMCwxMS42OSwxNWwxMy42OSw1LjE0LDIuMzEtMi41NUwzNi4xNiwzNi43M0ExNi40NSwxNi40NSwwLDAsMSwzNC40NiwzNC43MVoiLz48cGF0aCBjbGFzcz0iY2xzLTUiIGQ9Ik03NC42OSw3NS40MSw2NS44OCw2NS4xMmExNi40NSwxNi40NSwwLDAsMS0yLjA4LTEuNjNMNTIuMzMsNTIuNTVsLTIuNTIsMi4zLDUuNjcsMTMuNThBMTguMjEsMTguMjEsMCwwLDAsNzAuODcsNzkuNTZsMS42NC4xM0EyLjYsMi42LDAsMCwwLDc0LjY5LDc1LjQxWiIvPjxwYXRoIGNsYXNzPSJjbHMtNSIgZD0iTTU4LjY0LDQ2Ljc4YTMsMywwLDAsMCwzLjg1LTIuMTcsMy4yOCwzLjI4LDAsMCwwLTMtNC4xNWgwbC0uNTkuNTloMGwuMjYuMjVhMy40MiwzLjQyLDAsMCwxLDAsNVoiLz48cGF0aCBjbGFzcz0iY2xzLTYiIGQ9Ik0zMi43NywxNy4xOGwtLjUsMS41M2ExNy42LDE3LjYsMCwwLDAsMy44OSwxOEw0Ny41Myw0Ny44MmwzLjYxLTQtMTMuNy0yN0EyLjU0LDIuNTQsMCwwLDAsMzIuNzcsMTcuMThaIi8+PHBhdGggY2xhc3M9ImNscy02IiBkPSJNODMuNjUsNjEuNDgsNTYuMzUsNDguODdsLTQsMy42OEw2My44LDYzLjQ5YTE3LjYsMTcuNiwwLDAsMCwxOC4xNSwzLjIzbDEuNTEtLjU1QTIuNTQsMi41NCwwLDAsMCw4My42NSw2MS40OFoiLz48cGF0aCBjbGFzcz0iY2xzLTYiIGQ9Ik01My41OCw0MS4xN2EzLjcsMy43LDAsMCwxLDUuMjEtLjJsLjA4LjA4aDBsLjU5LS41OWgwYTMuNDEsMy40MSwwLDAsMC00LjI5LTIuOTNjLTIsLjM4LTMuMDcsMi42OC0yLDQuMTFaIi8+PC9nPjwvc3ZnPg==
16+
introduction: |-
17+
[Red Hat® JBoss® Enterprise Application Platform (EAP)](https://www.redhat.com/en/technologies/jboss-middleware/application-platform) is an application server. It includes everything needed to build, run, deploy, and manage enterprise Java applications in a variety of environments, including on-premise, virtual environments, and in private, public, and hybrid clouds.
18+
19+
* **Optimized for OpenShift, Cloud and Containers**
20+
21+
* **Jakarta EE 10 compatibility**
22+
23+
* **Lightweight, flexible architecture**
24+
25+
* **Red Hat Portfolio Integration**
26+
27+
* **More productive developers with DevOps and Agile Development**
28+
29+
With this quick start, you can deploy and run a [Jakarta EE application](https://github.com/jboss-eap-up-and-running/eap8-getting-started) with JBoss EAP 8 on OpenShift.
30+
31+
**Note:** The quick start uses a sample [Jakarta EE application](https://github.com/jboss-eap-up-and-running/eap8-getting-started). You can deploy your own Jakarta EE 10 application using the same steps.
32+
The quick start has instructions where changes would be needed (Task 1).
33+
34+
tasks:
35+
- description: >-
36+
To create a JBoss EAP 8 application:
37+
38+
1. In the main navigation, click the dropdown menu [perspective switcher]{{highlight qs-perspective-switcher}} and select **Developer**.
39+
40+
1. In the navigation menu, click [Add]{{highlight qs-nav-add}}.
41+
The **Add** page opens.
42+
43+
1. In the **Add** page, click **Helm Chart**.
44+
45+
1. In the **Helm Charts** catalog, search for **JBoss EAP 8**.
46+
47+
1. Click the **JBoss EAP 8** Helm chart card.
48+
49+
- The side panel displays information about the JBoss EAP 8 Helm chart.
50+
51+
1. Click **Create**.
52+
53+
- Some form sections are collapsed by default. Click **>** to expand and view its content.
54+
**Note:** No updates are required to these sections to proceed.
55+
56+
- The details about the [Jakarta EE application](https://github.com/jboss-eap-up-and-running/eap8-getting-started) that you are building and deploying are specified in the `build.uri` field:
57+
58+
```
59+
build:
60+
uri: https://github.com/jboss-eap-up-and-running/eap8-getting-started
61+
```
62+
63+
**Note:** If you are building a different application, you must change this `uri` field to point to the Git repository of that application.
64+
65+
1. Click **Create** to create the JBoss EAP 8 application using the Helm Chart.
66+
67+
- The console switches to the [Topology]{{highlight qs-nav-topology}} view and displays a pane with the Helm release notes.
68+
After you read the notes, you can close the pane.
69+
review:
70+
failedTaskHelp: This task isn’t verified yet. Try the task again.
71+
instructions: |-
72+
The Helm release is represented by a dashed box that contains the JBoss EAP icon and **eap8 ** text. This content is placed outside the dashed box.
73+
74+
The deployment is indicated by a circle inside the dashed box with text **D eap8**.
75+
76+
Verify the application was successfully created:
77+
78+
- Do you see an **eap8** Helm Release?
79+
80+
- Do you see an **eap8** deployment?
81+
82+
summary:
83+
failed: Try the steps again.
84+
success: Your JBoss EAP 8 application has been deployed onto OpenShift.
85+
title: Create a JBoss EAP 8 application with Helm
86+
- description: >-
87+
To view the Helm release:
88+
89+
1. In the navigation menu, click [Helm]{{highlight qs-nav-helm}}.
90+
91+
1. Click **eap8** Helm release.
92+
The **Helm Release details** page opens. It shows all the information related to the Helm release that you installed.
93+
94+
- Click the **Resources** tab. It lists all the resources created by this Helm release.
95+
review:
96+
failedTaskHelp: This task isn’t verified yet. Try the task again.
97+
instructions: >-
98+
Verify you see the Helm release:
99+
100+
- Do you see a **Deployed** label next to the Helm Release **eap8**?
101+
summary:
102+
failed: Try the steps again.
103+
success: Your Helm release for JBoss EAP 8 is deployed.
104+
title: View the Helm release
105+
- description: >-
106+
To view the associated code:
107+
108+
1. In the navigation menu, click [Topology]{{highlight qs-nav-topology}}.
109+
In the Topology view, the **eap8** deployment displays a code icon in the bottom right-hand corner. This icon either represents the Git repository
110+
of the associated code, or if the appropriate operators are installed, it will open the associated code in your IDE.
111+
112+
1. If the icon shown is CodeReady Workspaces or Eclipse Che, clicking the icon opens the associated code in your IDE.
113+
114+
1. If the icon represents a Git repository, clicking the icon opens the associated Git repository.
115+
review:
116+
failedTaskHelp: >-
117+
This task isn’t verified yet. Try the task again.
118+
instructions: >-
119+
Verify that you can see the code associated with your application:
120+
121+
- Did the Git repository or your IDE open in a separate browser window?
122+
summary:
123+
failed: Try the steps again.
124+
success: You viewed the code associated with the **eap8** deployment.
125+
title: View the associated code
126+
- description: >-
127+
To view the build status of the JBoss EAP 8 application:
128+
129+
1. In the navigation menu, click [Topology]{{highlight qs-nav-topology}}.
130+
131+
1. In the Topology view, click **D eap8**.
132+
A side panel opens with detailed information about the application.
133+
134+
1. In the side panel, click the **Resources** tab.
135+
The **Builds** section shows all the details related to builds of the application.
136+
137+
The JBoss EAP 8 application is built in two steps:
138+
139+
- The first build configuration **eap8-build-artifacts** compiles and packages the Jakarta EE application, and creates a JBoss EAP server.
140+
The application is run on this JBoss EAP server.
141+
142+
The build might take a few minutes to complete. The build state is indicated by a relevant message such as **Pending**, **Running**, and **Complete**.
143+
144+
When the build is complete, a checkmark and the following message is displayed: **Build #1 was complete**.
145+
146+
When the first build is complete, the second build starts.
147+
148+
- The second build configuration **eap8** puts the Jakarta EE deployment and the JBoss EAP server in a runtime image that contains only what is required to run the application.
149+
150+
When the second build is complete, a checkmark and the following message are displayed: **Build #2 was complete**.
151+
review:
152+
failedTaskHelp: This task isn’t verified yet. Try the task again.
153+
instructions: >-
154+
The two builds for **eap8-build-artifacts** and **eap8** might take a few minutes to complete.
155+
156+
Verify the builds are complete:
157+
158+
- The message **Build #1 was complete** is displayed for the **eap8-build-artifacts** build configuration. Did this message appear?
159+
160+
- The message **Build #2 was complete** is displayed for the **eap8** build configuration. Did this message appear?
161+
summary:
162+
failed: Try the steps again.
163+
success: Your build is complete.
164+
title: View the Build status
165+
- description: >-
166+
To view the pod status:
167+
168+
1. In the navigation menu, click [Topology]{{highlight qs-nav-topology}}.
169+
170+
1. In the **Topology** view, click **D eap8**.
171+
A side panel opens with detailed information about the application.
172+
173+
1. In the **Details** tab, the pod status is available in a tooltip by hovering over the pod.
174+
175+
- Inside the pod circle, it displays the number of pod.
176+
- The color of the pod circle indicates the pod status:
177+
Light blue = **Pending**, Blue = **Not Ready**, Dark blue = **Running**
178+
179+
**Note:** In the **Topology** view, the dark outer circle indicates the pod status.
180+
review:
181+
failedTaskHelp: >-
182+
This task isn’t verified yet. Try the task again.
183+
instructions: |-
184+
Verify you see the pod status:
185+
186+
- Does the text inside the pod cirle display **1 Pod**?
187+
188+
- When you hover of the pod circle, does it display **1 Running**?
189+
190+
summary:
191+
failed: Try the steps again.
192+
success: Your deployment has one running pod.
193+
title: View the Pod status
194+
- description: >-
195+
196+
To view the JBoss EAP application:
197+
198+
1. In the **Topology** view, click the external link icon in the top right corner to open the URL and run the application in a separate browser window.
199+
review:
200+
failedTaskHelp: This task isn’t verified yet. Try the task again.
201+
instructions: >-
202+
Verify your JBoss EAP 8 application is running:
203+
204+
- Did **JBoss EAP 8 on Red Hat OpenShift** open in a separate browser window?
205+
summary:
206+
failed: Try the steps again.
207+
success: Your JBoss EAP 8 application is running.
208+
title: Run the JBoss EAP 8 application
209+
conclusion: >-
210+
Your JBoss EAP 8 application is deployed and ready.
211+
212+
## Resources:
213+
214+
- Learn more about [JBoss EAP](https://access.redhat.com/products/red-hat-jboss-enterprise-application-platform/).
215+
- Read detailed [JBoss EAP 8 documentation](https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/8.0).

0 commit comments

Comments
 (0)