Skip to content

Commit

Permalink
[DOC] smile_talend_job: add requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
@isabellerichard
isabellerichard committed Mar 19, 2021
1 parent 03fcecb commit eb208ff
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 27 deletions.
3 changes: 3 additions & 0 deletions Dockerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@ USER root
COPY ./requirements.txt .
RUN pip3 install -r ./requirements.txt

RUN apt-get update && \
apt-get install -y default-jdk

USER odoo
1 change: 1 addition & 0 deletions docker-compose.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ services:
- HOST=db
- USER=odoo
- PASSWORD=odoo
- _JAVA_OPTIONS=-Xmx2048m -XX:CompressedClassSpaceSize=256m -Xmx300m
build: .
ports:
- 8069:8069
Expand Down
49 changes: 42 additions & 7 deletions smile_talend_job/README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,56 @@ This module allows the execution of Talend jobs , it is useful during data integ

Features:

* Execution of a Talend job by importing its archive .
* Execution of a Talend job by importing its archive.
* Visualization of the job's execution logs (creation date, end date, details, state, execution duration).
* Offers the possibility to add context variables to manage various execution types (database to use, username, password, port, host...).
* Definition of children jobs.
* Definition of the parent job.
* Passing a context environment to children jobs.
* Control the allocated memory for the job execution (by specifying the argument in the args field).
* Jobs and their executions logs storage .
* Jobs and their executions logs storage.


**Table of contents**

.. contents::
:local:

Requirements
============

Install Java
~~~~~~~~~~~~

You need to install Java on the server hosting Odoo, to execute Talend jobs
directly from Odoo.

To install Java on Debian/Ubuntu:

.. code-block::
sudo apt-get update
sudo apt-get install -y default-jdk
java --version
Configure Java options
~~~~~~~~~~~~~~~~~~~~~~

If you encounter the following error during execution:

.. code-block::
Could not allocate metaspace: 1073741824 bytes
That means that Java is not allowed to use enough memory to execute
your job.

To increase memory that Java can use, set this option to your environment:

.. code-block::
_JAVA_OPTIONS=-Xmx2048m -XX:CompressedClassSpaceSize=256m -Xmx300m
Usage
=====
Expand All @@ -38,7 +73,7 @@ To run a Talend job:
#. Go to ``Settings > Talend Jobs`` menu.
#. Press the button ``Create``.
#. Insert the name of the job (the name should be the same name used for the job in Talend studio ).
#. Upload the job's archive file (zip format) to ``archive field`` .
#. Upload the job's archive file (zip format) to ``archive field``.
#. Click on ``Run`` button.
#. Click on ``Refresh logs`` button.

Expand All @@ -48,7 +83,7 @@ To run a Talend job:

To propagate a context environment to children jobs :

#. Add the concerned children jobs to ``Children field`` .
#. Add the concerned children jobs to ``Children field``.
#. Click on ``Propagate context`` button.

.. figure:: static/description/context_propagate.png
Expand All @@ -57,7 +92,7 @@ To propagate a context environment to children jobs :

Parameters you can specify :

#. Path : to specify the path to the job's directory .
#. Path : to specify the path to the job's directory.
#. Args : add -Xms64M or -Xmx1024M to control the available memory for the job's execution.
#. Loop : to specify the number of times the job will be executed.
#. Parent : to indicate the parent job.
Expand Down Expand Up @@ -96,12 +131,12 @@ Credits
=======

Contributors
------------
~~~~~~~~~~~~

* Corentin POUHET-BRUNERIE

Maintainer
----------
~~~~~~~~~~

This module is maintained by Smile SA.

Expand Down
72 changes: 52 additions & 20 deletions smile_talend_job/static/description/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" />
<title>Talend Job Execution</title>
<style type="text/css">

