KNIME Server Installation Guide
Total Page:16
File Type:pdf, Size:1020Kb
KNIME Server Installation Guide KNIME AG, Zurich, Switzerland Version 4.12 (last updated on 2021-09-08) Table of Contents Introduction. 1 Installation planning. 2 KNIME Server variants . 2 Supported operating systems . 2 Network requirements . 3 Hardware requirements . 3 Java requirements. 3 Software requirements . 3 Installation steps . 6 KNIME Server single node installation on Windows . 6 KNIME Server single node installation on Linux . 13 Automatically starting KNIME Server. 20 Creating a Windows service. 20 Running Executors as services on Windows . 21 Creating a Linux service . 21 Running Executors as services on Linux . 23 KNIME Server settings. 25 KNIME Server authentication . 25 Distributed KNIME Executors . 26 Installation steps. 26 KNIME Server Installation Guide Introduction KNIME Server is an enterprise-grade solution for advanced analytics workloads such as sharing workflows, and executing workflows. KNIME Server consists of a server side component and a client interface. The server side component is based on a Tomcat application server, and uses a KNIME Executor to execute the workflows. KNIME Server provides KNIME software users with a shared remote workflow repository. Workflows can be uploaded to and stored on the Server or retrieved from it to a local KNIME workspace. This is done via the client interface which is integrated in KNIME Analytics Platform. For an overview on how to use the KNIME Analytics Platform as a client interface with KNIME Server please refer to the KNIME Server User Guide. Workflows on the Server can be executed as jobs either as needed or as part of a one time or periodically scheduled event. Additionally, workflows may be executed through a web browser using the KNIME WebPortal or via RESTful web service interfaces which allow control from 3rd party applications. This document aims to give a quick overview of the steps needed to perform the installation of KNIME Server, and a short description of the options that can be changed at install time. After installation, you can refer to the KNIME Server Administration Guide for detailed information about the Server architecture, configuration options and general administration tasks. Please be aware that to make use of KNIME Server you will need a license. If you have not received a license file, please contact KNIME ([email protected]), or get in touch with your local KNIME representative. © 2020 KNIME AG. All rights reserved. 1 KNIME Server Installation Guide Installation planning KNIME Server variants KNIME Server is available in the following variants. All single node instances can be installed in the same way with respect to the operating system. KNIME Server Large also has the possibility to use multiple KNIME Executors in a distributed system. • Single node ◦ KNIME Server Small ◦ KNIME Server Medium ◦ KNIME Server Large • Distributed KNIME Executors ◦ KNIME Server Large Beginning with KNIME Server 4.11, we use an integrated message broker for communication between application server and Executor, based on Apache Qpid (https://qpid.apache.org/). This can be used for running single node KNIME Server installations. Apache Qpid is bundled as part of all KNIME Server installations, so no additional setup is necessary. If you want to set up distributed KNIME Executors for KNIME Server Large, please follow all steps in this document related to the main installation, and then follow the additional steps outlined here. This explains how to setup RabbitMQ (which is used as message broker instead of Qpid), as well as how to add additional Executors. Supported operating systems KNIME Server can be installed on machines running either Windows or Linux. The following operating systems are officially supported: • Windows Server 2016, 2019 • Ubuntu 16.04 LTS, 18.04 LTS, 20.04 LTS and derivatives • RHEL/CentOS 7.x and 8 KNIME Server may also run on other operating systems, however, we neither test nor support them through the KNIME Server standard support package. © 2020 KNIME AG. All rights reserved. 2 KNIME Server Installation Guide Network requirements • KNIME Server (Small, Medium, or Large) on a single node: ◦ Port 8080, 8443 must be accessible from all KNIME Analytics Platform clients requiring access to the Server ◦ Port 8080, 8443 must be accessible for all browsers requiring WebPortal access • KNIME Server Large with distributed KNIME Executors ◦ Port 8080, 8443 must be accessible from all KNIME Analytics Platform clients requiring access to the Server ◦ Port 8080, 8443 must be accessible for all browsers requiring WebPortal access ◦ Port 5672, must be accessible on both the KNIME Server and KNIME Executors in order for them to communicate with each other. Hardware requirements • A 64-bit operating system with at least 32GB RAM and 8 CPU cores as minimum. Please contact KNIME for sizing help. • KNIME Server stores all workflows and related configuration information in the KNIME Server workflow repository. The folder, that will be created during the installation process, should exist on a local drive and have enough free space to store the workflows and jobs. We recommend a minimum of 250 GB, although this may need to be increased considerably depending on the intended use case. Java requirements For fresh installations of KNIME Server, we recommend using Java Development Kit (JDK) 11, and officially support AdoptOpenJDK distributions of JDK. Software requirements Assuming that: • You want to perform an installation where the Tomcat application server and KNIME Executor live on the same machine • You have internet access on the target machine where you want to perform the installation © 2020 KNIME AG. All rights reserved. 3 KNIME Server Installation Guide You can install the Executor during the Server installation process. You can then skip the next section and move to the installation steps sections for Windows or Linux operating systems. In case the above assumptions do not apply you can download the Executor before starting the Server installation process and point to the Executor installation folder when requested. Install KNIME Executor You can install KNIME Executor downloading its executable from here. On Windows: • The self-extracting archive simply creates a folder containing the KNIME Executor installation files. You don’t need any software to manage archiving. • The zip archive can be downloaded, saved, and extracted in your preferred location. We recommend to use an archive utility such as 7-zip for extraction, as the Windows built- in zip file utility may have trouble with some of the long filenames. On Linux: • Extract the downloaded tarball to a folder of your choice: tar -xvf knime-full-latest43-linux.gtk.x86_64.tar.gz -C /<executor-folder>/ Make sure that users other than the installation owner either have no write permissions to the installation folder at all or that they have full write permission to at least the "configuration" folder. Otherwise you may run into startup issues. We strongly recommend revoking all write permissions from everybody but the installation owner. © 2020 KNIME AG. All rights reserved. 4 KNIME Server Installation Guide You can download and install the extensions to the Executor adding Local Update Sites as zip files if you have limited internet access on the target machine. You can download the KNIME update sites as zip files at the links listed here. Please note also that a standard KNIME Analytics Platform build will not be sufficient to be used as Executor. In case you want to use a pre-existing KNIME Analytics Platform installation as an Executor you will need to install the KNIME Executor connector extension, available from the pre-registered KNIME Analytics Platform update site. To install it run the KNIME Analytics Platform instance that is intended to be the Executor and navigate to File → Install KNIME Extensions… and select KNIME Executor connector under KNIME Server Extensions. The versions of the KNIME Server Executor extensions must match the server’s version (e.g. "4.12"). Also you may want to install the KNIME Report Designer extension to the KNIME Analytics Platform build to be used as KNIME Executor. Finally, please also be aware that you will need a different KNIME Analytics Platform installation to use as client interface. In case you will need to install additional extensions to the Executor please refer to the KNIME Executor administration section of the KNIME Server Administration Guide. Client interface A KNIME Analytics Platform is needed to use it as client interface. KNIME Analytics Platform is available to install for operating system Windows, Linux, or macOS (independent from the Server OS). © 2020 KNIME AG. All rights reserved. 5 KNIME Server Installation Guide Installation steps KNIME Server single node installation on Windows We will install Java, download the KNIME Server installer, install KNIME Server alongside with KNIME Executor, and perform a small test to validate the KNIME Server. This includes options to configure automatic startup and shutdown processes for KNIME, email configuration, and uploading of a KNIME Server License. The first step is to download and install the latest Hotspot OpenJDK 11 (LTS) from the AdoptOpenJDK Website. Please check that JDK is added to $JAVA_HOME during the installation process. If it is not the case please manually add the path to AdoptOpenJDK to $JAVA_HOME in the environment variables list under System Variables. © 2020 KNIME AG. All rights reserved. 6 KNIME Server Installation Guide During the installation process take note of the path to the JDK installation as you will need to point to it later during the installation process. It usually is C:\Program Files\AdoptOpenJDK\jdk-<jdk-version> by default. Administrator root Do not install the Server as or user! Follow the installation instructions step by step. Don’t skip anything unless it is marked as optional. In case you are installing KNIME Server on a machine which already has RabbitMQ installed, please stop the RabbitMQ service first before starting the installation. 1. Download and launch the KNIME Server installer.