This is an automated email from the ASF dual-hosted git repository. riemer pushed a commit to branch dev in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-website.git
commit cf6ab9c3b1d4f1f522f79bf75154a34cee470260 Author: Dominik Riemer <[email protected]> AuthorDate: Tue Apr 27 10:02:06 2021 +0200 [STREAMPIPES-197] Improve installation page in docs --- documentation/docs/01_try-installation.md | 191 ++++++++++----------- documentation/website/static/css/custom.css | 20 ++- .../img/01_try-installation/01_register_user.png | Bin 0 -> 99577 bytes .../img/01_try-installation/02_user_set_up.png | Bin 0 -> 166282 bytes .../static/img/01_try-installation/03_login.png | Bin 0 -> 77382 bytes .../static/img/01_try-installation/04_home.png | Bin 0 -> 165926 bytes documentation/website/static/img/04_home.png | Bin 0 -> 165926 bytes 7 files changed, 111 insertions(+), 100 deletions(-) diff --git a/documentation/docs/01_try-installation.md b/documentation/docs/01_try-installation.md index e1f8e99..22a4827 100644 --- a/documentation/docs/01_try-installation.md +++ b/documentation/docs/01_try-installation.md @@ -1,30 +1,14 @@ --- -id: user-guide-introduction -title: Installation -sidebar_label: Installation +id: user-guide-introduction title: Installation sidebar_label: Installation --- -## Prerequisites - -### Hardware - -* Docker (latest version, see instructions below) -* Docker Compose (latest version., see instructions below) - -### Supported operating systems -We rely on Docker and support three operating systems for the StreamPipes system - -* Linux -* OSX -* Windows 10 - * Please note that older Windows versions are not compatible with Docker. Also Linux VMs under Windows might not work, due to network problems with docker. - -### Web Browser -StreamPipes is a modern web application, therefore you need a recent version of Chrome (recommended), Firefox or Edge. +The easiest way to install StreamPipes is our Docker-based installation. For production-grade deployments, we also +recommend looking at our Kubernetes support, which is also part of the installation kit. -### Docker -You need to have Docker installed on your system before you continue with the installation guide. +## Prerequisites +The Docker-based installation requires **Docker** and **Docker Compose** to be installed on the target machine. +Installation instructions can be found below. <div class="admonition info"> <div class="admonition-title">Install Docker</div> @@ -39,102 +23,115 @@ You need to have Docker installed on your system before you continue with the in Go to the advanced preferences and set the **number of CPUs to 6** (recommended) and the **Memory to 4GB**. After changing the settings, Docker needs to be restarted.</p></div> +### Supported operating systems + +The Docker-based installation supports the operating systems **Linux**, **Mac OS X** and **Windows 10**. Older windows +versions are not fully compatible with Docker. Linux VMs running under Windows might cause network problems with Docker, +therefore some manual work might be needed to make StreamPipes run properly. + +### Web Browser + +The StreamPipes application itself will be accessible through a web browser. We recommend a recent version of Chrome ( +best experience), Firefox or Edge. ## Install StreamPipes -<div class="tab-content" id="myTabContent"> - <div class="tab-pane fade show active" id="linux" role="tabpanel" aria-labelledby="linux-tab"> - <ul style="padding-left:0"> - <li class="installation-step"> - <div class="wrapper-container" style="align-items: center;justify-content: center;"> - <div class="wrapper-step"> - <span class="fa-stack fa-2x"> - <i class="fas fa-circle fa-stack-2x sp-color-green"></i> - <strong class="fa-stack-1x" style="color:white;">1</strong> - </span> - </div> - <div class="wrapper-instruction"> - <a href="https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=incubator/streampipes/installer/0.66.0/apache-streampipes-installer-0.66.0-incubating-source-release.zip";>Download</a> - the latest Apache StreamPipes release and extract the zip file to a directory of your choice. - </div> - </div> - </li> - <li class="installation-step"> - <div class="wrapper-container" style="align-items: center;justify-content: center;"> - <div class="wrapper-step"> - <span class="fa-stack fa-2x"> - <i class="fas fa-circle fa-stack-2x sp-color-green"></i> - <strong class="fa-stack-1x" style="color:white;">2</strong> - </span> - </div> - <div class="wrapper-instruction"> - <div style="margin-bottom:5px;"><b>Linux/Mac:</b> In a command prompt, open the folder <code>installer/osx_linux</code> and run <code>./streampipes - start</code>.<br/> - </div> - <div style="margin-top:5px;"> - <b>Windows 10:</b> In a command prompt, open the folder <code>installer/windows10</code> and run <code>streampipes.bat - start</code>.<br/> - </div> - </div> - </div> - </li> - <li class="installation-step"> - <div class="wrapper-container" style="align-items: center;justify-content: center;"> - <div class="wrapper-step"> - <span class="fa-stack fa-2x"> - <i class="fas fa-circle fa-stack-2x sp-color-green"></i> - <strong class="fa-stack-1x" style="color:white;">3</strong> - </span> - </div> - <div class="wrapper-instruction"> - When asked, enter the version (full or lite). - </div> - </div> - </li> - <li class="installation-step"> - <div class="wrapper-container" style="align-items: center;justify-content: center;"> - <div class="wrapper-step"> - <span class="fa-stack fa-2x"> - <i class="fas fa-circle fa-stack-2x sp-color-green"></i> - <strong class="fa-stack-1x" style="color:white;">4</strong> - </span> - </div> - <div class="wrapper-instruction"> - Open your browser, navigate to http://localhost:80 (or the domain name of your server) and finish the setup according to the instructions below. - </div> - </div> - </li> - </ul> +<ul style="padding-left:0"> + <li class="installation-step" style="margin-top:20px;"> + <div class="wrapper-container" style=""> + <div class="wrapper-step"> + <span class="fa-stack fa-2x"> + <i class="fas fa-circle fa-stack-2x sp-color-green"></i> + <strong class="fa-stack-1x" style="color:white;">1</strong> + </span> + </div> + <div class="wrapper-instruction"> + Download the latest Apache StreamPipes release and extract the zip file to a directory of your choice. + <table class="table" style="margin-top:30px;"> + <thead> + <tr style="background:rgb(27, 20, 100);color:white;"> + <th scope="col" style="border-bottom:0px;border-top:0px;">File</th> + <th scope="col" style="border-bottom:0px;border-top:0px;">Version</th> + <th scope="col" style="border-bottom:0px;border-top:0px;">Release Date</th> + <th scope="col" style="border-bottom:0px;border-top:0px;">Signatures</th> + </tr> + </thead> + <tbody> + <tr> + <td><a href="https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=incubator/streampipes/installer/0.67.0/apache-streampipes-installer-0.67.0-incubating-source-release.zip";>apache-streampipes-installer-0.67.0-incubating-source-release.zip</a></td> + <td>0.67.0</td> + <td>2020-10-27</td> + <td> + <a href="https://downloads.apache.org/incubator/streampipes/installer/0.67.0/apache-streampipes-installer-0.67.0-incubating-source-release.zip.sha512";>SHA</a> + <a href="https://downloads.apache.org/incubator/streampipes/installer/0.67.0/apache-streampipes-installer-0.67.0-incubating-source-release.zip.asc";>PGP</a> + </td> + </tr> + </tbody> + </table> + <div class="row"> + <div class="alert alert-info" role="alert"> + The above release file should be verified using the PGP signatures and the <a href="https://downloads.apache.org/incubator/streampipes/KEYS";>project release KEYS</a>. See the official ASF <a target="asf" href="https://www.apache.org/dyn/closer.cgi#verify";>verification instructions</a> for a description of using the PGP and KEYS files for verification. A SHA512 checksum is also provided as an additional verification method. + </div> + </div> + </div> + </div> + </li> + <li class="installation-step"> + <div class="wrapper-container"> + <div class="wrapper-step"> + <span class="fa-stack fa-2x"> + <i class="fas fa-circle fa-stack-2x sp-color-green"></i> + <strong class="fa-stack-1x" style="color:white;">2</strong> + </span> + </div> + <div class="wrapper-instruction"> + <div style="margin-bottom:5px;">In a command prompt, open the folder <code>compose</code> and run <code>docker-compose up -d</code>. + <div class="row" style="margin-top:10px;"> + <div class="alert alert-info" role="alert">The folder contains two docker-compose files: The standard file contains the so-called _lite_ installation, which includes less pipeline elements, but also requires for less performant hardware. The _full_ version includes also the Apache Flink wrapper and more pipeline elements, but requires for more memory. See the Github <a href="https://github.com/apache/incubator-streampipes-installer/tree/master/compose";>README</a> for [...] + </div> + </div> </div> </div> + </li> + <li class="installation-step"> + <div class="wrapper-container" style="align-items: center;justify-content: center;"> + <div class="wrapper-step"> + <span class="fa-stack fa-2x"> + <i class="fas fa-circle fa-stack-2x sp-color-green"></i> + <strong class="fa-stack-1x" style="color:white;">3</strong> + </span> + </div> + <div class="wrapper-instruction"> + Open your browser, navigate to http://localhost:80 (or the domain name of your server) and finish the setup according to the instructions below. + </div> + </div> + </li> +</ul> ## Setup StreamPipes -Once you've opened the browser at the URL given above, you should see StreamPipes application as shown below. -To set up the system, enter an email address and a password and click on install. -At this point, it is not necessary to change anything in the advanced settings menu. -The installation might take some time, continue by clicking on "Go to login page", once all components are successfully configured. - +Once you've opened the browser at the URL given above, you should see StreamPipes application as shown below. To set up +the system, enter an email address and a password and click on install. After the installation has finished, continue by clicking on "Go to login +page", once all components are successfully configured. On the login page, enter your credentials, then you should be forwarded to the home page. Congratulations! You've successfully managed to install StreamPipes. Now we're ready to build our first pipeline! <div class="my-carousel"> - <img src="/docs/img/quickstart/setup/01_register_user.png" alt="Set Up User"> - <img src="/docs/img/quickstart/setup/02_user_set_up.png" alt="SetUp StreamPipes Components"> - <img src="/docs/img/quickstart/setup/03_login.png" alt="Go to login page"> - <img src="/docs/img/quickstart/setup/04_home.png" alt="Home page"> + <img src="/docs/img/01_try-installation/01_register_user.png" alt="Set Up User"> + <img src="/docs/img/01_try-installation/02_user_set_up.png" alt="SetUp StreamPipes Components"> + <img src="/docs/img/01_try-installation/03_login.png" alt="Go to login page"> + <img src="/docs/img/01_try-installation/04_home.png" alt="Home page"> </div> <div class="admonition error"> <div class="admonition-title">Errors during the installation process</div> <p>In most cases, errors during the installation are due to an under-powered system.<br/> -If there is a problem with any of the components, please restart the whole system and delete the "config" directory on the server. - This directory is in the same folder as the docker-compose.yml file.<br/> +If there is a problem with any of the components, please restart the whole system (<code>docker-compose down</code> and eventually also delete the volumes). Please also make sure that your system meets the hardware requirements as mentioned in the first section of the installation guide.</p> </div> ## Next Steps -Now you can continue with the tutorial on page [First steps](user-guide-first-steps.md). +That's it! To ease your first steps with StreamPipes, we've created an [interactive tutorial](try-tutorial). diff --git a/documentation/website/static/css/custom.css b/documentation/website/static/css/custom.css index fcc20cc..9334e4f 100644 --- a/documentation/website/static/css/custom.css +++ b/documentation/website/static/css/custom.css @@ -110,12 +110,12 @@ li.installation-step { } .wrapper-step { - grid-column: span 3; + grid-column: span 2; margin-right: 10px; } .wrapper-instruction { - grid-column: spn 9; + grid-column: spn 10; } body { @@ -371,4 +371,18 @@ p { .sp-green { color: rgb(57,181,74); -} \ No newline at end of file +} + +.alert-info { + color: #0c5460; + background-color: #d1ecf1; + border-color: #bee5eb; +} + +.alert { + position: relative; + padding: .75rem 1.25rem; + margin-bottom: 1rem; + border: 1px solid transparent; + border-radius: .25rem; +} diff --git a/documentation/website/static/img/01_try-installation/01_register_user.png b/documentation/website/static/img/01_try-installation/01_register_user.png new file mode 100644 index 0000000..07cdc78 Binary files /dev/null and b/documentation/website/static/img/01_try-installation/01_register_user.png differ diff --git a/documentation/website/static/img/01_try-installation/02_user_set_up.png b/documentation/website/static/img/01_try-installation/02_user_set_up.png new file mode 100644 index 0000000..29f5380 Binary files /dev/null and b/documentation/website/static/img/01_try-installation/02_user_set_up.png differ diff --git a/documentation/website/static/img/01_try-installation/03_login.png b/documentation/website/static/img/01_try-installation/03_login.png new file mode 100644 index 0000000..8394415 Binary files /dev/null and b/documentation/website/static/img/01_try-installation/03_login.png differ diff --git a/documentation/website/static/img/01_try-installation/04_home.png b/documentation/website/static/img/01_try-installation/04_home.png new file mode 100644 index 0000000..8fcfa85 Binary files /dev/null and b/documentation/website/static/img/01_try-installation/04_home.png differ diff --git a/documentation/website/static/img/04_home.png b/documentation/website/static/img/04_home.png new file mode 100644 index 0000000..8fcfa85 Binary files /dev/null and b/documentation/website/static/img/04_home.png differ
