You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by gi...@apache.org on 2022/03/30 19:25:40 UTC
[incubator-streampipes-website] branch asf-site updated: Automated deployment: Wed Mar 30 19:25:33 UTC 2022 9e290cdf2cab0fc5e36a96dc36f562e606a357dc
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new f599c6b Automated deployment: Wed Mar 30 19:25:33 UTC 2022 9e290cdf2cab0fc5e36a96dc36f562e606a357dc
f599c6b is described below
commit f599c6b62630fac52ba17eb306e29e143a032343
Author: dominikriemer <do...@users.noreply.github.com>
AuthorDate: Wed Mar 30 19:25:33 2022 +0000
Automated deployment: Wed Mar 30 19:25:33 UTC 2022 9e290cdf2cab0fc5e36a96dc36f562e606a357dc
---
docs/docs/extend-setup.html | 15 ++++++++++++++-
docs/docs/extend-tutorial-data-processors.html | 1 +
docs/docs/extend-tutorial-data-sinks.html | 1 +
docs/docs/extend-tutorial-data-sources.html | 1 +
docs/docs/next/extend-setup.html | 15 ++++++++++++++-
docs/docs/next/extend-tutorial-data-processors.html | 1 +
docs/docs/next/extend-tutorial-data-sinks.html | 1 +
docs/docs/next/extend-tutorial-data-sources.html | 1 +
8 files changed, 34 insertions(+), 2 deletions(-)
diff --git a/docs/docs/extend-setup.html b/docs/docs/extend-setup.html
index 8b614d8..001d702 100644
--- a/docs/docs/extend-setup.html
+++ b/docs/docs/extend-setup.html
@@ -74,6 +74,19 @@ The only requirements in terms of development tools are that you have Java 8 and
<p>In order to quickly test developed pipeline elements without needing to install all services required by StreamPipes, we provide a CLI tool that allows you to selectively start StreamPipes components.
The CLI tool allows to switch to several templates (based on docker-compose) depending on the role.</p>
<p>The documentation on the usage of the CLI tool is available <a href="/docs/docs/extend-cli.html">here</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="override-the-sp_host-variable"></a><a href="#override-the-sp_host-variable" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 [...]
+<p>By default, the backend/core of StreamPipes registers itself within StreamPipes' service discovery mechanism using an auto-discovered hostname.
+Usually, this will be an IP address from the Docker network, which is not resolvable from outside. Therefore, for local development you need to override the hostname with an IP address which is accessible from your local host where you develop extensions.
+When using the CLI, open the CLI folder <code>installer/cli</code>, navigate to <code>deploy/standalone/backend</code>, open the <code>docker-compose.dev.yml</code> file and add the SP_HOST env variable, e.g.</p>
+<pre><code class="hljs"><span class="hljs-symbol">version:</span> <span class="hljs-string">"3.4"</span>
+<span class="hljs-symbol">services:</span>
+<span class="hljs-symbol"> backend:</span>
+<span class="hljs-symbol"> ports:</span>
+ - <span class="hljs-string">"8030:8030"</span>
+<span class="hljs-symbol"> environment:</span>
+ - SP_HOST=host.docker.internal
+</code></pre>
+<p>Note that host.docker.internal will work as an alias under Docker for Desktop on Windows and Mac, but not on Linux or M1. In this case, provide a resolvable hostname or IP address manually.</p>
<h2><a class="anchor" aria-hidden="true" id="starter-projects"></a><a href="#starter-projects" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
<p>Now, once you've started the development instance, you are ready to develop your very first pipeline element.
Instead of starting from scratch, we recommend using our provided maven archetypes:</p>
@@ -81,7 +94,7 @@ Instead of starting from scratch, we recommend using our provided maven archetyp
<p>Create the Maven archetype as described in the <a href="/docs/docs/extend-archetypes.html">Maven Archetypes</a> guide.</p>
<h3><a class="anchor" aria-hidden="true" id="examples"></a><a href="#examples" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 [...]
<p>We provide several examples that explain the usage of some concepts in this <a href="https://github.com/apache/incubator-streampipes-examples">Github repo</a>.</p>
-</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/deploy-security.html"><span class="arrow-prev">← </span><span>Security</span></a><a class="docs-next button" href="/docs/docs/extend-cli.html"><span class="function-name-prevnext">StreamPipes CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#ide--required-dev-tools">IDE & required dev tools</a></li><li><a hr [...]
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/deploy-security.html"><span class="arrow-prev">← </span><span>Security</span></a><a class="docs-next button" href="/docs/docs/extend-cli.html"><span class="function-name-prevnext">StreamPipes CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#ide--required-dev-tools">IDE & required dev tools</a></li><li><a hr [...]
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
diff --git a/docs/docs/extend-tutorial-data-processors.html b/docs/docs/extend-tutorial-data-processors.html
index e7766af..5622c85 100644
--- a/docs/docs/extend-tutorial-data-processors.html
+++ b/docs/docs/extend-tutorial-data-processors.html
@@ -330,6 +330,7 @@ In some cases, the detected hostname is not resolvable from within a container (
</p>
</div>
<p>Now we are ready to start our service!</p>
+<p>Configure your IDE to provide an environment variable called <code>SP_DEBUG</code> with value <code>true</code> when starting the project.</p>
<p>Execute the main method in the class <code>Init</code> we've just created, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a> (or the port you have assigned).</p>
<p>You should see something as follows:</p>
<p><img src="/docs/img/tutorial-processors/pe-overview-flink.PNG" alt="Pipeline Element Container Overview"></p>
diff --git a/docs/docs/extend-tutorial-data-sinks.html b/docs/docs/extend-tutorial-data-sinks.html
index fc9e7c6..64a1dc5 100644
--- a/docs/docs/extend-tutorial-data-sinks.html
+++ b/docs/docs/extend-tutorial-data-sinks.html
@@ -244,6 +244,7 @@ In some cases, the detected hostname is not resolvable from within a container (
</p>
</div>
<p>Now we are ready to start our service!</p>
+<p>Configure your IDE to provide an environment variable called <code>SP_DEBUG</code> with value <code>true</code> when starting the project.</p>
<p>Execute the main method in the class <code>Init</code> we've just created, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a> (or the port you have assigned).</p>
<p>The services automatically registers itself in StreamPipes.</p>
<p>To install the created element, open the StreamPipes UI and follow the manual provided in the <a href="/docs/docs/use-install-pipeline-elements.html">user guide</a>.</p>
diff --git a/docs/docs/extend-tutorial-data-sources.html b/docs/docs/extend-tutorial-data-sources.html
index cec70de..012ac4e 100644
--- a/docs/docs/extend-tutorial-data-sources.html
+++ b/docs/docs/extend-tutorial-data-sources.html
@@ -212,6 +212,7 @@ In some cases, the detected hostname is not resolvable from within a container (
</p>
</div>
<p>Now we are ready to start our first container!</p>
+<p>Configure your IDE to provide an environment variable called <code>SP_DEBUG</code> with value <code>true</code> when starting the project.</p>
<p>Execute the main method in the class <code>Init</code>, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a>, or change the port according to the value of the <code>SP_PORT</code> variable in the env file.</p>
<p>You should see something as follows:</p>
<p><img src="/docs/img/tutorial-sources/pe-overview.PNG" alt="Pipeline Element Container Overview"></p>
diff --git a/docs/docs/next/extend-setup.html b/docs/docs/next/extend-setup.html
index 29a67c9..b338c89 100644
--- a/docs/docs/next/extend-setup.html
+++ b/docs/docs/next/extend-setup.html
@@ -74,6 +74,19 @@ The only requirements in terms of development tools are that you have Java 8 and
<p>In order to quickly test developed pipeline elements without needing to install all services required by StreamPipes, we provide a CLI tool that allows you to selectively start StreamPipes components.
The CLI tool allows to switch to several templates (based on docker-compose) depending on the role.</p>
<p>The documentation on the usage of the CLI tool is available <a href="/docs/docs/next/extend-cli.html">here</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="override-the-sp_host-variable"></a><a href="#override-the-sp_host-variable" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 [...]
+<p>By default, the backend/core of StreamPipes registers itself within StreamPipes' service discovery mechanism using an auto-discovered hostname.
+Usually, this will be an IP address from the Docker network, which is not resolvable from outside. Therefore, for local development you need to override the hostname with an IP address which is accessible from your local host where you develop extensions.
+When using the CLI, open the CLI folder <code>installer/cli</code>, navigate to <code>deploy/standalone/backend</code>, open the <code>docker-compose.dev.yml</code> file and add the SP_HOST env variable, e.g.</p>
+<pre><code class="hljs"><span class="hljs-symbol">version:</span> <span class="hljs-string">"3.4"</span>
+<span class="hljs-symbol">services:</span>
+<span class="hljs-symbol"> backend:</span>
+<span class="hljs-symbol"> ports:</span>
+ - <span class="hljs-string">"8030:8030"</span>
+<span class="hljs-symbol"> environment:</span>
+ - SP_HOST=host.docker.internal
+</code></pre>
+<p>Note that host.docker.internal will work as an alias under Docker for Desktop on Windows and Mac, but not on Linux or M1. In this case, provide a resolvable hostname or IP address manually.</p>
<h2><a class="anchor" aria-hidden="true" id="starter-projects"></a><a href="#starter-projects" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
<p>Now, once you've started the development instance, you are ready to develop your very first pipeline element.
Instead of starting from scratch, we recommend using our provided maven archetypes:</p>
@@ -81,7 +94,7 @@ Instead of starting from scratch, we recommend using our provided maven archetyp
<p>Create the Maven archetype as described in the <a href="/docs/docs/next/extend-archetypes.html">Maven Archetypes</a> guide.</p>
<h3><a class="anchor" aria-hidden="true" id="examples"></a><a href="#examples" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 [...]
<p>We provide several examples that explain the usage of some concepts in this <a href="https://github.com/apache/incubator-streampipes-examples">Github repo</a>.</p>
-</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/next/deploy-security.html"><span class="arrow-prev">← </span><span>Security</span></a><a class="docs-next button" href="/docs/docs/next/extend-cli.html"><span class="function-name-prevnext">StreamPipes CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#ide--required-dev-tools">IDE & required dev tools</a></li [...]
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/next/deploy-security.html"><span class="arrow-prev">← </span><span>Security</span></a><a class="docs-next button" href="/docs/docs/next/extend-cli.html"><span class="function-name-prevnext">StreamPipes CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#ide--required-dev-tools">IDE & required dev tools</a></li [...]
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
diff --git a/docs/docs/next/extend-tutorial-data-processors.html b/docs/docs/next/extend-tutorial-data-processors.html
index b400ae6..46b9b3e 100644
--- a/docs/docs/next/extend-tutorial-data-processors.html
+++ b/docs/docs/next/extend-tutorial-data-processors.html
@@ -330,6 +330,7 @@ In some cases, the detected hostname is not resolvable from within a container (
</p>
</div>
<p>Now we are ready to start our service!</p>
+<p>Configure your IDE to provide an environment variable called <code>SP_DEBUG</code> with value <code>true</code> when starting the project.</p>
<p>Execute the main method in the class <code>Init</code> we've just created, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a> (or the port you have assigned).</p>
<p>You should see something as follows:</p>
<p><img src="/docs/img/tutorial-processors/pe-overview-flink.PNG" alt="Pipeline Element Container Overview"></p>
diff --git a/docs/docs/next/extend-tutorial-data-sinks.html b/docs/docs/next/extend-tutorial-data-sinks.html
index f0391f4..ca244ce 100644
--- a/docs/docs/next/extend-tutorial-data-sinks.html
+++ b/docs/docs/next/extend-tutorial-data-sinks.html
@@ -244,6 +244,7 @@ In some cases, the detected hostname is not resolvable from within a container (
</p>
</div>
<p>Now we are ready to start our service!</p>
+<p>Configure your IDE to provide an environment variable called <code>SP_DEBUG</code> with value <code>true</code> when starting the project.</p>
<p>Execute the main method in the class <code>Init</code> we've just created, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a> (or the port you have assigned).</p>
<p>The services automatically registers itself in StreamPipes.</p>
<p>To install the created element, open the StreamPipes UI and follow the manual provided in the <a href="/docs/docs/next/use-install-pipeline-elements.html">user guide</a>.</p>
diff --git a/docs/docs/next/extend-tutorial-data-sources.html b/docs/docs/next/extend-tutorial-data-sources.html
index ed80eb6..0f75841 100644
--- a/docs/docs/next/extend-tutorial-data-sources.html
+++ b/docs/docs/next/extend-tutorial-data-sources.html
@@ -213,6 +213,7 @@ In some cases, the detected hostname is not resolvable from within a container (
</div>
<p>Now we are ready to start our first container!</p>
<p>Execute the main method in the class <code>Init</code>, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a>, or change the port according to the value of the <code>SP_PORT</code> variable in the env file.</p>
+<p>Configure your IDE to provide an environment variable called <code>SP_DEBUG</code> with value <code>true</code> when starting the project.</p>
<p>You should see something as follows:</p>
<p><img src="/docs/img/tutorial-sources/pe-overview.PNG" alt="Pipeline Element Container Overview"></p>
<p>Click on the link of the data source to see the generated description of the pipeline element.</p>