Single-node deployment: Specifying the installation parameters
The configuration file used to deploy Kaspersky Next XDR Expert on a single node contains the installation parameters that are required both for the multi-node and single-node deployment. Also, this configuration file contains parameters specific only for the single-node deployment (vault_ha_mode, vault_standalone, and default_сlass_replica_count).
The template of the configuration file (singlenode.smp_param.yaml.template) is located in the distribution package in the archive with the KDT utility. You can fill out the configuration file template manually; or use the Configuration wizard to specify the installation parameters that are required for the Kaspersky Next XDR Expert deployment, and then generate the configuration file.
Not all of the parameters listed below are included in the configuration file template. This template contains only those parameters that must be specified before Kaspersky Next XDR Expert deployment. The remaining parameters are set to default values, and they are not included in the template. You can manually add these parameters to the configuration file to override its values. Parameter values must follow the rules described below. During the Kaspersky Next XDR Expert deployment, KDT checks whether the required installation parameters are specified correctly. If the required parameters in the configuration file are missing or invalid, the deployment will be interrupted.
For correct function of KDT with the configuration file, add an empty line at the end of the file.
The nodes section of the configuration file contains the target host parameters that are listed in the table below.
Nodes section
Parameter name |
Required |
Description |
|---|---|---|
|
Yes |
The node name. The value must comply with the following rules:
|
|
Yes |
For the target host, set the |
|
Yes |
The IP address of the node. The primary worker node must be included in the same subnet as the Kubernetes cluster gateway. |
|
No |
The node kind that specifies the Kaspersky Next XDR Expert component that will be installed on this node. For the single-node deployment, leave this parameter empty, because all components will be installed on a single node. |
|
Yes |
The user name of the account created on the target host and used for connection to the node by KDT. The value must comply with the following rules:
|
|
No |
The password for connecting to the node, which can be used instead of the SSH key. |
|
Yes |
The path to the private part of the SSH key located on the administrator host and used for connection to the node by KDT. The parameter value must be a Linux file path or Base64-encoded file content. Also, the value must match the We recommend using the SSH key to establish a connection with the node.
|
Other installation parameters are listed in the parameters section of the configuration file and are described in the table below.
Parameters section
Parameter name |
Required |
Description |
|---|---|---|
|
Yes |
The connection string for accessing the DBMS that is installed and configured outside the Kubernetes cluster. Specify this parameter as follows:
where:
The Symbols that must be replaced in the
Refer to the PostgreSQL connection string article for details. If the |
|
Yes |
The language of the OSMP Console interface is specified by default. After installation, you can change the OSMP Console language. Possible parameter values:
The default value is used if you do not specify this parameter in the configuration file. |
|
Yes |
The reserved static IPv4 address of the Kubernetes cluster gateway. The Kubernetes cluster gateway is intended for connecting to the Kaspersky Next XDR Expert components installed inside the Kubernetes cluster. The gateway must be included in the same subnet as the primary worker node. |
|
Yes |
The path to the private part of the SSH key located on the administrator host and used for connection to the primary worker node and nodes with the KUMA services (collectors, correlators, and storages) by using KDT. The parameter value must be a Linux file path or Base64-encoded file content. Also, the value must match the |
|
Yes |
The The Main administrator role is assigned to this user account. The password must comply with the following rules:
When you specify the
Example: the user account password |
|
Yes |
The parameter indicating that Kaspersky Next XDR Expert is installed on the target host with limited computing resources. Possible parameter values:
For the single-node deployment, set the |
|
Yes |
The parameter that indicates whether to run the secret storage in the High Availability (HA) mode. Possible parameter values:
For the single-node deployment, set the |
|
Yes |
The parameter that indicates whether to run the secret storage in the standalone mode. Possible parameter values:
For the single-node deployment, set the |
|
Yes |
The number of disk volumes that are used to store the service data of Kaspersky Next XDR Expert components and KDT. The default value is For the single-node deployment, set the |
|
Yes |
The parameter that specifies the amount of disk space for the operation of KUMA Core. This parameter is used only if the If the |
|
Yes |
The path to the KUMA inventory file located on the administrator host. The inventory file contains installation parameters for deployment of the KUMA services that are not included in the Kubernetes cluster. The parameter value must be a Linux file path or Base64-encoded file content. |
|
No |
The path to the additional KUMA inventory file located on the administrator host. This file contains the installation parameters used to partially add or remove hosts with the KUMA services. The parameter value must be a Linux file path or Base64-encoded file content. If you perform an initial deployment of Kaspersky Next XDR Expert or run a custom action that requires configuration file, leave the default parameter value ( |
|
Yes |
The path to the license key of KUMA Core. The parameter value must be a Linux file path or Base64-encoded file content. |
|
Yes |
The host name that is used in the FQDNs of the public Kaspersky Next XDR Expert services. The service host name and domain name (the If custom host names are not specified, the following default host names are used:
|
|
Yes |
The domain name that is used in the FQDNs of the public Kaspersky Next XDR Expert services. The parameter value must meet the requirements for second-level domain naming. The service host name and domain name are parts of the service FQDN. For example, if the value of the |
|
Yes |
The list of host names of the public Kaspersky Next XDR Expert services for which a self-signed or custom certificate is to be generated. The parameter value must be a list of host names, separated by spaces. |
|
No |
The parameter that indicates whether to use the custom intermediate certificate instead of the self-signed certificates for the public Kaspersky Next XDR Expert services. Possible parameter values:
|
|
No |
The path to the custom intermediate certificate used to work with public Kaspersky Next XDR Expert services. Specify this parameter if the |
|
No |
The paths to the custom leaf certificates used to work with the corresponding public Kaspersky Next XDR Expert services: If you want to specify the leaf custom certificates, set the |
|
Yes |
The names of the secret files that are stored in the Kubernetes cluster. These names contain the domain name, which must match the |
|
Yes |
The amount of free disk space allocated to store the Administration Server data (updates, installation packages, and other internal service data). Measured in gigabytes, specified as "<amount>Gi". The required amount of free disk space depends on the number of managed devices and other parameters, and can be calculated. The minimum recommended value is 10 GB. |
|
Yes |
The amount of free disk space allocated to store metrics. Measured in gigabytes, specified as "<amount>GB". The minimum recommended value is 5 GB. |
|
No |
The user name of the account used to view OSMP metrics through the Grafana tool. The value must comply with the following rules:
|
|
No |
The password of the account used to view OSMP metrics through the Grafana tool. {US7917546The password must comply with the following rules:
|
|
Yes |
The amount of free disk space allocated to store OSMP logs. Measured in gigabytes, specified as "<amount>Gi". The minimum recommended value is 20 GB. |
|
Yes |
The storage period of OSMP logs after which logs are automatically removed. The default value is 72 hours (set the parameter value in the configuration file as "<time in hours>h". For example, "72h"). |
|
No |
The amount of free disk space allocated to store data of the component for working with response actions. Measured in gigabytes, specified as "<amount>Gi". The minimum recommended value is 20 GB. |
|
No |
The parameter that indicates whether to encrypt the traffic between the Kaspersky Next XDR Expert components and the DBMS by using the TLS protocol. The default value is Possible parameter values:
|
|
No |
The path to the PEM file that can contain the TLS certificate of the DBMS server or a root certificate from which the TLS server certificate can be issued. The parameter value must be a Linux file path or Base64-encoded file content. Specify the |
|
No |
The path to the PEM file that contains a certificate and a private key of the Kaspersky Next XDR Expert component. This certificate is used to establish the TLS connection between the Kaspersky Next XDR Expert components and the DBMS. The parameter value must be a Linux file path or Base64-encoded file content. Specify the |
|
No |
The parameter that indicates whether to use the proxy server to connect the Kaspersky Next XDR Expert components to the internet. If the host on which Kaspersky Next XDR Expert is installed has internet access, you can also provide internet access for operation of Kaspersky Next XDR Expert components (for example, Administration Server) and for specific integrations, both Kaspersky and third-party. To establish the proxy connection, you must also specify the proxy server parameters in the Administration Server properties. The default value is Possible parameter values:
|
|
No |
The IP address of the proxy server. If the proxy server uses multiple IP addresses, specify these addresses separated by a space (for example, " |
|
No |
The number of the port through which the proxy connection will be established. Specify this parameter if the |
|
No |
The verbosity level of Administration Server trace files. Traces are written during the Administration Server operation. The default value is 0, no traces are written. Possible parameter values: 0–5. The higher the parameter value, the more detailed the trace details. |
|
No |
The verbosity level of logs of the KUMA Core and KUMA services deployment that is performed by KDT. Possible parameter values:
As the number of "v" letters in the flag increases, logs become more detailed. If this parameter is not specified in the configuration file, the standard component installation logs are saved. |
|
No |
The number of files that you can attach to the incident. The default value is |
|
No |
The total size of files attached to the incident. Measured in bytes. Specified without units of measurement. The default value is |
|
No |
The parameter indicating whether to check the hardware, software, and network configuration of the Kubernetes cluster nodes for compliance with the prerequisites for installing the solution before the deployment. The default value is Possible parameter values:
|