- System requirements
- The Kiuwan On-Premises installation tool (kiuwan-cluster)
- Installation: common steps
- Installation: single-host and minimum configuration
- Installation: modifying the default domain
- Installation: externalizing services
- Installation: using Amazon S3 as file repository
- Installation: advanced configuration
- Accessing your Kiuwan On-Premises installation
Kiuwan On-Premises installer is a powerful tool that suits multiple environment scenarios:
- Single-host full contained installation.
- Multi-host installation where infrastructure services are externalized.
- Multi-host installation where kiuwan services are distributed (only AWS environments supported so far).
- Any combination of the two previous scenarios.
Depending on your needs, a different installation approach will be needed. Check this installation guide for details on how to proceed and to find the solution that best fits your requirements.
It is mandatory for any host where Kiuwan On-Premises is installed to meet these requirements:
- Linux distribution
- Linux kernel version 3.10 or higher
- Connectivity to SMTP Mail Server.
- Internet connectivity during the installation process (see Installation guide).
- Installing user must be root or have sudo privileges.
These softwares are also needed:
- Docker CE >=19.03.2
- Docker-compose >= 1.24.1
- GNU tar
- Java Runtime Environment >=8 (needed to generate keystores for custom hosts).
- Openssl >= 1.1.1 (needed to generate certificates for custom hosts).
Needed internet connections
Please make sure your host machines have connection to these servers when installing Kiuwan On-Premises:
|https://hub.docker.com||Installing||This is the main Docker server where the needed images will be pulled from.|
|https://static.kiuwan.com||Installing||This is Kiuwan's static content server, needed by the installer to download needed resources.|
You own a Kiuwan On-Premises Insights license, both for installing and running
|This is Kiuwan's central API endpoint, needed to update Insights vulnerabilities database.|
CPU and memory minimum requirements
The following table shows the minimum requirements for each service. Note that these are only minimum requirements. You should take care of giving each service enough resources depending on your system demands.
Note: CPU clock speed and disk speed will affect overall response time.
With the above configuration, a system with the following load should give continuous service without problems:
- Parallel processing of 2 analyses (any additional parallel analysis request will be enqueued, and it will be executed as soon as any of the running analyses finishes)
- 50 concurrent web users or REST API calls.
Given the table above, for a single-host installation where no service is externalized the minimum system requirements are:
- 14GB of RAM and a processor with 8 cores for Kiuwan On-Premises.
It is recommended that you overscale these characteristics for the OS to have resources available for itself.
The Kiuwan On-Premises installation tool (kiuwan-cluster)
The Kiuwan On-Premises installation process is carried out by our "kiuwan-cluster" tool.
The tool is provided as a tar.gz file. The following table summarizes the resources you will find once the tool distribution is extracted:
|/config/volumes.properties||Configuration file to set where your persistent volumes will reside.|
|/docker/*.sh||Advanced shell scripts to interact with your Kiuwan On-Premises installation.|
|/logs||The folder where the tool will write installation logs.|
|/ssl||Tools that ease the certificate creation to keep Kiuwan On-Premises under a secure environment.|
|/user-content||The folder where you will have to put some resources the installation process will need.|
|/volumes||The base persistent volumes (that may be copied to different locations depending on your installation needs).|
|Main shell scripts to interact with your Kiuwan On-Premise installation.|
The following sections will guide you through the installation process.
Installation: common steps
This guide will reference two important folders:
- [INSTALL_DIR]: where the installation tool (kiuwan-cluster) will be located.
- [VOLUMES_DIR]: where the persistent volumes will be located.
Sometimes these folders will be referenced inside command line examples. Please make sure you replace any of them with the needed real path.
Note that it is up to you where these folders will be located.
Step 1: download kiuwan-cluster
The first step is to download kiuwan-cluster (the Kiuwan On-Premises installation tool). It can be downloaded directly from a terminal like this:
This will download the latest available installation tool to the current directory.
Step 2: untar kiuwan-cluster
Once downloaded, you should untar the provided gz file:
This will untar the installation tool to a folder with extended version information of the tool. For example:
This folder will be referred to as [INSTALL_DIR] throughout this guide.
Step 3: copy license files
In order to be able to start a Kiuwan On-Premises installation, you will need two license files:
Copy these files to the user-content folder of your installation tool directory (please replace [INSTALL_DIR] with the real location of your installation directory):
Step 4: download and copy the needed driver version for MySQL
Kiuwan On-Premises needs this exact MySQL driver:
You can download it by executing this command and extracting the jar file included inside the tar:
Copy the connector jar file to the user content folder:
Step 5: initialize your volumes
The installation tool comes with the base volumes to boot a first installation of Kiuwan On-Premises. We provide three volumes:
- config-shared: contains the base configuration, shared between different services.
- data-shared: contains the base data structure, shared between different services.
- data-local: contains the base data structure, independent for each service.
Copy the provided volumes to your desired location:
Step 6: configure the created volume paths
Edit the file located in [INSTALL_DIR]/config/volumes.properties and set the previous paths to each property:
Please remember that [VOLUMES_DIR] here is just a placeholder for the real path you chose.
Step 7: configure your email server
Kiuwan needs an working and accessible e-mail server to send notifications.
Edit with your preferred editor the main configuration file, found in your [VOLUMES_DIR]:
Edit the following properties under the section named "Kiuwan instances shared configuration":
kiuwan.mail.host: the host of your email server.
kiuwan.mail.port: the port of your email server.
kiuwan.mail.username: the username to use when authenticating with your email server.
kiuwan.mail.password: the password to use when authenticating with your email server.
kiuwan.mail.from: the email account to use as the sender.
- kiuwan.default.mail.account: the email account to set to your default Kiuwan user.
Installation: single-host and minimum configuration
Follow this section if you want to proceed and install Kiuwan On-Premises with no further customization.
The defaults will install Kiuwan On-Premises with these characteristics:
- Single-host installation, including these services (see System architecture for more details):
- Apache as a load balancer.
- A Kiuwan front instance.
- A Kiuwan analyzer instance.
- A Kiuwan scheduler instance.
- MySQL database.
- Redis cluster.
- HTTPS support when accessing Kiuwan and between the loadbalancer and Kiuwan instances.
- Kiuwan On-Premises deployed in the default domain (
If this is enough for you, just continue with the following steps.
Step 1: deploy user content
On a terminal, navigate to the [INSTALL_DIR] folder and execute this command:
This will copy the user-content files to the configured volumes and set the needed permissions.
Step 2: install Kiuwan On-Premises
On a terminal, navigate to the [INSTALL_DIR] folder and execute this command:
- Download and run the needed Docker images.
- Install the database resources for Kiuwan On-Premises.
- Download the latest available Local Analyzer, Engine and Kiuwan for Developers to make them available in your installation.
- Install the engine data in your Kiuwan On-Premises database.
- Autogenerate the needed configuration for each Kiuwan instance.
- Run all the needed containers.
Once the installation is finisished please refer to the Installation guide section.
Installation: modifying the default domain
The default configuration sets "kiuwan.onpremise.local" as the default domain to access Kiuwan On-Premises.
We encourage to change the default domain, but take into account that this means updating the provided certificates to keep your installation connections secure.
Step 1: edit the global configuration file
Using your favourite editor, edit the default configuration file located in your config-shared volume:
Edit these properties (kiuwan.port is only needed if you want to use https under a different port than the default 443):
Step 2: generate new certificates
Please refere to the Managing certificates guide and follow the needed steps depending on your needs.
Once this is done, you should have these files under the [INSTALL_DIR]/user-content/certs folder:
Step 3: complete your installation
If you are performing a new Kiuwan On-Premises installation, please refer to the steps indicated in the following sections, depending on your installation needs:
If you have already installed Kiuwan On-Premises, you will need to stop your containers, update the deployed configuration and restart them. To do so, execute these commands:
Step 4: update your DNS or hosts files
If you are modifying an existing Kiuwan On-Premises installation, you will need to update your DNS or hosts files.
Note that if you have generated new certificates signed by a different CA than the one that signed the previous ones, you should update your Kiuwan On-Premises clients certificates or truststores.
Please refer to Installation guide for details on these topics.
Installation: externalizing services
Kiuwan On-Premises uses three main services under its infrastructure's hood:
- Apache: used as a load balancer when multiple Kiuwan frontal instances are running.
- Redis: an in-memory cache to speed up response times.
- MySQL: Kiuwan's main database.
If you want to use your own services for any of the previous, Kiuwan On-Premises can connect to them bypassing their creation at installation time.
Configuring services to externalize
First of all, you will need to edit the main configuration file and mark which services you want to externalize:
This table shows the properties you should modify when externalizing each service:
When setting to "true" any of the previous properties, the corresponding service will be externalized and the installation tool will not manage any related instance. Note that all the configuration will be up to you, as the Kiuwan On-Premise installer will only be able to configure how Kiuwan On-Premise will connect to your own services.
When externalizing this service you should take into account that:
- Each Kiuwan On-Premises frontal instance domain name is wildflykiuwan-f[n], being [n] the frontal instance number. Note that depending on your installation needs you may want to access each instance via IP or its own host name.
- Each Kiuwan On-Premises frontal instance only exposes the port 8[n]43 for https traffic, being [n] the frontal instance number.
- You should provide your frontal service the needed certificates in order to make https connections available (please refer to Managing certificates for more information):
In case you set Redis as an external service, Kiuwan On-Premises needs to know where each Redis nodes are deployed and which ports to use when connecting to them.
In case you use an special DNS that can resolve the same host to different hosts and ports (DNS Round-Robin or equivalent), you should configure just an single host.
All the needed configuration is located in the main configuration file:
The following table shows the properties to configure (note that you should set exactly the same configuration for both "cache" and "store" Redis configurations):
|redis.[cache|store].nodes||Comma separated list of host and port for each Redis node||rn1.mydomain.com:6379,rn2.mydomain.com:6379,rn3.mydomain.com:6379,rn4.mydomain.com:6379,rn5.mydomain.com:6379,rn6.mydomain.com:6379|
|redis.[cache|store].timeout||Connection timeout in milliseconds||2000|
|redis.[cache|store].password||Password to use when connecting to a node (leave empty if you have set no password access)|
|redis.[cache|store].clientName||Name of the client connection (defaults to empty)|
It is mandatory for Kiuwan On-Premises to work with your Redis installation that it complies with these characteristics:
- Redis version must be equal or higher than 5.0.4.
- Redis must be configured as a cluster.
- Eviction policy must be set to "noeviction" (refer to Redis official documentation, maxmemory-policy configuration property).
When externalizing MySQL note that your MySQL installation should comply with these characteristics:
- MySQL version 5.7
- Maximum number of connections: 130 per Kiuwan On-Premises instance.
Step 1: create Kiuwan On-Premises schemas
You should create the needed schemas in your MySQL installation. To do so, please execute this script with a user that has schema creation privileges:
Step 2: create Kiuwan On-Premises user
You should create the user that will be connecting to Kiuwan On-Premises schemas. Please run this script as an admin user to do so:
Note that you should replace [USER] with the desired user name and [PASSWORD] with the desired password.
Step 3: configure your installation
The following table shows the properties to configure for Kiuwan On-Premises to connect to your own MySQL instance:
|mysql.host||You MySQL installation host||mysqlkiuwan|
|mysql.port||The connection port to access your MySQL installation||3306|
|mysql.username||The user that will be connecting to Kiuwan On-Premises schemas (should match the one provided in the previous step)||csaas|
|mysql.password||The user's password (should match the one provided in the previous step)|
Installation: using Amazon S3 as file repository
Kiuwan On-Premises uses these shared file repositories to store analysis related data:
- kiuwanCentralRepository: stores analysis results files.
- kiuwanSourceCodeRepository: stores source code.
These two Kiuwan On-Premises internal file repositories can be replaced with Amazon S3 buckets.
To do so, you should first configure these properties in the main configuration file ([VOLUMES_DIR]/config-shared/globalConfig/globalConfig.properties):
The following table shows the properties you should modify when making Kiuwan On-Premises connect to AWS S3 buckets:
|Your AWS S3 bucket name||s3mycompany-us|
|s3.privateBucket.subDirectoryName||Your AWS S3 subdirectory name under the configured bucket||mydirectory|
|s3.privateBucket.accessKeyId||AWS access key for your bucket||BS3BX35Z27UAQCEACTPQ|
|s3.privateBucket.secretKeyId||AWS secret key for your bucket||Aasdfjklwe1234123lkjfasc21ssACasfEq124Da|
|s3.dir.centralFileRepository||The main key prefix that will be used to keep the central file repository entries||kiuwanCentralWorkingDirectory/analysisData|
|s3.dir.sourceCodeFileRepository||The main key prefix that will be used to keep the source code file repository entries||kiuwanCentralWorkingDirectory/analyzedSourceCode|
Installation: advanced configuration
All configuration properties you can edit are located in this file located inside your data-shared volume:
Here is a complete list of the properties you can configure and their meaning (default passwords are omitted):
|kiuwan.protocol||https||Kiuwan default access protocol|
|kiuwan.domain||kiuwan.onpremise.local||Kiuwan default domain|
|kiuwan.port||443||Kiuwan default access port|
|kiuwan.mail.host||Email server host|
|kiuwan.mail.port||Email server port|
|kiuwan.mail.username||Email server username|
|kiuwan.mail.password||Email server password|
|kiuwan.mail.from||Email account you want Kiuwan to use when sending emails|
|kiuwan.default.mail.account||Email account to set to the built-in Kiuwan users|
|Kiuwan instances shared configuration|
|timezone||Europe/Madrid||Kiuwan servers timezone|
|Kiuwan front instances configuration|
|kiuwan.nodes.front.max.memory||1024m||Max memory to set to front instances|
|session.timeout||3600||Time a session can be inactive before close it (in seconds)|
|session.secure||false||Use the secure attribute of the session cookie|
|session.httponly||false||Use the httponly attribute of the session cookie|
|Kiuwan analyzer instances configuration|
|kiuwan.nodes.analyzers.max.memory||1024m||Max memory to set to analyzer instances|
|queues.reportsGeneratedQueueSize||2||Number of slots enabled for analysis processing|
|Kiuwan scheduler instances configuration|
|kiuwan.nodes.schedulers.max.memory||1024m||Max memory to set to front instances|
|Kiuwan file repositories configuration|
|centralFileRepository.type||filesystem||Central file repository storage type [filesystem|s3]|
|sourceCodeFileRepository.type||filesystem||Source code repository storage type [filesystem|s3]|
|Amazon S3 bucket configuration (only applies when using AWS S3 type repositories)|
|s3.privateBucket.bucketName||S3 bucket name|
|s3.privateBucket.subDirectoryName||S3 subdirectory name|
|s3.privateBucket.accessKeyId||Access key id|
|s3.privateBucket.secretKeyId||Secret key id|
|s3.dir.centralFileRepository||Central file repository directory|
|s3.dir.sourceCodeFileRepository||Source code file repository directory|
|mysql.host||mysqlkiuwan||MySQL server host|
|mysql.port||3306||MySQL server port|
|mysql.username||csaas||MySQL server username|
|mysql.password||MySQL server password|
|mysql.config.useSSL||false||Enable or disable the use of encryption when connecting to MySQL|
|mysql.config.requireSSL||false||Force the use of encryption when connecting to MySQL|
|mysql.config.verifyServerCertificate||false||Force the validation of the certificate served MySQL|
|Redis Cluster cache and store configuration|
|redis.[cache|store].nodes||redis_0000[1-6]:6379||Redis nodes hosts (use the provided single host name when using elasticache)|
|redis.[cache|store].timeout||2000||Redis connection timeout|
|redis.[cache|store].clientName||Redis client name|
|java.keystore.password||Java keystore password. This must be aligned with the generated keystore password (in case you change the default Kiuwan host name)|
|java.truststore.password||Java truststore password. This must be aligned with the generated truststore password (in case you change the default Kiuwan host name)|
Accessing your Kiuwan On-Premises installation
In order to access your Kiuwan On-Premises installation you should follow a few more steps.
Step 1: add your domain to your local network DNS
To access your Kiuwan On-Premises installation you should take into account whether the selected domain is available in the DNSs your local network may use.
In order to access Kiuwan you will need to do one of the following options:
- Add kiuwan.onpremise.local to your DNS (recommended option).
- Add kiuwan.onpremise.local to your hosts file.
For testing purposes or if you choose the second option, edit this file in the host where you plan to access Kiuwan from:
- Windows OS: C:\Windows\System32\drivers\etc\hosts
- Linux OS: /etc/hosts
Add the following entry to the previous file:
For example, the previous entry may look like this for an installation pointing to the default host (note that the IP of the example may change in your local network):
Step 2: add your certificates' CA to your clients
Depending on whether you are using a trusted CA or not to sign your certificates, you may need to add the CA to your client's certificate store to avoid warning messages.
Please refer to the Adding the provided or a custom CA to Kiuwan On-Premises' clients section for a complete explanation on how to handle this depending on your installation configuration.
Step 3: wait for Kiuwan services to be started
Note that although the installation process may have finished, the Kiuwan servers may need some minutes to start up. Please wait if you receive a "404 - Not Found" error message when accessing Kiuwan On-Premises.
Step 4: access Kiuwan On-Premises
Accessing the web application
Once the previous steps have been done, you should be able to access Kiuwan On-Premises entering your Kiuwan host in your browser which by default is:
You will access you Kiuwan On-Premisesinstallation's main login page:
Exploiting Kiuwan REST API
To access your Kiuwan On-Premises installation via its REST API, you should point to this URL:
Configuring Kiuwan for Developers
To install Kiuwan for Developers plugins you should point to the corresponding download endpoint for each Kiuwan for Developers distribution:
|IDE distribution||How to install||URL|
Add a new updatesite
|JetBrains||Add a new custom plugin repository||pub/jetbrains/plugins.xml|
|Visual Studio||Add an extension gallery||pub/vsgallery/atom.xml|
|Visual Studio Code||Download the extension package file and use the "Install from VSIX" option|| |
Please refer to Kiuwan for Developers page for more information.
Kiuwan On-Premises supplies two user accounts:
Please make sure you change these passwords as soon as possible accessing the upper right menu option "Account management", section "Change password".