Skip to content

Commit

Permalink
[CI] Publish Documentation for 25fd983 - 25fd983 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@dmarrazzo
dmarrazzo committed Nov 12, 2024
1 parent a60d721 commit 0a0e5bb
Show file tree
Hide file tree
Showing 8 changed files with 154 additions and 148 deletions.
202 changes: 105 additions & 97 deletions osl/01-setup.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ <h3 class="title"><a href="index.html" class=" query-params-link">OpenShift Serv
<a class="nav-link" href="#vscode-extensions">Visual Studio Code Extensions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="#base-image">Pull the serverless data index image</a>
<a class="nav-link" href="#project-start">Clone and build the startup project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="#project-start">Clone and build the startup project</a>
<a class="nav-link" href="#optional-tools">Optional tools</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -276,12 +276,107 @@ <h2 id="prerequisite"><a class="anchor" href="#prerequisite"></a>Prerequisite to
<td class="tableblock halign-center valign-top"><p class="tableblock"><a href="https://archive.apache.org/dist/maven/maven-3/3.8.6/binaries/apache-maven-3.8.6-bin.tar.gz">Download</a></p></td>
<td class="tableblock halign-center valign-top"><p class="tableblock"><a href="https://archive.apache.org/dist/maven/maven-3/3.8.6/binaries/apache-maven-3.8.6-bin.zip">Download</a></p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="vscode-extensions"><a class="anchor" href="#vscode-extensions"></a>Visual Studio Code Extensions</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Launch Visual Studio Code to install the following extensions:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Language Support for Java&#8482; by Red Hat</p>
</li>
<li>
<p>Kogito Serverless Workflow Editor</p>
</li>
<li>
<p>REST Client (from Huachao Mao)</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>There are 2 ways:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Click on the Extensions icon in the Activity Bar on the side of VS Code, search and install.</p>
<div class="imageblock">
<div class="content">
<img src="_images/extensions-view-icon.png" alt="extensions view icon">
</div>
</div>
</li>
<li>
<p>Launch VS Code Quick Open (Ctrl+P), paste the following commands, and press enter:</p>
<div class="ulist">
<ul>
<li>
<p><code>ext install vscjava.vscode-java-pack</code></p>
</li>
<li>
<p><code>ext install redhat.vscode-extension-serverless-workflow-editor</code></p>
</li>
<li>
<p><code>ext install humao.rest-client</code></p>
</li>
</ul>
</div>
</li>
</ol>
</div>
</div>
</div>
<div class="sect1">
<h2 id="project-start"><a class="anchor" href="#project-start"></a>Clone and build the startup project</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Get your local copy of the start-up project:</p>
</div>
<div class="listingblock console-input">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">git clone <a href="https://github.com/dmarrazzo/order-swf.git" class="bare">https://github.com/dmarrazzo/order-swf.git</a></code></pre>
</div>
</div>
<div class="paragraph">
<p>Enter in the project folder and start Quarkus in dev mode.</p>
</div>
<div class="listingblock console-input">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">cd order-swf
mvn quarkus:dev</code></pre>
</div>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="tableblock halign-center valign-top"><p class="tableblock"><code>podman</code> v4.3.1</p></td>
<td class="tableblock halign-center valign-top" colspan="3"><p class="tableblock">Check the detailed instructions <strong>below</strong> under the proper tab</p></td>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
The first time you launch <code>maven</code> on this project, it is going to take a considerable amount of time because it has to download all the dependencies from the Internet.
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="optional-tools"><a class="anchor" href="#optional-tools"></a>Optional tools</h2>
<div class="sectionbody">
<div class="paragraph">
<p><code>kn-workflow</code> 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&#8217;t need to configure Java and Quarkus).</p>
</div>
<div class="paragraph">
<p>Download the latest tar archive suitable for your environment, from the Serverless Logic <a href="https://mirror.openshift.com/pub/cgw/serverless-logic/latest/">download mirror</a> page.</p>
</div>
<div class="sect2">
<h3 id="_podman_installation_and_configuration"><a class="anchor" href="#_podman_installation_and_configuration"></a>Podman Installation and configuration</h3>
<div class="admonitionblock note">
<table>
<tr>
Expand Down Expand Up @@ -496,65 +591,11 @@ <h2 id="prerequisite"><a class="anchor" href="#prerequisite"></a>Prerequisite to
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="vscode-extensions"><a class="anchor" href="#vscode-extensions"></a>Visual Studio Code Extensions</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Launch Visual Studio Code to install the following extensions:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Language Support for Java&#8482; by Red Hat</p>
</li>
<li>
<p>Kogito Serverless Workflow Editor</p>
</li>
<li>
<p>REST Client (from Huachao Mao)</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>There are 2 ways:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Click on the Extensions icon in the Activity Bar on the side of VS Code, search and install.</p>
<div class="imageblock">
<div class="content">
<img src="_images/extensions-view-icon.png" alt="extensions view icon">
</div>
</div>
</li>
<li>
<p>Launch VS Code Quick Open (Ctrl+P), paste the following commands, and press enter:</p>
<div class="ulist">
<ul>
<li>
<p><code>ext install vscjava.vscode-java-pack</code></p>
</li>
<li>
<p><code>ext install redhat.vscode-extension-serverless-workflow-editor</code></p>
</li>
<li>
<p><code>ext install humao.rest-client</code></p>
</li>
</ul>
</div>
</li>
</ol>
</div>
</div>
</div>
<div class="sect1">
<h2 id="base-image"><a class="anchor" href="#base-image"></a>Pull the serverless data index image</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_pull_the_serverless_workflow_devmode_image"><a class="anchor" href="#_pull_the_serverless_workflow_devmode_image"></a>Pull the Serverless Workflow devmode image</h3>
<div class="paragraph">
<p>In order to run and test locally the Serverless Workflow project, you need the data index container image, it will be <strong>started behind the scene by Quarkus</strong>.
However, since it&#8217;s distributed through the Red Hat official registry you have to login before pulling the image.</p>
<p>In order to run and test the Serverless Workflow project locally, you need a container image which is <strong>lauched behind the scene by <code>kn-workflow</code></strong>.
However, as it&#8217;s distributed through the official Red Hat registry, you&#8217;ll need to login before pulling the image.</p>
</div>
<div class="paragraph">
<p>Find here the instruction on how to create / retrieve your credentials: <a href="https://access.redhat.com/RegistryAuthentication">Registry Authentication</a></p>
Expand All @@ -572,7 +613,7 @@ <h2 id="base-image"><a class="anchor" href="#base-image"></a>Pull the serverless
</div>
<div class="listingblock console-input">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">podman pull --platform linux/amd64 registry.redhat.io/openshift-serverless-1-tech-preview/logic-data-index-ephemeral-rhel8:1.28</code></pre>
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">podman pull --platform linux/amd64 registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:1.34.0</code></pre>
</div>
</div>
<div class="admonitionblock note">
Expand All @@ -589,39 +630,6 @@ <h2 id="base-image"><a class="anchor" href="#base-image"></a>Pull the serverless
</div>
</div>
</div>
<div class="sect1">
<h2 id="project-start"><a class="anchor" href="#project-start"></a>Clone and build the startup project</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Get your local copy of the start-up project:</p>
</div>
<div class="listingblock console-input">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">git clone <a href="https://github.com/dmarrazzo/order-swf.git" class="bare">https://github.com/dmarrazzo/order-swf.git</a></code></pre>
</div>
</div>
<div class="paragraph">
<p>Enter in the project folder and start Quarkus in dev mode.</p>
</div>
<div class="listingblock console-input">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">cd order-swf
mvn quarkus:dev</code></pre>
</div>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
The first time you launch <code>maven</code> on this project, it is going to take a considerable amount of time because it has to download all the dependencies from the Internet.
</td>
</tr>
</table>
</div>
</div>
</div>
<nav class="pagination">
<span class="prev"><a href="index.html" class="query-params-link">OpenShift Serverless Logic Tutorial</a></span>
Expand Down
48 changes: 23 additions & 25 deletions osl/02-startup-project.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ <h3 class="title"><a href="index.html" class=" query-params-link">OpenShift Serv
<a class="nav-link" href="01-setup.html#vscode-extensions">Visual Studio Code Extensions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#base-image">Pull the serverless data index image</a>
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
<a class="nav-link" href="01-setup.html#optional-tools">Optional tools</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -231,59 +231,57 @@ <h2 id="structure"><a class="anchor" href="#structure"></a>The project structure
<p>The workflow core logic is hosted by a plain Quarkus project with some extensions.</p>
</div>
<div class="paragraph">
<p>Serverless Workflow leverages some capabilities coming from of the <strong>Kogito</strong> upstream initiative. For such reason, the extensions have the <code>kogito</code> prefix:</p>
<p>Serverless Workflow leverages some capabilities coming from of the <strong>SonataFlow</strong> upstream initiative.
For such reason, the extensions have the <code>sonataflow</code> prefix:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>kogito-quarkus-serverless-workflow</code></p>
</li>
<li>
<p><code>kogito-addons-quarkus-persistence-jdbc</code></p>
<p>sonataflow-quarkus</p>
</li>
<li>
<p><code>kogito-addons-quarkus-process-svg</code></p>
</li>
<li>
<p><code>kogito-quarkus-serverless-workflow-devui</code></p>
<p>sonataflow-quarkus-devui</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Other common Quarkus extensions used are:</p>
<p>SonataFlow uses some foundational capabilities of other two upstream projects <code>kie</code> and <code>kogito</code>, those are the related quarkus extensions:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>quarkus-smallrye-openapi</code></p>
<p>kie-addons-quarkus-knative-eventing</p>
</li>
<li>
<p>kie-addons-quarkus-process-management</p>
</li>
<li>
<p><code>quarkus-resteasy</code></p>
<p>kie-addons-quarkus-source-files</p>
</li>
<li>
<p><code>quarkus-resteasy-jackson</code></p>
<p>kogito-addons-quarkus-data-index-inmemory</p>
</li>
<li>
<p><code>quarkus-jdbc-postgresql</code></p>
<p>kogito-addons-quarkus-jobs-service-embedded</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>It&#8217;s worth noticing that, at the moment, serverless workflow extensions are not aligned to the quarkus platform, so they relies a dedicated <em>bom</em>:</p>
<p>It&#8217;s worth noticing that, at the moment, Serverless Workflow extensions are not aligned to the quarkus platform, so they relies a dedicated <em>bom</em>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml">&lt;dependency&gt;
&lt;groupId&gt;org.kie.kogito&lt;/groupId&gt;
&lt;artifactId&gt;kogito-bom&lt;/artifactId&gt;
&lt;version&gt;1.35.0.Final-redhat-00003&lt;/version&gt;
&lt;type&gt;pom&lt;/type&gt;
&lt;scope&gt;import&lt;/scope&gt;
&lt;/dependency&gt;</code></pre>
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
&lt;groupId&gt;org.kie.kogito&lt;/groupId&gt;
&lt;artifactId&gt;kogito-bom&lt;/artifactId&gt;
&lt;version&gt;${kie.version}&lt;/version&gt;
&lt;type&gt;pom&lt;/type&gt;
&lt;scope&gt;import&lt;/scope&gt;
&lt;/dependency&gt;</code></pre>
</div>
</div>
<div class="paragraph">
<p>The version <code>1.27.0.Final-redhat-00005</code> comes from the developer preview.</p>
<p>At the time of writing, the latest <code>kie.version</code> is <code>9.101.0.redhat-00007</code>.</p>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions osl/03-inventory.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ <h3 class="title"><a href="index.html" class=" query-params-link">OpenShift Serv
<a class="nav-link" href="01-setup.html#vscode-extensions">Visual Studio Code Extensions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#base-image">Pull the serverless data index image</a>
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
<a class="nav-link" href="01-setup.html#optional-tools">Optional tools</a>
</li>
</ul>
</li>
Expand Down
4 changes: 2 additions & 2 deletions osl/04-longrunning.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ <h3 class="title"><a href="index.html" class=" query-params-link">OpenShift Serv
<a class="nav-link" href="01-setup.html#vscode-extensions">Visual Studio Code Extensions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#base-image">Pull the serverless data index image</a>
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
<a class="nav-link" href="01-setup.html#optional-tools">Optional tools</a>
</li>
</ul>
</li>
Expand Down
4 changes: 2 additions & 2 deletions osl/05-compensation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ <h3 class="title"><a href="index.html" class=" query-params-link">OpenShift Serv
<a class="nav-link" href="01-setup.html#vscode-extensions">Visual Studio Code Extensions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#base-image">Pull the serverless data index image</a>
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
<a class="nav-link" href="01-setup.html#optional-tools">Optional tools</a>
</li>
</ul>
</li>
Expand Down
4 changes: 2 additions & 2 deletions osl/06-finalthoughts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ <h3 class="title"><a href="index.html" class=" query-params-link">OpenShift Serv
<a class="nav-link" href="01-setup.html#vscode-extensions">Visual Studio Code Extensions</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#base-image">Pull the serverless data index image</a>
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="01-setup.html#project-start">Clone and build the startup project</a>
<a class="nav-link" href="01-setup.html#optional-tools">Optional tools</a>
</li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 0a0e5bb

Please sign in to comment.