Kiuwan On-Premises installer is a powerful tool that suits multiple environment 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:
These softwares are also needed:
Please follow Docker official recommendations when installing Docker. These URLs describe the installation process for different Linux distributions:
We also recommend using the target installation hosts exclusively for Kiuwan services. If you plan on running other containers than Kiuwan's in a single-host installation, please make sure that none of them are using the following network:
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.|
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:
Given the table above, for a single-host installation where no service is externalized the minimum system requirements are:
It is recommended that you overscale these characteristics for the OS to have resources available for itself.
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.
This guide will reference two important folders:
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.
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.
Once downloaded, you should untar the provided gz file:
tar xvzpf kiuwan-cluster_master.tar.gz
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.
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):
cp configq1.zip [INSTALL_DIR]/user-content cp license.zip [INSTALL_DIR]/user-content
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:
cp mysql-connector-java-5.1.39-bin.jar [INSTALL_DIR]/user-content
The installation tool comes with the base volumes to boot a first installation of Kiuwan On-Premises. We provide three volumes:
Copy the provided volumes to your desired location:
sudo cp -rp [INSTALL_DIR]/volumes/config-shared [VOLUMES_DIR]/config-shared sudo cp -rp [INSTALL_DIR]/volumes/data-shared [VOLUMES_DIR]/data-shared sudo cp -rp [INSTALL_DIR]/volumes/data-local [VOLUMES_DIR]/data-local
Take note of the locations you choose for each volume. You will need these paths for the next installation step.
Edit the file located in [INSTALL_DIR]/config/volumes.properties and set the previous paths to each property:
config.shared=[VOLUMES_DIR]/config-shared data.shared=[VOLUMES_DIR]/data-shared data.local=[VOLUMES_DIR]/data-local
Please remember that [VOLUMES_DIR] here is just a placeholder for the real path you chose.
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]:
sudo vim [VOLUMES_DIR]/config-shared/globalConfig.properties
Please note that this is the file located in your [VOLUMES_DIR], not in the [INSTALLER_DIR], which only contains the base volumes.
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.
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:
If this is enough for you, just continue with the following steps.
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.
On a terminal, navigate to the [INSTALL_DIR] folder and execute this command:
Once the installation is finisished please refer to the Installation guide section.
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.
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):
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:
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:
cd [INSTALL_DIR]/docker sudo ./stop-kiuwan.sh sudo ./stop-infrastructure.sh sudo ./update.sh sudo ./start-infrastructure.sh sudo ./start-kiuwan.sh
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)|
In order to access your Kiuwan On-Premises installation you should follow a few more steps.
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:
For testing purposes or if you choose the second option, edit this file in the host where you plan to access Kiuwan from:
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):
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.
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.
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:
To access your Kiuwan On-Premises installation via its REST API, you should point to this URL:
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".