Configuring the WAPT Agent with advanced options¶
The configuration file wapt-get.ini defines the behavior
of the WAPT Agent.
System |
Location |
|---|---|
Windows |
|
Linux |
|
Mac OS |
|
The [global] section is required.
[global]
After standard installation, the default configuration is:
[global]
waptupdate_task_period=120
wapt_server=https://srvwapt.mydomain.lan
repo_url=https://srvwapt.mydomain.lan/wapt/
use_hostpackages=1
All parameters are not set when the WAPT Agent is generated.
It is possible to make changes in wapt-get.ini manually or by deploying a WAPT package with the new configuration settings.
An example package is available from the Tranquil IT repository.
# -*- coding: utf-8 -*-
from setuphelpers import *
uninstallkey = []
def install():
print('Modify max_gpo_script_wait')
inifile_writestring(WAPT.config_filename,'global','max_gpo_script_wait',180)
print('Modify Preshutdowntimeout')
inifile_writestring(WAPT.config_filename,'global','pre_shutdown_timeout',180)
print('Disable Hyberboot')
inifile_writestring(WAPT.config_filename,'global','hiberboot_enabled',0)
print('Disable Notify User')
inifile_writestring(WAPT.config_filename,'global','notify_user',0)
print('Reload WAPT configuration')
WAPT.reload_config_if_updated()
The function inifile_writestring definition is:
inifile_writestring(inifilename,section,key,value)
Description of available sections¶
Section |
Description |
|---|---|
|
Global WAPT Agent options. |
|
Main repository options. |
|
External remote repository options. |
|
Repository for host packages options. |
|
WUA Agent options. |
|
For synching multiple repositories. |
All sections are detailed below.
Description of available options by section¶
[global]¶
General settings¶
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Allows to reboot the selected host(s) remotely from the WAPT Console. |
allow_remote_reboot = True |
|
Allows to shut down the selected host(s) remotely from the WAPT Console. |
allow_remote_reboot = True |
|
Forces the package certificate’s date and CRL to be verified. |
check_certificates_validity = True |
|
Path to the local database file. |
dbpath = C:\Program Files (x86)\db\waptdb.sqlite |
|
Defines whether a download of pending packages should be started after an update with |
download_after_update_with_waptupdate_task_period = False |
|
Allows to force an Organizational Unit on the WAPT Agent (convenient for assigning a fake OU for out-of-domain PC).
Make sure it respects a consistent case (do not mix “dc”s and “DC”s, for example), which you can find in the Console (in the DN/ |
host_organizational_unit_dn = OU=TOTO,OU=TEST,DC=MYDOMAIN,DC=LAN |
|
Allows to define a WAPT package list that the WAPT Agent MUST install. |
host_profiles = tis-firefox,tis-java |
|
Forces the default language for the GUI (not for package filtering) |
language = en |
|
Allows to set the list of WAPT Agent languages to pre-filter the list of packages visible by the WAPT Agent (for package filtering).
The parameter accepts multiple entries ordered by preference (eg. |
locales = en |
|
Sends the WAPT logs in the Window event log. |
log_to_windows_events = True |
|
Log level of the WAPT Agent. Possible values are: |
loglevel = critical |
|
List of package maturities than can be viewed and installed by WAPT Agent. Default value is |
maturities = PROD, PREPROD |
|
Address of the main WAPT repository. |
repo_url = https://srvwapt.mydomain.lan/wapt |
|
List of enabled repositories, separated by a comma. Each value defines a section of the |
repositories = repo1, repo2 |
|
Allows the WAPT Console to send anonymous statistics to Tranquil IT. Set to False to disable telemetry. |
send_usage_report = True |
|
Sets how the self service authentication works. Possible values are: |
service_auth_type = waptserver-ldap |
|
Defines whether or not it is possible for the user to uninstall applications via the self-service. |
uninstall_allowed = False |
|
For using group packages. |
use_ad_groups = True |
|
Allows to use the FQDN rather than the BIOS UUID as the unique host identifier in WAPT. |
use_fqdn_as_uuid = True |
|
Defines whether host packages are to be used. |
use_hostpackages = True |
|
Defines whether repositories are replicated. |
use_repo_rules = True |
|
Defines the frequency at which audits are triggered. Waiting for value in minutes. |
waptaudit_task_period = 120 |
|
Defines the WAPT Server URL. If the attribute is not present, no WAPT Server will be contacted. |
wapt_server = https://srvwapt.mydomain.lan |
|
WAPT Agent loopback port. The port is not accessible from the network. |
waptservice_port = 8080 |
|
Defines the update frequency (120 minutes by default). |
waptupdate_task_period = 24h |
|
Defines the upgrade frequency. |
waptupgrade_task_period = 360 |
|
Enable agent to be used as a Wake On Lan wol_relay |
wol_relay = True |
Note
If there is no
repo_urlattribute in the [global] section, then a repository in the[wapt]section will have to be explicitly defined. It will have to be enabled by adding it to therepositoriesattribute.If there is no
wapt_serverattribute in the[global]section, then no WAPT Server will be used.
Settings for the WAPT Server¶
These options will set the WAPT Agent behavior when connecting to the WAPT Server.
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Folder of certificates authorized to verify the signature of WAPT packages. |
|
|
Use kerberos authentication for initial registration on the WAPT Server. |
|
|
See the documentation on activating the verification of HTTPS certificates. |
|
|
WAPT Server URL. If the attribute is not present, no WAPT Server will be contacted. |
|
|
WAPT Server HTTPS connection timeout in seconds. |
|
Settings for the WAPT Exit utility¶
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Prevents users from canceling package upgrades on computer shutdown. If disabled, users will not be able to cancel an upgrade on computer shutdown. If this value is not indicated the default value will be 10. |
allow_cancel_upgrade = True |
|
Disables Hiberboot on Windows 10 to make waptexit work correctly. |
hiberboot_enabled = True |
|
Timeout for GPO execution at computer shutdown. |
max_gpo_script_wait = 180 |
|
Timeout for scripts at computer shutdown. |
pre_shutdown_timeout = 180 |
|
Prevents the software upgrade if the software is currently running on the host (impacted_process attribute of the package). |
upgrade_only_if_not_process_running = True |
|
Only upgrade packages with a specific priority. |
upgrade_priorities = high |
|
Delay (in seconds) before the automatic start of the installations. |
waptexit_countdown = 25 |
Settings for the WAPT Self-Service and the WAPT service Authentification¶
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Useful with |
ldap_auth_base_dn = dc=mydomain,dc=lan |
|
Useful with |
ldap_auth_ssl_enabled = True |
|
Useful with |
ldap_auth_server = srvads.mydomain.lan |
|
Defines the authentication system of the WAPT service, available value are |
service_auth_type = waptagent-ldap |
|
Useful with |
verify_cert_ldap = True |
|
Apply selfservice package view filtering for Local Administrators. |
waptservice_admin_filter = True |
|
sha256 hashed password when waptservice_user is used (the value NOPASSWORD disables the requirement for a password). |
waptservice_password = 5e884898da |
|
Forces a user to authenticate on the WAPT service. |
waptservice_user = admin |
Settings for the the WAPT System Tray utility¶
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Prevents the WAPT System Tray utility from sending notifications (popup). |
notify_user = True |
Settings for the Proxy¶
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Defines the address of the HTTP proxy. |
|
|
Use a proxy to access the repositories. |
|
|
Use a proxy to access the WAPT Server. |
|
Settings for creating WAPT packages¶
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Defines the default prefix for new or imported packages. Prefix is case sensitive, we recommand to use lower case. |
|
|
Defines the directory for storing packages while in development. |
|
|
Defines the path to the Administrator’s private key. |
|
[wapt-wua]¶
Refer to configuring WAPTWUA on the WAPT Agent.
Settings for using multiple repositories¶
To add more repositories, new [repository_name] sections can be added in the wapt-get.ini.
Note
Active repositories are listed in the repositories attribute of the [global] section.
Attention
This parameter can be configured both in the WAPT Agent configuration and in the WAPT Console configuration file C:\Users\%username%\AppData\Local\waptconsole\waptconsole.ini.
For information on configuring the WAPT Console, please refer to this documentation.
Section [wapt]¶
Hint
If this section does not exist, parameters are read from the [global] section.
Section [wapt-templates]¶
External remote repositories that will be used in the WAPT Console for importing new or updated packages. The Tranquil IT repository is set by default.
Section [wapt-host]¶
Repository for host packages. If this section does not exist, default locations will be used on the main repository.
More information on that usage can be found in this article on working with multiple public or private repositories.
Configuring the WAPT Console¶
Hint
the WAPT Console configuration is stored in 2 locations:
C:\Users\%username%\AppData\Local\waptconsole\waptconsole.ini.C:\Users\%username%\AppData\Roaming\waptconsole\waptconsole.ini.
These files are automatically generated when the waptconsole is first launched and it is generated from the wapt-get.ini file configured on the Administrator’s workstation;
Description of available sections¶
Section |
Description |
|---|---|
|
Defines the global WAPT Console options |
|
Defines external repository options.
|
|
WUA options |
All sections are detailed below.
Others sections present on C:\Users\%username%\AppData\Roaming\waptconsole\waptconsole.ini are not editable manually, therefore they are not detailed.
Attention
For parameters both present in wapt-get.ini and waptconsole.ini, values are set in wapt-get.ini and copied to waptconsole.ini.
Do not edit manually these parameters.
Description of available options by section¶
[global]¶
Several options are available in the [global] section of the waptconsole.ini file.
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Launches the WAPT Console in debug mode. |
advanced_mode = True |
|
Allows to reboot the selected host(s) remotely from the WAPT Console. |
allow_remote_reboot = True |
|
Allows to shut down the selected host(s) remotely from the WAPT Console. |
allow_remote_shutdown = True |
|
Defines whether the remote repository is using Client Side SSL Authentification. |
client_certificate = C:\private\org-coder.crt |
|
Defines whether the remote repository is using Client Side SSL Authentification. |
client_private_key = C:\private\org-coder.pem |
|
Forces the package certificate’s date and CRL to be verified. |
check_certificates_validity = True |
|
Defines the default upload maturity for WAPT packages. |
default_maturity = PROD |
|
Defines the default prefix for new or imported packages. Prefix is case sensitive, we recommand to use lower case. |
default_package_prefix = doc |
|
Defines the directory for storing packages while in development. |
default_sources_root = C:\waptdev |
|
Lists external plugins for the WAPT Console.
Default is |
grid_hosts_plugins = W3siZXhlY3V0YWJsZSI6ImV4cGxd |
|
Defines a WAPT package list that the WAPT Agent MUST install. |
host_profiles = tis-firefox,tis-java |
|
Disables Hiberboot on Windows 10 to make waptexit |
hiberboot_enabled = True |
|
Defines the address of the proxy server in the WAPT Console. |
http_proxy = https://proxy.mydomain.lan |
|
Provides the date when the WAPT Console was last used. |
last_usage_report = 12/05/2021 18:45:51 |
|
Provides the last user logged on this WAPT Console. |
lastwaptserveruser = admin |
|
Defines the timeout for GPO execution at computer shutdown (in seconds). |
max_gpo_script_wait = 360 |
|
Defines the path to the certificate associated with the Administrator’s private key. |
personal_certificate_path = C:\private\mykey.crt |
|
Defines the timeout for scripts at computer shutdown (in seconds). |
pre_shutdown_timeout = 360 |
|
Defines the address of the main WAPT repository. |
repo_url = https://srvwapt.mydomain.lan/wapt |
|
Allows the WAPT Console to send anonymous statistics to Tranquil IT. Set to False to disable telemetry. |
send_usage_report = True |
|
Lists allowed signature algorithms for the WAPT packages. |
sign_digests = sha1 |
|
Allows using unit packages. |
use_ad_groups = True |
|
Allows using the FQDN rather than the BIOS UUID as the unique host identifier in WAPT. |
use_fqdn_as_uuid = True |
|
Allows using kerberos authentication for initial registration of WAPT Agents with the WAPT Server. |
use_kerberos = True |
|
Allows using host packages. |
use_hostpackages = True |
|
Allows using a proxy to connect to the main WAPT repository from the WAPT Console. |
use_http_proxy_for_repo = True |
|
Allows using a proxy to connect to the WAPT Server from the WAPT Console. |
use_http_proxy_for_server = True |
|
Allows using replication for repositories. |
use_repo_rules = True |
|
Allows verifying SSL / TLS certificate. |
verify_cert = True |
|
Defines the address of the WAPT Server. |
wapt_server = https://srvwapt.mydomain.lan |
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Launches the WAPT Console in debug mode. |
advanced_mode = True |
|
Displays the actions that call external applications (RDP, Windows tools etc…). |
enable_external_tools = True |
|
Displays the button to create self-signed certificates or to create the WAPT Agent’s installer. |
enable_management_features = True |
|
Hides actions that are not available for the WAPT Agent |
hide_unavailable_actions = True |
|
Limits hosts displayed in the WAPT Console. |
HostsLimit = 300 |
|
Forces the default langage for GUI (not for package filtering) |
language = en |
|
Defines the .ini file used to store the WAPT Console configuration. |
lastappinifilename = C:\Users\%username%\AppData\Roaming\waptconsole\waptconsole.ini |
|
Displays the Audit data tab on host inventory. |
show_host_audit_data_tab = True |
|
Allows using unit packages. |
use_ad_groups = True |
|
Forces the use of the FQDN instead of the uuid BIOS as the unique host identifier in WAPT. |
use_fqdn_as_uuid = True |
|
Displays the version of the WAPT Console. |
waptconsole.version = 2.0.0.9424 |
|
Allows displaying the Windows Update tab on the WAPT Console. |
waptwua_enabled = True |
[sections]¶
You may add several external repositories by adding [sections] in C:\Users\%username%\AppData\Local\waptconsole\waptconsole.ini.
Attention
This parameter can be configured both in the WAPT Agent configuration and in the WAPT Console configuration C:\Users\%username%\AppData\Local\waptconsole\waptconsole.ini.
For information on configuring the WAPT Agent, please refer to this point.
See available parameters and configurations by visiting this documentation on setting up multiple repositories.
Configuring the WAPT Server¶
The WAPT Server configuration file on GNU/ Linux and macOS systems is found in /opt/wapt/conf/waptserver.ini or in /opt/wapt/waptserver/waptserver.ini.
The WAPT Server configuration file on Windows is found in C:\wapt\conf\waptserver.ini.
Attention
Modification of these files is reserved for advanced users!!
Section [options] of waptserver.ini¶
Several options can be defined in the [options] section.
[options]
Options (Default Value) |
Description |
Example |
|---|---|---|
|
Defines where the WAPT Agents are stored on the WAPT Server. |
agents_folder = /var/www/wapt/waptagent |
|
Defines whether websocket connections should be authenticated.
If |
allow_unauthenticated_connect = True |
|
Allows the initial registration of the WAPT Agent using a login and password. |
allow_unauthenticated_registration = True |
|
Debug only - Allows unsigned status data from Agent. |
allow_unsigned_status_data = True |
|
Defines a custom WAPT Server application root path. |
application_root = wapt |
|
Enables authentication logs. |
authentication_logs = False |
|
Enables automatic configuration when waptsetup is installed. |
auto_create_waptagent_from_config = True |
|
Defines the host certificate lifetime (in days). |
client_certificate_lifetime = 500 |
|
Defines whether unused :ref:` Windows KB should be automatically deleted <auto_kb_clean>` from the WAPT Server. |
cleanup_kbs = False |
|
Defines the websocket client timeout (in seconds). |
clients_read_timeout = 10 |
|
Defines the host certificate signing certificate. |
clients_signing_certificate = C:\private\org-coder.crt |
|
Defines the host certificate signing CRL periodicity (in days). |
clients_signing_crl_days = 15 |
|
Defines the host certificate signing CRL path. |
clients_signing_crl = C:\private\org-coder.crt |
|
Defines the host certificate signing CRL URL. |
clients_signing_crl_url = https://srvwapt.mydomain.lan/crl |
|
Defines the host certificate signing key path. |
clients_signing_key = C:\private\org-coder.crt |
|
Defines the maximum allowed delay before WAPT Agent requests time out (in seconds). |
client_tasks_timeout = 5 |
|
If x64, allows you to copy all WinPE from |
copy_winpe_x64_in_tftp_folder = True |
|
Defines the maximum allowed delay before PostgreSQL queries time out (in seconds). |
db_connect_timeout = 10 |
|
Defines the url of the PostgreSQL server (by default WAPT use a local Unix Socket). |
db_host = https://wapt.mydomain.lan |
|
Defines the maximum simultaneous connections to the PostgreSQL database. |
db_max_connections = 100 |
|
Defines the PostgreSQL database that the WAPT Server connects to. |
db_name = wapt |
|
Defines the password for authenticating the user on the PostgreSQL database (by default WAPT uses a local UNIX socket). |
db_password = WAPT_DB_PASSWORD |
|
Defines the port of the PostgreSQL server. |
db_port = 5432 |
|
Defines the database stale timeout (in seconds). |
db_stale_timeout = 500 |
|
Defines the PostgreSQL user connecting to the database. |
db_user = wapt |
|
Defines the default acl for a new user opening the WAPT Console. |
default_ldap_users_acls = admin |
|
Automatically downloads the |
download_wsusscn2 = False |
|
Enables WAPT Store Webui (Deprecated). |
enable_store = False |
|
Encrypts host package with client certificate. |
encrypt_host_packages = True |
|
Adds basic authentication to WAPT Server. |
htpasswd_path = True |
|
Defines the proxy server to allow the WAPT Server to recover its CRL. |
http_proxy = http://srvproxy.mydomain.lan:3128 |
|
Adds additional known CA to verify certificates. |
known_certificates_folder = /opt/wapt/ssl/ |
|
Defines the UPN Active directory user for SSO and/or waptserver-ldap mode for self-service. |
ldap_account_service_login = wapt-ldap@ad.tranquil.it |
|
Defines the user password for SSO and/or waptserver-ldap mode for self-service. |
ldap_account_service_password = PASSWORD |
|
Defines the LDAP authentication base DN. |
ldap_auth_base_dn = dc=mydomain,dc=lan |
|
Defines the LDAP authentication server. |
ldap_auth_server = srvads.mydomain.lan |
|
Sets SSL authentication on LDAP connections. |
ldap_auth_ssl_enabled = False |
|
Enables the search of nested group in Active Directory. |
ldap_nesting_group_support = False |
|
Enables the search on Active Directory primary group users. |
ldap_primary_group_ad_support = False |
|
Lists subnets without authentication requirement. |
list_subnet_skip_login_wads = 192.168.0.0/24,192.168.1.0/24 |
|
Enables authentication to use WADS (format is |
login_on_wads = True |
|
Defines the log level. Possible values are: |
loglevel = debug |
|
Sets the maximum simultaneous WAPT client connections. |
max_clients = 2048 |
|
Sets the minimum SuperAdmin password length. |
min_password_length = 15 |
|
Defines the Nginx web server HTTP port (Windows only). |
nginx_http = 8080 |
|
Defines the Nginx web server HTTPS port (Windows only). |
nginx_https = 44380 |
|
If one of the option is set, it will not log it: |
optimized_authentication_logs = False |
|
Défines the periodicity at which the WAPT Server verifies the synchronization status of remote repositories (in minutes). |
remote_repo_update_delay = 5 |
|
Enables websocket communication with WAPT Agents configured as remote repositories. |
remote_repo_websockets = False |
|
Defines the random string for initializing the Python Flask application server. The string is generated when first installing the WAPT Server and is unique for every WAPT Server. |
secret_key = FKjfzjfkF687fjrkeznfkj7678jknk78687 |
|
Defines the WAPT Server UUID (this anonymous id is used for WAPT statistics). |
server_uuid = 76efezfa6-b309-1fez5-92cd-8ea48fc122dc |
|
Defines the maximum allowed time the session is opened (in seconds). |
session_lifetime = 352120 |
|
Defines the maximum allowed time difference for the websockets (in seconds). |
signature_clockskew = 72000 |
|
Defines the authentication token lifetime (in seconds). |
token_lifetime = 43200 |
|
Defines the path to the trusted signers certificate directory. |
trusted_signers_certificates_folder = C:\private\org-coder.crt |
|
Defines the path to trusted users CA certificate directory. |
trusted_users_certificates_folder = C:\private\org-coder.crt |
|
Enables a WAPT Agent to register using its kerberos account.
If |
use_kerberos = True |
|
Enables client certificate authentication. |
use_ssl_client_auth = True |
|
Verifies whether the Active Directory SSL / TLS certificate is valid for LDAP connections. |
verify_cert_ldap = False |
|
Enables the WADS feature and enables wapttftpserver. |
wads_enable = True |
|
Defines the folder on the WAPT Server that stores files related to WADS. |
wads_folder = /var/www/waptwads |
|
Defines the LDAP DN of Active Directory User Group allowed to connect to the WAPT Console. |
wapt_admin_group_dn = CN=waptadmins,OU=groups,DC=ad,DC=mydomain,DC=lan |
|
Defines the sAMAccountName Active Directory User Group(s) allowed to connect to the WAPT Console. The value can be several groups, separated by commas. |
wapt_admin_group = waptadmins, wapttechs |
|
Defines the directory path of the WAPT repository. |
wapt_folder = /var/www/wapt |
|
Defines the path to database that stores the status of running tasks. |
wapt_huey_db = C:\Program Files(x86)\wapt\db\waptservertasks.sqlite |
|
Defines the SuperAdmin password for connecting to the WAPT Console. |
wapt_password = 46642dd2b1dfezfezgfezgadf0ezgeezgezf53d |
|
Defines the WAPT Server python service port. |
waptserver_port = 1313 |
|
Defines the SuperAdmin username in the WAPT Console. |
wapt_user = wapt_admin |
|
Defines the location of WAPT WUA folder. |
waptwua_folder = /var/www/waptwua |
|
Defines the list of WakeOnLAN UDP ports to send magic packets to. |
wol_port = 9, 123, 4000 |
|
Defines how to listen to the WAPT Server service. |
wapt_bind_interface = 127.0.0.1 |
|
Defines the location of jinja template used for WADS ipxe script. |
ipxe_script_jinja_path = /opt/wapt/waptserver/templates/ipxe-autoregister.j2 |
Configuring Nginx¶
The default Nginx configuration is as follows:
server {
listen 80;
listen 443 ssl;
server_name _;
ssl_certificate "/opt/wapt/waptserver/ssl/cert.pem";
ssl_certificate_key "/opt/wapt/waptserver/ssl/key.pem";
ssl_protocols TLSv1.2;
ssl_dhparam /etc/ssl/certs/dhparam.pem;
ssl_prefer_server_ciphers on;
ssl_ciphers 'EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH';
ssl_stapling on;
ssl_stapling_verify on;
ssl_session_cache none;
ssl_session_tickets off;
index index.html;
location ~ ^/wapt.* {
proxy_set_header Cache-Control "store, no-cache, must-revalidate, post-check=0, pre-check=0";
proxy_set_header Pragma "no-cache";
proxy_set_header Expires "Sun, 19 Nov 1978 05:00:00 GMT";
root "/var/www";
}
location / {
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
location ~ ^/(api/v3/upload_packages|api/v3/upload_hosts/|upload_waptsetup) {
proxy_pass http://127.0.0.1:8080;
client_max_body_size 4096m;
client_body_timeout 1800;
}
location /wapt-host/Packages {
return 403;
}
location /wapt-host/add_host_kerberos {
return 403;
}
location / {
proxy_pass http://127.0.0.1:8080;
}
location /socket.io {
proxy_http_version 1.1;
proxy_buffering off;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_pass http://127.0.0.1:8080/socket.io;
}
}
}
Configuring WAPT Server for large deployments¶
The default operating system, Nginx and PostgreSQL settings are adapted for around 400 WAPT Agents. If you have more than 400 clients it is necessary to modify a few system level parameters along with PostgreSQL database, Nginx web and WAPT Server python server.
In the future, the postconf.sh script might take charge of this configuration depending on the expected number of client computers.
With the following parameters, one WAPT Server should scale up to around 5000 concurrent active clients. You may have more clients in the database if they are not all running at the same time. If you have more than 5000 clients it is recommended to have more than one WAPT Server.
The limit in the number of end point clients is due to the bottleneck in the python code and the PostgreSQL backend. WAPT performance gets better with time and in the future WAPT Server might support a large base on a single host. However the Nginx part scales very well and it can takes full advantage of a 10Gbps connection for high load package deployments.
Note
The parameters to be modified below are linked together and should be modified globally and not individually.
Configuring Nginx¶
OS Type |
File location |
|---|---|
Debian / Ubuntu |
|
Redhat and derivatives |
|
Windows |
|
In the nginx.conf file, modify the worker_connections parameter.
The value should be around 2.5 times the number of WAPT clients (n connections for websockets and n connections for package downloads and inventory upload + some margin).
events {
worker_connections 4096;
}
Then upgrade the number of filedescriptors in the nginx.conf file:
worker_rlimit_nofile 32768;
Depending on the partitioning of your WAPT Server you might have to be careful with the Nginx temporary file upload directory. Nginx acts as a reverse proxy for the WAPT Server Python engine and its does a caching of packages uploaded when uploading a new package from the Console.
The packages are stored in the /var/lib/nginx/proxy directory.
You have to make sure that the partition hosting this directory is large enough.
You may change this directory location using the following Nginx configuration parameter.
$client_body_temp_path
Configuring the Linux System¶
Increase the number of filedescriptors. The system unit file asks for an increase in the allowed number of filedescriptors (LimitNOFILE=32768). We should have the same thing for Nginx. There are a few limits to modify.
First we modify system wide the number of filedescriptors allowed for Nginx and WAPT.
Create the
/etc/security/limits.d/wapt.conf.
cat > /etc/security/limits.d/wapt.conf <<EOF
wapt hard nofile 32768
wapt soft nofile 32768
www-data hard nofile 32768
www-data soft nofile 32768
EOF
Nginx serves as a reverse proxy and makes quite a lot of connections. Each WAPT client keeps a websocket connection up all the time in order to respond to actions from the WAPT Server.
The Linux kernel has a protection against having too many TCP connections opened at the same time and one may get the SYN flooding on port message in the Nginx log. In order to avoid these messages, it is necessary to modify the two following parameters. It should be around 1.5 times the number of WAPT clients.
cat > /etc/sysctl.d/wapt.conf <<EOF
net.ipv4.tcp_max_syn_backlog=4096
net.core.somaxconn=4096
EOF
sysctl --system
Configuring the PostgreSQL database¶
OS Type |
File location |
|---|---|
Debian / Ubuntu |
|
Redhat and derivatives |
|
Windows |
|
A higher number of clients need a higher number of connections to the PostgreSQL database.
In the postgresql.conf file, you need to increase the following parameter to approximately 1/4 the number of active WAPT Agents.
max_connections = 1000
In /opt/wapt/conf/waptserver.ini file (for Windows C:\wapt\conf\waptserver.ini), db_max_connections should be equal to PostgreSQL max_connections minus 10 (PostgreSQL needs to keep some connections for its housekeeping stuff).
The max_clients parameter should be set around 1.2 times the number of WAPT Agents:
[options]
...
max_clients = 4096
db_max_connections = 990