ABS configuration - abs.properties
The ABS configuration file (abs.properties) is located in the ABS config directory. The following table explains the parameters and provides recommended values.
| Parameter | Description | ||
|---|---|---|---|
ABS IP, port, log level, and JKS password |
|||
|
Set the timezone to |
||
|
Port for ABS to ASE and REST API to ABS communication. The default value is 8080. |
||
|
Log detail captured. The default is INFO. Additional options - DEBUG, ERROR, WARN, FATAL. |
||
|
The password of the JKS Keystore. ABS ships with a default obfuscated password. You can reset the password and obfuscate it. This password should be the same that you would use in importing your CA-signed certificate. |
||
ABS performance configurations |
|||
|
Memory size in MB allocated to run machine learning jobs. Recommended to be at least 50% of system memory. |
||
|
Do not change the value of this parameter. The default is 10. |
||
ABS email configurations for alerts and reporting |
|||
|
Enable ( |
||
|
Email address used for sending email alerts and reports. |
||
|
Email address notified about alerts and reports. If you want more than one person to be notified, use an email alias. |
||
|
Password of sender’s email account. NOTE: You can leave this field blank if your SMTP server does not require authentication. |
||
|
Port number of SMTP server. |
||
|
Hostname of SMTP server. |
||
|
Set to Set it to false if email communication is over a non-SSL channel. The email communication will fail if you set the parameter to |
||
|
Set to If you set it to
Here |
||
MongoDB configurations |
|||
|
Comma separated MongoDB replica set URI. A maximum of three nodes can be configured. |
||
|
The MongoDB metadata database name. The default value is |
||
|
The MongoDB data database name. The default value is |
||
|
The MongoDB machine learning database name. The default value is |
||
|
Defines the method in which MongoDB authenticates. The possible values can be:
|
||
|
Username of MongoDB. NOTE: Required for MongoDB authentication |
||
|
MongoDB password |
||
|
Set it to |
||
|
Set it to
|
||
ABS reporting node |
|||
|
When The default value is |
||
Cloud and OAuth configurations
|
|||
|
The AWS S3 bucket name. |
||
|
The environment id of the tenant. |
||
|
The ABS deployment mode. Valid values are |
||
|
The audience claim (aud) of the access token. |
||
|
The list of valid JWT issuers from whom the tokens are expected. |
||
|
The JSON Web Key Set (JWKS) endpoint. |
||
A sample abs.properties file is displayed below.
# Ping Identity Corporation, ABS config file # All the keys should be present, leave blank value if not applicable # Set the timezone to utc or local. The default timezone is utc. timezone=utc # REST API port management_port=8080 # Log levels (ALL > DEBUG > INFO > WARN > ERROR > FATAL > OFF) log_level=DEBUG # Java KeyStore password jks_password=OBF:AES:Q3vcrnj7VZILTPdJnxkOsyimHRvGDQ==:daYWJ5QgzxZJAnTkuRlFpreM1rsz3FFCulhAUKj7ww4= # MongoDB replica set URI. For example, mongodb://<IP1>:<Port>,<IP2>:<Port>,<IP3>:<Port>. Maximum three nodes can be configured. mongo_rs=mongodb://localhost:27017 # MongoDB Database metadata_dbname=abs_metadata data_dbname=abs_data mldata_dbname=abs_mldata # MongoDB authentication # If authentication is not enabled in MongoDB, set the mongo_auth_mechanism to NONE # The supported MongoDB authentication mechanisms are DEFAULT and PLAIN. # If authentication mechanism is DEFAULT, provide MongoDB username and password for mongo_username # and mongo_password. If authentication mechanism is PLAIN, provide external # LDAP username and password in mongo_username and mongo_password. mongo_auth_mechanism=DEFAULT mongo_username=absuser mongo_password=OBF:AES:Q3vcrnj7VZILTPdJnxkOsyimHRvGDQ==:daYWJ5QgzxZJAnTkuRlFpreM1rsz3FFCulhAUKj7ww4= # Mongo DB SSL # Set to true if Mongo DB instance is configured in SSL mode. # By default, ABS will try to connect to Mongo using non-SSL connection mongo_ssl=false # Mongo DB Server Certificate Verification # Set to true if Mongo DB instance is configured in SSL mode and you want to do the server certificate verification # By default ABS will not verify the MongoDB server certificate mongo_certificate=false # Job queue size per node queue_size=10 # Setting as true makes an ABS node for dashboard query only and does not participate in ABS cluster for log processing dashboard_node=false # Memory for webserver and streaming server (unit is in MB) system_memory=4096 # E-mail alerts enable_emails=false # SMTP host smtp_host=smtp.example.com # SMTP port smtp_port=587 # Set this value to true if smtp host support SSL smtp_ssl=true # Set this value to true if SSL certificate verification is required smtp_cert_verification=false # Sender email id sender_email=sender@example.com # Sender's email password email_password=OBF:AES:UXzB+y+69Bn3xiX6N822ad4hf5IfNfJY9w==:T+QzM6qtc0+6MVsx4gU5p0LMHAI/y+w8DDsWv6VxVAk= # Receiver's email id receiver_email=receiver@example.com # Set this value to appropriate AWS S3 Bucket name, if ABS is running in cloud mode bucket_name= # Set this value to appropriate Env Id, if ABS is running in cloud mode env_id= # Set this value to either cloud / onprem, as per the ABS running mode. By default set to onprem deployment_type=onprem # Token validation params # Audience oauth_audience= # Issuer whitelist oauth_issuer_whitelist= # JWKS endpoint oauth_jwks_endpoint=