The following describes how to configure One Identity Safeguard for Privileged Sessions (SPS) to accept connections from external indexer services.
To configure SPS to accept connections from external indexer services
-
Log in to the SPS web interface, and navigate to Basic Settings > Local Services > Indexer service.
-
Select Indexer service.
-
Select Enable remote indexing.
Figure 253: Basic Settings > Local Services > Indexer service > Enable remote indexing — Configure external indexers
-
In the Listening addresses > Address field, select the network interface where SPS should accept external indexer connections. Repeat this step to add other interfaces if needed.
The available addresses correspond to the interface addresses configured in Basic Settings > Network > Interfaces. Only IPv4 addresses can be selected.
-
Select Restrict clients, and list the IP address and netmask of your external indexer hosts.
Use an IPv4 address.
-
Click Commit.
Prerequisites
The external indexer can be installed on the following 64-bit operating systems: Red Hat Enterprise Linux Server 7, 8, and their derivatives, such as CentOS, Oracle Linux, AlmaLinux, Rocky Linux, etc.
NOTE: Derivatives are supported only if an issue can be reproduced on an official RHEL distribution. Do not report issues specific to a derivative OS but not to RHEL.
To install the external indexer
-
Log in as root to the host that you want to use to index your audit trails.
-
Copy the installer package to the host.
NOTE: Due to legal reasons, installation packages of the external indexer application will be available only from the SPS web interface. After SPS versions 6.4 and 6.0.3 are released, the installation packages will be removed from our website.
-
Install the package using the package manager of the operating system. For example:
yum install external-indexer-standalone-<version-number>.x86_64.rpm
The installer performs the following steps automatically.
-
Unpacks the indexer files into the /opt/external-indexer/ directory.
-
Installs the related init scripts (the /etc/init.d/external-indexer init script, and adds the init script configuration to /etc/sysconfig/external-indexer).
-
Creates the indexer user and usergroup. This is an unprivileged user that is used to run the indexer application.
-
Registers the service to start automatically on system boot. Note that the indexer init script uses bind mount points.
-
Configure the indexer. For details, see Configuring the external indexer.
To connect to One Identity Safeguard for Privileged Sessions (SPS) and index the audit trails, you must configure the external indexer.
|
|
Caution:
Unless you know exactly what you are doing, modify only the parameters you are instructed to. |
To configure the external indexer
-
Appendix: Log in to the SPS web interface, and navigate to Basic Settings > Local Services > Indexer service.
-
To export the configuration file for the external indexer, click Export.
NOTE: The Export button is displayed only after the configuration that enables SPS to use remote indexers is committed.
The configuration file contains the listening address (IP and port) of SPS and the necessary keys for SSL authentication.
Upload the file to the external indexer host.
-
On the external indexer host, import the configuration file with the following command:
indexer-box-config <configuration-file>.config
-
To configure the external indexer service, open the /etc/indexer/indexerworker.cfg configuration file for editing.
-
To edit the number of worker groups assigned to a certain worker process type, find the worker_groups line.
A worker group has the following parameters:
-
name: the name of the worker group
-
count: the number of workers to use for processing
-
capabilities: the types of jobs the process performs (index, screenshot, video, near-realtime)
NOTE: Setting the near-realtime capability exclusively determines whether active or closed sessions are indexed. For example:
-
If you set [near-realtime, index] capabilities for a worker, that worker only indexes active and ongoing sessions.
-
If you set [index, screenshot, video] capabilities for a worker, that worker only indexes closed sessions.
NOTE: If you configure a connection policy with near real-time priority (Connection policy > Enable indexing > Priority), you must configure indexer workers that are capable of near real-time indexing. To configure such indexer workers, set the near-realtime capability for the relevant workers.
NOTE: Indexer workers with the near-realtime capability require fewer CPU cores but more memory than indexer workers that do not have this capability.
Make sure that the sum value of the workers are equal to the number of CPU cores in the host (or the number of CPU cores minus one if you want to save resources for other tasks).
One Identity recommends using dedicated hosts for external indexing. If the host is not dedicated exclusively to the external indexer, decrease the number of workers accordingly.
-
(Optional) To fine-tune performance, you can configure the number of OCR threads each worker can initiate using the ocr_thread_count key.
The default setting is 3. When configuring this setting, pay attention to the available CPU cores, as raising the number of possible threads too high can impact performance negatively.
-
(Optional) If instructed by One Identity Support, configure the OCR engine.
Find the engine key, and change its value to one of the following options:
-
omnipage-external is the default setting. It provides the best performance and stability by allowing workers to initiate multiple OCR threads.
This setting also allows you to search for images where OCR could not be performed. On the search UI of SPS, enter the OOCCRRCCRRAASSHH search string to list all such images. If possible, contact our Support Team, to help One Identity to further improve the engine.
NOTE: Multiple OCR threads can only speed up processing graphical protocols (RDP, VNC, and ICA trails), and do not affect the processing speed for terminal-based protocols (telnet and SSH).
-
omnipage only supports one OCR thread per worker.
If you have to use this option, make sure to also set the ocr_thread_count to 0.
-
Save your changes.
-
(Optional) Continue with uploading decryption keys to index encrypted audit trails. For more information, see Uploading decryption keys to the external indexer.
-
(Optional) Start the indexer service. For more information, see Starting the external indexer.
You can share your worker resources between multiple indexer services, for example behind a load-balancer, or in an SPS cluster if you want to share some of your indexer workers between multiple SPS instances.
To enable resource sharing
-
Use the indexer-box-config script with an additional --service-pool option to enumerate the service configurations.
NOTE: Running this script can overwrite your custom modifications in your indexerworker.cfg file. Make a backup of indexerworker.cfg before running the script.
indexer-box-config
cp /etc/indxer/indexerworker.cfg /etc/indxer/indexerworker.cfg.bak |
indexer-box-config $dedicated-server-config --service_pool $cfg1 $cfg2 $cfg3 |
If you run the script with --service-pool option, the script creates a service-pool field in your configuration file which can be used by any worker-group. The script also creates a default worker-group called shared, with an additional balancing field. These workers run in one-shot mode, and connect to an indexer-service randomly selected from the pool.
Example: output after running script with two configuration files
{ |
"service": { |
"address": "169.254.1.1", |
"port": 12345, |
"ssl": { |
"ca_certificate": "/etc/indexer/cacert.pem", |
"certificate": "/etc/indexer/worker.pem", |
"enabled": false, |
"private_key": "/etc/indexer/worker.key" |
} |
}, |
"service_pool": [ |
{ |
"address": "192.168.1.111", |
"port": 12345, |
"ssl": { |
"ca_certificate": "/etc/indexer/idx-external-indexer-20220902T1208/ca.pem", |
"certificate": "/etc/indexer/idx-external-indexer-20220902T1208/worker.pem", |
"enabled": true, |
"private_key": "/etc/indexer/idx-external-indexer-20220902T1208/worker.key" |
} |
}, |
{ |
"address": "192.168.1.118", |
"port": 12345, |
"ssl": { |
"ca_certificate": "/etc/indexer/idx-external-indexer-20220902T1207/ca.pem", |
"certificate": "/etc/indexer/idx-external-indexer-20220902T1207/worker.pem", |
"enabled": true, |
"private_key": "/etc/indexer/idx-external-indexer-20220902T1207/worker.key" |
} |
} |
], |
"settings": { |
"log_level": 3, |
"ocr": { |
"engine": "omnipage-external", |
"minimal_time_distance": 1, |
"ocr_thread_count": 2 |
}, |
"pkcs11": { |
"custom_password": false, |
"slots": [] |
}, |
"terminal": { |
"extract_buffer": true |
}, |
"worker_arguments": "--http-config /opt/external-indexer/httpconfig.json" |
}, |
"worker_groups": [ |
{ |
"balancing": false, |
"capabilities": [ |
"index" |
], |
"count": 4, |
"name": "workers" |
}, |
{ |
"balancing": false, |
"capabilities": [ |
"screenshot", |
"video" |
], |
"count": 1, |
"name": "screenshot-and-video" |
}, |
{ |
"balancing": false, |
"capabilities": [ |
"video" |
], |
"count": 1, |
"name": "video" |
}, |
{ |
"balancing": false, |
"capabilities": [ |
"near-realtime" |
], |
"count": 0, |
"name": "near-realtime" |
}, |
{ |
"balancing": true, |
"capabilities": [], |
"count": 0, |
"name": "shared" |
} |
], |
"workercontroller": { |
"log_level": "info" |
} |
} |
These worker processes disconnect from the service when they finish processing a job, or when they do not receive a job within 60 seconds after connecting to the service.
-
Define additional worker-groups.
You can define any number of worker-groups with different capabilities, but you can have only one dedicated service and one service pool.
-
Add "balancing": true to any worker-group to share those workers between the services configured in the service-pool field.
Worker groups without balancing option, or balancing set to false connect to the dedicated service to fetch jobs.
