Server Installation Requirements
- 02 Jul 2024
- 3 Minutes to read
- DarkLight
- PDF
Server Installation Requirements
- Updated on 02 Jul 2024
- 3 Minutes to read
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Server installation is one of the first actions to be done for any KYP.ai implementation. Before server is installed, a decision on cloud vs. on-premise approach needs to be made. Cloud-based servers are installed and managed by KYP.ai or KYP.ai Implementation Partner, and on-premise servers are installed and managed by your IT.
Infrastructure
As a base, KYP needs 1 machine with the below requirements. It can be setup as a physical machine or a Virtual machine in a cloud provider.
Additional components like Web Application Firewall etc can be added to the setup.
All components will run on this machine as docker containers. With more data delivered by users, eg.1000+ please contact KYP.ai Team for more details.
Below hardware specification assumes server virtualization. In case of using Physical server / Bare metal please ask KYP.ai Team for detailed requirements.
Configuration for OPS monitoring purposes (without screenshot processing):
| No. of users | < 30 users | 30 – 300 users | 300 – 1000 users |
|---|---|---|---|
Processor Architecture x86_64 | 4 vCPU | 8 vCPU | 16 vCPU |
Memory | 16 GB | 32 GB | 64 GB |
Storage Fast, attached disk as the additional partition File system: ext4 or xfs with ftype=1 (d_type support enabled) | 100 GB IOPS ~1000 | 500 GB IOPS ~1500 | 1,5 TB IOPS ~3000 |
Configuration for Process Discovery / PoC purpose (with screenshot processing):
| No. of users | < 30 users | 30 - 300 users | 300 - 1000 users |
|---|---|---|---|
Processor Architecture x86_64 | 8 vCPU | 16 vCPU | 32 vCPU |
Memory | 32 GB | 64 GB | 128 GB |
Storage Fast, attached disk as the additional partition File system: ext4 or xfs with ftype=1 (d_type support enabled) | 800 GB* IOPS~3000 | 5 TB* IOPS~4500 | 16 TB* IOPS~6000 |
* Storage calculated based on: 30 days screenshots retention, 25% usage of screenshot apps and 12 months of contract.
More detailed hardware calculations can be made based on the below xls form:
For Cloud installation You can find here example machines:
OPS
| Users / Provider | AWS | GCP | OVH | Azure | OCI |
|---|---|---|---|---|---|
< 30 users | m4.xlarge with 'GP3' | n2-standard-4 with 'pd-standard' | b2-15 with 'high speed storage' | D4as v4 with 'premium SSD' | VM.Standard3.Flex(4ocpu,16GB) with 'lower cost volume' |
30 – 300 users | m4.2xlarge with 'GP3' | n2-standard-8 with 'pd-standard' | b2-30 with 'high speed storage' | D8as v4 with 'premium SSD' | VM.Standard3.Flex(8ocpu,32GB) with 'balanced volume' |
| 300 - 1000 users | m4.4xlarge with 'GP3' | n2-standard-16 with 'pd-ssd' | b2-60 with 'high speed storage' | D16as v4 with 'premium SSD' | VM.Standard3.Flex(16ocpu,64GB) with 'balanced volume' |
PD
| Users / Provider | AWS | GCP | OVH | Azure | OCI |
|---|---|---|---|---|---|
< 30 users | m5.2xlarge with 'GP3' | n2-standard-8 with 'pd-ssd' | b2-30 with 'high speed storage' | D8as v4 with 'premium SSD' | VM.Standard3.Flex(8ocpu32GB) with 'balanced volume' |
30 – 300 users | m5.4xlarge with 'GP3' | n2-standard-16 with 'pd-ssd' | b2-60 with 'high speed Gen2 storage' | D16as v4 with 'premium SSD' | VM.Standard3.Flex(16ocpu,64GB) with 'balanced volume' |
| 300 - 1000 users | m5.8xlarge with 'GP3' | n2-standard-32 with 'pd-ssd' | b2-120 with 'high speed Gen2 storage' | D32as v4 with 'ultra SSD' | VM.Standard3.Flex(32ocpu,128GB) with 'balanced volume' |
Network
- Available ports:
- 80, 443 - for HTTP(S) desktop connectivity (data delivery) and web application access
- 22 - for SSH server maintenance
- Internet or package repository access on the server installation time (OS packages)
- Outgoing communication based on HTTPS protocol to *.kyp.ai for downloading KYP.ai installation/upgrade packages
- Register DNS entry for the server
- SSL certificate generated for the server domain name
- HTTPS traffic can not be filtered for specific phrases or conditions
- Required network bandwidth 2Mb/s for 50 users
For detailed networking please check "Network Sizing Section"
Optional:
- In case of Load Balancer usage:
- Register DNS entry for the load balancer
- SSL certificate generated for the load balancer
- Load Balancer traffic on port 443 should be redirected to the server on port 80
- Data collection monitoring outbound communication port to email server on port 587/465, not filters emails sent to monitoring@kyp.ai
- LDAP/Active Directory communication to LDAP server on port 389/636
- Access to user repositories for single sign-on eg. Microsoft Azure AD Server (https://login.microsoftonline.com and https://graph.microsoft.com), OpenID
Backup:
The application has a default setup to keep the last 6 days' backups of the main database on local storage. These parameters can be changed and need to be agreed upon before deployment. The best practice is to keep backups on different storage i.e. AWS S3 and it needs to be configured in a backup script.
Software
- Operating system - Enterprise Linux Server recommended - Ubuntu 20.04.5 or later, optional - RHEL 8.7 (RedHat) or later, Fedora 37 or later
- The following list contains necessary tools that need to be installed on the server before the KYP installation process, which is needed to run during this process
| Tool | Version |
|---|---|
Wget | 1.14 |
Curl | 7.29.0 |
Zip | 3.0 |
Unzip | 6.0 |
Htop | 2.2.0 |
ctop | 0.7.5 |
mc | 4.8.7 |
docker | 23.0.1 |
docker-compose | 2.16.0 |
logrotate | 3.8.6 |
vim | 7.4 |
net-tools | latest |
- KYP.ai packages with system downloaded from KYP.ai repository
Access:
- SSH access to the server by the user (KYP DevOps Team) with root rights granted for installation and daily maintenance
- Constant HTTPS access to the server by the Customer Success team for configuration and data analyze
- Constant access to one virtual machine in the Customer environment for uploading files to the server with preinstalled KYP agent for testing purposes
Was this article helpful?
