SKP Connector Requirements and Installation

This article contains Installation steps for the Syniti Knowledge Platform Connector. 

Installation Overview and Requirements

The Syniti Knowledge Platform Connector runs on Linux-based architectures and is installed and maintained using standard package management capabilities.

Supported Distributions:

Web Traffic

This is a list of common URLs to whitelist on any networks that are used for installation or upgrade of the Syniti Knowledge Platform. Refer to Web Traffic for a complete list.  

Syniti does not host third-party components that are required for a unique environment.

Note

The following list of URLs are split into two sections. The first section includes the URLs required for the normal operations of the SKP Connector. The second section includes the URLs required only for the installation and configuration of the SKP Connector.

Normal operations

The following URLs are dependent on the region of the tenant deployment. Only one is required. Please check the tenant domain and add the respective URL.

• https://*.syniti.com 

• https://*.syniti.eu

• https://*.syniti.au

• https://*.syniti.ca

• https://*.cloudfront.net

Installation and configuration

For installing Wireguard on RHEL 8.x and Oracle Linux 8.x:

• https://hpackagecloud.io 

• https://*.elrepo.org

• https://dl.fedoraproject.org

All operating systems:

• https://pypi.org

• https://www.wireguard.com/install/ (Wireguard tools only on all latest versions of the supported operating systems. Wireguard install itself required for RHEL8 and Oracle Linux8.)

• https://*.pypi.org

• https://files.pythonhosted.org

• https://*.oracle.com

• https://*.packagecloud.io

• https://*.python.org

• https://*.xtom.de

• https://*.boomi.com (optional if deploying Syniti Connect / Boomi)

Hardware Specifications

The following minimum hardware requirements are recommended for the Syniti Knowledge Platform Connector and all associated services. Only Intel/AMD-based processors are supported.

• 4 core CPU

• 16GB RAM

  Note

  If you are using Match, additional CPU/RAM is required. Refer to Requirements for more information.

• 50GB Disk

  • 125MB/s Disk Throughput

Software Prerequisites

The latest installation process checks all necessary prerequisites for the Syniti Knowledge Platform Connector and associated services. In the latest OS versions supported by the SKP Connector, the Wireguard prerequisite is part of the OS kernel.

Wireguard and WireguardTools (https://www.wireguard.com/install/) are required for the Syniti Knowledge Platform Connector machine. The install scripts check for their existence before continuing.

Additionally, the installation process checks for the following prerequisites:

• Wireguard and the corresponding Wireguard Tools

• Network Checker

• Unzip

• Libaio

• Java

• Python3 version (required >= 3.8, <= 3.10) 

• Oracle Instant Client

If any of the components above are not found, the installation user will be presented with the commands required to resolve the dependencies along with instructions on the order that they should be executed prior to a reboot and rerun of the installation script.

Network Traffic

The Syniti Knowledge Platform Connector initiates communication by sending traffic out to the Syniti Cloud using the following ports and protocols:

• TCP port 443: the Syniti Knowledge Platform Connector requests configuration details from the Syniti Cloud using HTTP over TLS (OUTBOUND only).

• UDP port 51820: the Syniti Knowledge Platform Connector initiates a Wireguard tunnel to the Syniti Cloud (OUTBOUND)

• IP v6 must be enabled on the server.

Static IPs

The Syniti Knowledge Platform Connector uses static IPs. Refer to Web Traffic in the online help for more information. 

Note

Customers MUST whitelist the Syniti IPs listed in Web Traffic for inbound traffic.

Install the SKP Connector

`sudo` access is required on the Linux machine in order to install the SKP Connector. 

To install the SKP Connector:

1. Download the appropriate script for your operating system: Knowledge Platform Connector - Download

2. Move the script to the machine where you want to install the Syniti Knowledge Platform Connector. Make note of the folder; it will be used again in the installation process. 

3. Run the script as sudo with: sudo bash <install_script> <flags>

4. When installing the SKP Connector, the script takes in a required parameter, which depends on your client's region:
   

   Country	Parameter	Notes
   USA	-u	Use this parameter if your tenant domain ends with .com, as this indicates an installation in the US.
   Europe (Germany)	-e	Use this parameter if your tenant domain ends with .eu.
   APJ (Australia)	-a	Use this parameter if your tenant domain ends with .au, as this indicates an installation in the APJ region.
   Canada	-c	Use this parameter if your tenant domain ends with .ca, as this indicates an installation in Canada.

    

   For example, this command installs the Syniti Knowledge Platform Connector and associated services pointing back to a tenant running in the US: sudo bash syniti_install_ubuntu -u If you do not pass in a flag or pass in an incorrect flag, the script returns a message and guides you to use the proper command.

   Note

   This location refers to your tenant’s region, not the region in which your SKP Connector is installed.

   Note

   To update this value, refer to the instructions in the section Reconfigure SKP Connector Services.

   Note

   When running the installation script for the first time it will check that all prerequisites are present on the machine.  If any prerequisites are missing then the installation script will output the commands to execute as an output of the initial execution.  The installation user should copy those commands out to a text document / editor so that they can run each of the individual steps in the order specified prior to a reboot and then running the installation script for a second time.

   Example output from initial script execution:

   One or more pre-requisites are missing. Please follow the :

     - Please run the following commands to install all the missing requirements:

       - sudo yum install wireguard-tools nmap unzip libaio java-11-openjdk -y

     - Please run the following command to install Oracle Instant Client in the proper folder: 

         curl https://download.oracle.com/otn_software/linux/instantclient/216000/instantclient-basic-linux.x64-21.6.0.0.0dbru.zip --output instantclient-basic-linux.x64-21.6.0.0.0dbru.zip

         sudo mkdir -p /opt/oracle

         sudo unzip instantclient-basic-linux.x64-21.6.0.0.0dbru.zip -d /opt/oracle/

         rm instantclient-basic-linux.x64-21.6.0.0.0dbru.zip

         sudo rm -rf /opt/oracle/instantclient

         sudo mv /opt/oracle/instantclient_21_6 /opt/oracle/instantclient

   Once complete, please REBOOT the server and then rerun this script with [sudo bash syiti_install_rhel.sh]

5. The final step of the script displays the Public Key of the SKP Connector. Copy this string of characters for registration in the Syniti Knowledge Platform.

Register the SKP Connector in the Syniti Knowledge Platform

To register the SKP Connector:

1. Verify you have Administrator permissions in the Syniti Knowledge Platform. 

2. Click the user avatar in the top right corner.

3. Click Admin in the dropdown menu.

4. Click SKP Connectors on the left.

5. Click Register SKP connector.

6. Enter a name for the connector in the Name field.

   Note

   Name the SKP Connector with enough information to provide troubleshooting later, such as the IP address or other identifying information.

7. Paste the public key value from the server where the SKP Connector is installed in the Public Key field.

8. Click Save.

9. Click Confirm.

10. Click SKP Connectors on the left to go back to the Connectors page.

11. Locate the connector you just created and click the Test connection button to test the connection you just saved.

Note

It may take up to 60 seconds for the initial connection to be established so if the test connection fails, please try again after a couple of minutes. A successful test is confirmed with a green check in a green circle in the Last Test Result column.