Expand Down Expand Up @@ -367,36 +367,68 @@ <h1 class="title">Talend Job Execution</h1>
<p>This module allows the execution of Talend jobs , it is useful during data integration.</p>
<p>Features:</p>
<ul class="simple">
<li>Execution of a Talend job by importing its archive .</li>
<li>Visualization of the job's execution logs (creation date, end date ,details ,state ,execution duration).</li>
<li>Offers the possibility to add context variables to manage various execution types (database to use ,username ,password ,port ,host...).</li>
<li>Execution of a Talend job by importing its archive.</li>
<li>Visualization of the job's execution logs (creation date, end date, details, state, execution duration).</li>
<li>Offers the possibility to add context variables to manage various execution types (database to use, username, password, port, host...).</li>
<li>Definition of children jobs.</li>
<li>Definition of the parent job.</li>
<li>Passing a context environment to children jobs.</li>
<li>Control the allocated memory for the job execution (by specifying the argument in the args field).</li>
<li>Jobs and their executions logs storage .</li>
<li>Jobs and their executions logs storage.</li>
</ul>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#gdpr-eu-privacy" id="id3">GDPR / EU Privacy</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainer" id="id6">Maintainer</a></li>
<li><a class="reference internal" href="#requirements" id="id1">Requirements</a><ul>
<li><a class="reference internal" href="#install-java" id="id2">Install Java</a></li>
<li><a class="reference internal" href="#configure-java-options" id="id3">Configure Java options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage" id="id4">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li>
<li><a class="reference internal" href="#gdpr-eu-privacy" id="id6">GDPR / EU Privacy</a></li>
<li><a class="reference internal" href="#credits" id="id7">Credits</a><ul>
<li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li>
<li><a class="reference internal" href="#maintainer" id="id9">Maintainer</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="requirements">
<h1><a class="toc-backref" href="#id1">Requirements</a></h1>
<div class="section" id="install-java">
<h2><a class="toc-backref" href="#id2">Install Java</a></h2>
<p>You need to install Java on the server hosting Odoo, to execute Talend jobs
directly from Odoo.</p>
<p>To install Java on Debian/Ubuntu:</p>
<pre class="code literal-block">
sudo apt-get update
sudo apt-get install -y default-jdk
java --version
</pre>
</div>
<div class="section" id="configure-java-options">
<h2><a class="toc-backref" href="#id3">Configure Java options</a></h2>
<p>If you encounter the following error during execution:</p>
<pre class="code literal-block">
Could not allocate metaspace: 1073741824 bytes
</pre>
<p>That means that Java is not allowed to use enough memory to execute
your job.</p>
<p>To increase memory that Java can use, set this option to your environment:</p>
<pre class="code literal-block">
_JAVA_OPTIONS=-Xmx2048m -XX:CompressedClassSpaceSize=256m -Xmx300m
</pre>
</div>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
<h1><a class="toc-backref" href="#id4">Usage</a></h1>
<p>To run a Talend job:</p>
<ol class="arabic simple">
<li>Go to <tt class="docutils literal">Settings &gt; Talend Jobs</tt> menu.</li>
<li>Press the button <tt class="docutils literal">Create</tt>.</li>
<li>Insert the name of the job (the name should be the same name used for the job in Talend studio ).</li>
<li>Upload the job's archive file (zip format) to <tt class="docutils literal">archive field</tt> .</li>
<li>Upload the job's archive file (zip format) to <tt class="docutils literal">archive field</tt>.</li>
<li>Click on <tt class="docutils literal">Run</tt> button.</li>
<li>Click on <tt class="docutils literal">Refresh logs</tt> button.</li>
</ol>
Expand All @@ -405,15 +437,15 @@ <h1><a class="toc-backref" href="#id1">Usage</a></h1>
</div>
<p>To propagate a context environment to children jobs :</p>
<ol class="arabic simple">
<li>Add the concerned children jobs to <tt class="docutils literal">Children field</tt> .</li>
<li>Add the concerned children jobs to <tt class="docutils literal">Children field</tt>.</li>
<li>Click on <tt class="docutils literal">Propagate context</tt> button.</li>
</ol>
<div class="figure">
<img alt="Propagate Context" src="context_propagate.png" style="width: 900px;" />
</div>
<p>Parameters you can specify :</p>
<ol class="arabic simple">
<li>Path : to specify the path to the job's directory .</li>
<li>Path : to specify the path to the job's directory.</li>
<li>Args : add -Xms64M or -Xmx1024M to control the available memory for the job's execution.</li>
<li>Loop : to specify the number of times the job will be executed.</li>
<li>Parent : to indicate the parent job.</li>
Expand All @@ -431,27 +463,27 @@ <h1><a class="toc-backref" href="#id1">Usage</a></h1>
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#id5">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
<a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues/new?body=module:%20smile_talend_job%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">here</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="gdpr-eu-privacy">
<h1><a class="toc-backref" href="#id3">GDPR / EU Privacy</a></h1>
<h1><a class="toc-backref" href="#id6">GDPR / EU Privacy</a></h1>
<p>This addons does not collect any data and does not set any browser cookies.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id4">Credits</a></h1>
<h1><a class="toc-backref" href="#id7">Credits</a></h1>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<h2><a class="toc-backref" href="#id8">Contributors</a></h2>
<ul class="simple">
<li>Corentin POUHET-BRUNERIE</li>
</ul>
</div>
<div class="section" id="maintainer">
<h2><a class="toc-backref" href="#id6">Maintainer</a></h2>
<h2><a class="toc-backref" href="#id9">Maintainer</a></h2>
<p>This module is maintained by Smile SA.</p>
<p>Since 1991 Smile has been a pioneer of technology and also the European expert in open source solutions.</p>
<a class="reference external image-reference" href="http://smile.fr"><img alt="Smile SA" src="https://avatars0.githubusercontent.com/u/572339?s=200&amp;v=4" /></a>
Expand Down

0 comments on commit eb208ff

Please sign in to comment.