Skip to content

Commit d8eafd1

Browse files
dmarrazzodmarrazzo
committed
setup reorg
1 parent 5a1eab3 commit d8eafd1

File tree

3 files changed

+64
-61
lines changed

3 files changed

+64
-61
lines changed

‎documentation/modules/ROOT/nav.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
* xref:01-setup.adoc[1. Setup]
2+
** xref:01-setup.adoc#local-runtime[Local Runtime]
23
** xref:01-setup.adoc#prerequisite[Prerequisite tools]
34
** xref:01-setup.adoc#vscode-extensions[Visual Studio Code Extensions]
4-
** xref:01-setup.adoc#base-image[Pull the serverless data index image]
55
** xref:01-setup.adoc#project-start[Clone and build the startup project]
66
77
* xref:02-startup-project.adoc[2. Startup Project]

‎documentation/modules/ROOT/pages/01-setup.adoc

+62-59
Original file line numberDiff line numberDiff line change
@@ -10,43 +10,14 @@ There are several ways to develop on OpenShift Serverless Logic:
1010
This tutorial suggests the first option to minimize the workstation preparation work.
1111
The rest of this chapter provides instructions for setting up the _full local development workstation_, and *you can skip it*.
1212

13+
[#local-runtime]
14+
== Local Runtime
1315

14-
[#prerequisite]
15-
== Prerequisite tools
16-
17-
WARNING: It is recommended that you complete this section using a reliable connection. Avoid doing this part of the lab on a shared connection because of the bandwidth requirements. Also, some tasks will take a long time to download resources.
16+
`kn-workflow` is a handy tool for deploying your project in OpenShift, but it can also be used to run the workflow locally in a container (so you don't need to configure Java and Quarkus).
1817

19-
Here the tools to install:
20-
21-
[cols="4*^,4*.",options="header,+attributes"]
22-
|===
23-
|**Tool**|**Fedora**|**MacOS**|**Windows**
24-
25-
| `git`
26-
| `dnf install -y git`
27-
| https://git-scm.com/download/mac[Download]
28-
| https://git-scm.com/download/win[Download]
29-
30-
| https://code.visualstudio.com/[Visual Studio Code]
31-
| https://code.visualstudio.com/docs/setup/linux#_rhel-fedora-and-centos-based-distributions[Download] or https://code.visualstudio.com/docs/setup/linux#_installing-rpm-package-manually[Install from the provided USB Stick Resources]
32-
| https://code.visualstudio.com/docs/setup/mac[Download] or *Install from the provided USB Stick Resources*
33-
| https://code.visualstudio.com/docs/setup/windows[Download] or *Install from the provided USB Stick Resources*
34-
35-
| OpenJDK v11
36-
| `dnf install -y java-11-openjdk-devel`
37-
| https://adoptopenjdk.net/[Mac Version Download]
38-
| https://developers.redhat.com/products/openjdk/download[Windows Download]
39-
40-
| `Apache Maven`
41-
| `dnf install -y maven`
42-
| https://archive.apache.org/dist/maven/maven-3/3.8.6/binaries/apache-maven-3.8.6-bin.tar.gz[Download]
43-
| https://archive.apache.org/dist/maven/maven-3/3.8.6/binaries/apache-maven-3.8.6-bin.zip[Download]
44-
45-
| `podman` v4.3.1
46-
3+| Check the detailed instructions *below* under the proper tab
47-
48-
|===
18+
Download the latest tar archive suitable for your environment, from the Serverless Logic https://mirror.openshift.com/pub/cgw/serverless-logic/latest/[download mirror] page.
4919

20+
=== Podman Installation and configuration
5021

5122
NOTE: If you have already installed _Docker_ in your environment, or you feel more comfortable with it, feel free to replace Podman with Docker.
5223

@@ -238,6 +209,63 @@ podman machine set --rootful
238209
--
239210
====
240211

212+
=== Pull the Serverless Workflow devmode image
213+
214+
In order to run and test the Serverless Workflow project locally, you need a container image which is *lauched behind the scene by `kn-workflow`*.
215+
However, as it's distributed through the official Red Hat registry, you'll need to login before pulling the image.
216+
217+
Find here the instruction on how to create / retrieve your credentials: https://access.redhat.com/RegistryAuthentication[Registry Authentication]
218+
219+
Login to *registry.redhat.io* with your Red Hat credentials;
220+
221+
[.console-input]
222+
[source,bash,subs="+macros,+attributes"]
223+
----
224+
podman login registry.redhat.io
225+
----
226+
227+
Pull the serverless data index image:
228+
[.console-input]
229+
[source,bash,subs="+macros,+attributes"]
230+
----
231+
podman pull --platform linux/amd64 registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:1.34.0
232+
----
233+
234+
NOTE: The parameter `--platform linux/amd64` is important when you run it on a Mac with an M1 chip (which has a different processor architecture)
235+
236+
237+
[#prerequisite]
238+
== Prerequisite tools
239+
240+
WARNING: It is recommended that you complete this section using a reliable connection. Avoid doing this part of the lab on a shared connection because of the bandwidth requirements. Also, some tasks will take a long time to download resources.
241+
242+
Here the tools to install:
243+
244+
[cols="4*^,4*.",options="header,+attributes"]
245+
|===
246+
|**Tool**|**Fedora**|**MacOS**|**Windows**
247+
248+
| `git`
249+
| `dnf install -y git`
250+
| https://git-scm.com/download/mac[Download]
251+
| https://git-scm.com/download/win[Download]
252+
253+
| https://code.visualstudio.com/[Visual Studio Code]
254+
| https://code.visualstudio.com/docs/setup/linux#_rhel-fedora-and-centos-based-distributions[Download] or https://code.visualstudio.com/docs/setup/linux#_installing-rpm-package-manually[Install from the provided USB Stick Resources]
255+
| https://code.visualstudio.com/docs/setup/mac[Download] or *Install from the provided USB Stick Resources*
256+
| https://code.visualstudio.com/docs/setup/windows[Download] or *Install from the provided USB Stick Resources*
257+
258+
| OpenJDK v11
259+
| `dnf install -y java-11-openjdk-devel`
260+
| https://adoptopenjdk.net/[Mac Version Download]
261+
| https://developers.redhat.com/products/openjdk/download[Windows Download]
262+
263+
| `Apache Maven`
264+
| `dnf install -y maven`
265+
| https://archive.apache.org/dist/maven/maven-3/3.8.6/binaries/apache-maven-3.8.6-bin.tar.gz[Download]
266+
| https://archive.apache.org/dist/maven/maven-3/3.8.6/binaries/apache-maven-3.8.6-bin.zip[Download]
267+
|===
268+
241269
[#vscode-extensions]
242270
== Visual Studio Code Extensions
243271

@@ -259,31 +287,6 @@ image::extensions-view-icon.png[]
259287
* `ext install redhat.vscode-extension-serverless-workflow-editor`
260288
* `ext install humao.rest-client`
261289

262-
[#base-image]
263-
== Pull the serverless data index image
264-
265-
In order to run and test locally the Serverless Workflow project, you need the data index container image, it will be *started behind the scene by Quarkus*.
266-
However, since it's distributed through the Red Hat official registry you have to login before pulling the image.
267-
268-
Find here the instruction on how to create / retrieve your credentials: https://access.redhat.com/RegistryAuthentication[Registry Authentication]
269-
270-
Login to *registry.redhat.io* with your Red Hat credentials;
271-
272-
[.console-input]
273-
[source,bash,subs="+macros,+attributes"]
274-
----
275-
podman login registry.redhat.io
276-
----
277-
278-
Pull the serverless data index image:
279-
[.console-input]
280-
[source,bash,subs="+macros,+attributes"]
281-
----
282-
podman pull --platform linux/amd64 registry.redhat.io/openshift-serverless-1-tech-preview/logic-data-index-ephemeral-rhel8:1.28
283-
----
284-
285-
NOTE: The parameter `--platform linux/amd64` is important when you run it on a Mac with an M1 chip (which has a different processor architecture)
286-
287290
[#project-start]
288291
== Clone and build the startup project
289292

‎documentation/modules/ROOT/pages/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ image:serverless.png[]
1414
[.tile]
1515
.xref:01-setup.adoc[Set up instructions]
1616
* xref:01-setup.adoc#prerequisite[Prerequisite tools]
17+
* xref:01-setup.adoc#local-runtime[Local Runtime]
1718
* xref:01-setup.adoc#vscode-extensions[Visual Studio Code Extensions]
18-
* xref:01-setup.adoc#base-image[Pull the serverless data index image]
1919
* xref:01-setup.adoc#project-start[Clone and build the startup project]
2020

2121
[.tile]

0 commit comments

Comments
 (0)