Distributed deployment: Specifying the installation parameters
The configuration file is a file in the YAML format and contains a set of installation parameters for the Kaspersky Next XDR Expert components.
The installation parameters listed in the tables below are required for the distributed deployment of Kaspersky Next XDR Expert. To deploy Kaspersky Next XDR Expert on a single node, use the configuration file that contains the installation parameters specific for the single node deployment.
The template of the configuration file (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.
For correct function of KDT with the configuration file, enter 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.
Installation parameters of the nodes section
Parameter name | Required | Description |
---|---|---|
| Yes | The name of the node. |
| Yes | Possible parameter values:
|
| Yes | The IP address of the node. All nodes must be included in the same subnet. |
| No | The node type that specifies the Kaspersky Next XDR Expert component that will be installed on this node. Possible parameter values:
For Kaspersky Next XDR Expert to work correctly, we recommend that you select the node on which Administration Server will work. Also, you can select the node on which you want to install the DBMS. Specify the appropriate values of the |
| Yes | The username of the user account created on the target host and used for connection to the node by KDT. |
| 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 parameters
section of the configuration file contains the parameters listed in the table below.
Installation parameters of the parameters section
Parameter name | Required | Description |
---|---|---|
| Yes | The connection string for accessing the DBMS that is installed and configured on a separate server. Specify this parameter as follows:
If the We recommend installing a DBMS on a separate server outside the cluster. |
| Yes | The language of the OSMP Console interface specified by default. After installation, you can change the OSMP Console language. Possible parameter values:
|
| Yes | The reserved static IP address of the Kubernetes cluster gateway. The gateway must be included in the same subnet as all cluster nodes. If you install the DBMS on a separate server, the gateway IP address must contain the subnet mask /32. If you install the DBMS inside the cluster, set the gateway IP address to an IP range in the format |
| 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. |
| Yes | The path to the private part of the SSH key located on the administrator host and used for connection to the nodes with the KUMA services (collectors, correlators, and storages). |
| Yes | The The Main administrator role is assigned to this user account. The The The password must comply with the following rules:
|
| No | The parameter that indicates that Kaspersky Next XDR Expert is installed on the target host with limited computing resources. Set the Possible parameter values:
|
| Yes | The parameter that specifies the amount of disk space for the operation of KUMA Core. This parameter is used only if the |
| Yes | The path to the KUMA inventory file located on the administrator host. The inventory file contains the installation parameters for deployment of the KUMA services that are not included in the Kubernetes cluster. |
| 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. If you perform an initial deployment of Kaspersky Next XDR Expert or you do not need to partially add or remove hosts with the KUMA services, set this parameter to |
| Yes | The path to the license key of KUMA. |
| Yes | The domain name that is used in the addresses of the public Kaspersky Next XDR Expert services. |
| Yes | The domain name for which a self-signed or custom certificate is to be generated. The |
| Yes | The addresses of the Kaspersky Next XDR Expert services. These addresses contain the domain name, which must match the |
| Yes | The list of addresses of the public Kaspersky Next XDR Expert services for which a self-signed or custom certificate is to be generated. These addresses contain the domain name, which must match the |
| No | The path to the custom intermediate certificate used to work with public Kaspersky Next XDR Expert services. |
| 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 paths to the custom leaf certificates used to work with the corresponding public Kaspersky Next XDR Expert services: admsrv.<smp_domain>, api.<smp_domain>, console.<smp_domain>, psql.<smp_domain>. Specify the If you want to specify the leaf custom certificates, set the |
| Yes | The address of KUMA Console. This address contains the domain name, which must match the |
| Yes | The address of OSMP Console. This address contains the domain name, which must match 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. |
| No | The amount of free disk space allocated to store the internal service KDT data. Measured in gigabytes, specified as "<amount>Gi". The minimum recommended value is 1 GB. |
| Yes | The amount of free disk space allocated to store the backups of the Administration Server data. Measured in gigabytes, specified as "<amount>Gi".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. |
| 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 The The default parameter value is |
| 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. 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. |
| 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. |
| 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. 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. |
| Yes | Parameters for internal use. Do not change the parameter value. |
Sample of the configuration file for the distributed deployment of Kaspersky Next XDR Expert