This is an automated email from the ASF dual-hosted git repository. zehnder pushed a commit to branch release/0.92.0 in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
commit 1bf1ec3d1a4a1970964b946c35662f424446a25b Author: Philipp Zehnder <[email protected]> AuthorDate: Fri Jun 16 11:22:26 2023 +0200 [release] Update docusaurus version --- documentation/docs/01_try-installation.md | 7 --- documentation/website/i18n/en.json | 8 ++++ .../version-0.91.0/01_try-installation.md | 7 --- .../version-0.92.0}/01_try-installation.md | 10 +---- .../version-0.92.0/06_extend-setup.md | 51 ++++++++++++++++++++++ documentation/website/versions.json | 1 + 6 files changed, 62 insertions(+), 22 deletions(-) diff --git a/documentation/docs/01_try-installation.md b/documentation/docs/01_try-installation.md index b274b25f..35a18f4a 100644 --- a/documentation/docs/01_try-installation.md +++ b/documentation/docs/01_try-installation.md @@ -32,13 +32,6 @@ best experience), Firefox or Edge. ## Install StreamPipes -<div class="admonition info"> - <div class="admonition-title">Migration from 0.90.0 to 0.91.0</div> - <p>When upgrading an existing installation from 0.90.0 to 0.91.0, set the environment variable -<b>SP_INFLUX_INIT_MODE</b> to <b>upgrade</b> instead of <b>setup</b> due to an upgrade of the underlying time-series storage. </p> -<p>Depending on the installation type, this needs to be set in the <b>.env</b> or the <b>values.yml</b> file.</p> -</div> - <ul style="padding-left:0"> <li class="installation-step" style="margin-top:20px;"> <div class="wrapper-container" style=""> diff --git a/documentation/website/i18n/en.json b/documentation/website/i18n/en.json index d5ba9198..56a7897e 100644 --- a/documentation/website/i18n/en.json +++ b/documentation/website/i18n/en.json @@ -2619,6 +2619,14 @@ "version-0.91.0/version-0.91.0-user-guide-introduction": { "title": "Apache StreamPipes Documentation", "sidebar_label": "Overview" + }, + "version-0.92.0/version-0.92.0-try-installation": { + "title": "Installation", + "sidebar_label": "Installation" + }, + "version-0.92.0/version-0.92.0-extend-setup": { + "title": "Development Setup", + "sidebar_label": "Development Setup" } }, "links": { diff --git a/documentation/website/versioned_docs/version-0.91.0/01_try-installation.md b/documentation/website/versioned_docs/version-0.91.0/01_try-installation.md index 265908d2..75198893 100644 --- a/documentation/website/versioned_docs/version-0.91.0/01_try-installation.md +++ b/documentation/website/versioned_docs/version-0.91.0/01_try-installation.md @@ -33,13 +33,6 @@ best experience), Firefox or Edge. ## Install StreamPipes -<div class="admonition info"> - <div class="admonition-title">Migration from 0.90.0 to 0.91.0</div> - <p>When upgrading an existing installation from 0.90.0 to 0.91.0, set the environment variable -<b>SP_INFLUX_INIT_MODE</b> to <b>upgrade</b> instead of <b>setup</b> due to an upgrade of the underlying time-series storage. </p> -<p>Depending on the installation type, this needs to be set in the <b>.env</b> or the <b>values.yml</b> file.</p> -</div> - <ul style="padding-left:0"> <li class="installation-step" style="margin-top:20px;"> <div class="wrapper-container" style=""> diff --git a/documentation/docs/01_try-installation.md b/documentation/website/versioned_docs/version-0.92.0/01_try-installation.md similarity index 93% copy from documentation/docs/01_try-installation.md copy to documentation/website/versioned_docs/version-0.92.0/01_try-installation.md index b274b25f..b3df6edb 100644 --- a/documentation/docs/01_try-installation.md +++ b/documentation/website/versioned_docs/version-0.92.0/01_try-installation.md @@ -1,7 +1,8 @@ --- -id: try-installation +id: version-0.92.0-try-installation title: Installation sidebar_label: Installation +original_id: try-installation --- The easiest way to install StreamPipes is our Docker-based installation. For production-grade deployments, we also @@ -32,13 +33,6 @@ best experience), Firefox or Edge. ## Install StreamPipes -<div class="admonition info"> - <div class="admonition-title">Migration from 0.90.0 to 0.91.0</div> - <p>When upgrading an existing installation from 0.90.0 to 0.91.0, set the environment variable -<b>SP_INFLUX_INIT_MODE</b> to <b>upgrade</b> instead of <b>setup</b> due to an upgrade of the underlying time-series storage. </p> -<p>Depending on the installation type, this needs to be set in the <b>.env</b> or the <b>values.yml</b> file.</p> -</div> - <ul style="padding-left:0"> <li class="installation-step" style="margin-top:20px;"> <div class="wrapper-container" style=""> diff --git a/documentation/website/versioned_docs/version-0.92.0/06_extend-setup.md b/documentation/website/versioned_docs/version-0.92.0/06_extend-setup.md new file mode 100644 index 00000000..acd733e4 --- /dev/null +++ b/documentation/website/versioned_docs/version-0.92.0/06_extend-setup.md @@ -0,0 +1,51 @@ +--- +id: version-0.92.0-extend-setup +title: Development Setup +sidebar_label: Development Setup +original_id: extend-setup +--- + +Pipeline elements in StreamPipes are provided as standalone microservices. New pipeline elements can be easily developed using the provided Maven archetypes and can be installed in StreamPipes at runtime. + +In this section, we describe our recommended minimum setup for locally setting up a development instance of StreamPipes needed to develop, run and test new pipeline elements. + +## IDE & required dev tools +StreamPipes does not have specific requirements on the IDE - so feel free to choose the IDE of your choice. +The only requirements in terms of development tools are that you have Java 17 and Maven installed. + +## StreamPipes CLI: Docker-based local StreamPipes instance +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. + +The documentation on the usage of the CLI tool is available [here](06_extend-cli.md). + +## Override the SP_HOST variable + +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 ``installer/cli``, navigate to ``deploy/standalone/backend``, open the ``docker-compose.dev.yml`` file and add the SP_HOST env variable, e.g. + +``` +version: "3.4" +services: + backend: + ports: + - "8030:8030" + environment: + - SP_HOST=host.docker.internal +``` + +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. + +## Starter projects + +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: + +### Maven archetypes + +Create the Maven archetype as described in the [Maven Archetypes](06_extend-archetypes.md) guide. + +### Examples + +We provide several examples that explain the usage of some concepts in this [Github repo](https://github.com/apache/streampipes-examples). diff --git a/documentation/website/versions.json b/documentation/website/versions.json index 2abba580..15c29ee4 100644 --- a/documentation/website/versions.json +++ b/documentation/website/versions.json @@ -1,4 +1,5 @@ [ + "0.92.0", "0.91.0", "0.90.0", "0.70.0",
