- Synopsis:
- The default hostname/ip-address of the database server.
- See Adminer on DockerHub
- Where used:
- Synopsis:
- The access key for your AWS account.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Examples:
- Where used:
- Synopsis:
- The path to a custom certificate bundle to use when establishing SSL/TLS connections.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Where used:
- Synopsis:
- The location of the config file.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Where used:
- Synopsis:
- A list of additional directories to check when loading botocore data.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Where used:
- Synopsis:
- The default AWS Region to use.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Examples:
us-east-1
us-west-2
- See How to set AWS environment variables
- Where used:
- Synopsis:
- The total number of attempts made for a single request.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Where used:
- Synopsis:
- Number of attempts to retrieve credentials on an Amazon EC2 instance.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Values:
- Default: 1
- Where used:
- Synopsis:
- The number of seconds before a connection to the instance metadata service should time out.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Where used:
- Synopsis:
- The default profile to use, if any.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Where used:
- Synopsis:
- Specifies the types of retries the SDK will use.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Where used:
- Synopsis:
- The secret key for your AWS account.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Examples:
- Where used:
- Synopsis:
- The session key for your AWS account.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Examples:
- Where used:
- Synopsis:
- The location of the shared credentials file.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Values:
- Default:
~/.aws/credentials
- Default:
- Where used:
- Synopsis:
- Sets AWS STS endpoint resolution logic.
- When used in python programs, see Boto3 Configuration, Using environment variables.
- Where used:
-
Synopsis:
- A component of SENZING_DATABASE_URL.
- The name of the database holding the Senzing G2 model.
-
Values:
- Default: none
- Usually: G2
-
Examples:
-
Using
G2
as the database:export DATABASE_DATABASE=G2
-
-
Where used:
-
Synopsis:
- A component of SENZING_DATABASE_URL.
- A hostname, IP address, or symbolic name of the database service.
-
Examples:
-
Using an IP address:
export DATABASE_HOST=10.1.1.17
-
-
Where used:
-
Synopsis:
- A component of SENZING_DATABASE_URL.
- The password for the database user, DATABASE_USERNAME.
-
Examples:
-
Using password of "my;password!":
export DATABASE_PASSWORD="my;password!"
-
-
Where used:
-
Synopsis:
- A component of SENZING_DATABASE_URL.
- The port on the machine offering the database service.
-
Values:
- 50000 - db2 default
- 3306 - mysql default
- 5432 - postresql default
- sqlite3 has no default as it is file-based.
- Default: none
-
Examples:
-
Using default port for postgresql:
export DATABASE_PORT=5432
-
-
Where used:
-
Synopsis:
- A component of SENZING_DATABASE_URL.
- Identifies which type of database will be connected.
-
Values:
- db2
- mysql
- postgresql
- sqlite3
- Default: none
-
Examples:
-
PostgreSQL
export DATABASE_PROTOCOL=postgresql
-
-
Where used:
-
Synopsis:
- A component of SENZING_DATABASE_URL.
- The name of a user authorized to work with the DATABASE_DATABASE database.
-
Examples:
-
Using user name of "my-user":
export DATABASE_USERNAME="my-user"
-
-
Where used:
- Synopsis:
- The directory containing custom scripts for
ibmcom/db2
docker container. Is mounted to
/var/custom
.
- The directory containing custom scripts for
ibmcom/db2
docker container. Is mounted to
- Values:
- Default: None
- Where used:
- Synopsis:
- The database schema name.
- Values:
- Default: "G2"
- Where used:
- Synopsis:
- Path on local system where the database files are stored.
- Values:
- Default: None. Application dependent.
- Where used:
- Synopsis:
- Password for the database "root" username.
- Values:
- Default: "db2inst1"
- Where used:
- Synopsis:
- The username for the the database "root" user.
- Values:
- Default: "db2inst1"
- Where used:
- Synopsis:
- The password for the "db2inst1" user name.
- Values:
- Default: "db2inst1"
- Where used:
- Synopsis:
- In a Kubernetes environment, a value used for the namespace.
- Values:
- Example: "my-namespace"
- Where used:
- Synopsis:
- In a Kubernetes environment, a value prefixed used to object names.
- Values:
- Example: "my"
- Where used:
- Synopsis:
- The docker app command, based on the type of installation (Stand-alone or Docker CLI plugin).
- Docker App installation
- Values:
- "docker-app"
- "docker app"
- Default: None
- Where used:
- Synopsis:
- Location of file used in Docker App
--parameters-file
command-line option.
- Location of file used in Docker App
- Values:
- Default: None
- Where used:
- Synopsis:
- In a Kubernetes environment, the name of the Kubernetes Secret for accessing the public or local Docker registry.
- Where used:
- Synopsis:
- URL of a public or local Docker registry.
- Values:
- Example: "docker.io"
- Where used:
-
Synopsis:
- Location of the
g2.lic
file on a local workstation
- Location of the
-
Examples:
-
Using
Downloads
directory.export G2_LICENSE_PATH="~/Downloads/g2.lic"
-
-
Where used:
- Where used:
- Where used:
- Where used:
- Where used:
-
Synopsis:
- In a Kubernetes environment, a parameter for the
kubectl
command.
- In a Kubernetes environment, a parameter for the
-
Examples:
-
Setting parameter.
export HELM_TLS="--tls"
-
-
Where used:
- Synopsis:
- In a Kubernetes environment, a directory holding files for use in the
helm --values
parameter.
- In a Kubernetes environment, a directory holding files for use in the
- Where used:
- Synopsis:
- Port on localhost for senzing/jupyter.
- See Port 9178
- Values:
- Default: 9178
- Where used:
- Synopsis:
- A directory on the localhost that is shared with the docker container as Jupyter's
shared
folder.
- A directory on the localhost that is shared with the docker container as Jupyter's
- Values:
- Default: None
- Where used:
- Synopsis:
- In a Kubernetes environment, a directory holding files for use in the helm
kubectl --filename
parameter.
- In a Kubernetes environment, a directory holding files for use in the helm
- Where used:
- Synopsis:
- The database schema name.
- Values:
- Default: "G2"
- Where used:
- Synopsis:
- Path on local system where the database files are stored.
- Values:
- Default: None. Application dependent.
- Where used:
- Synopsis:
- Password for MYSQL_USERNAME.
- Values:
- Default: "g2"
- Where used:
- Synopsis:
- The password for the the database "root" user name.
- Values:
- Default: "root"
- Where used:
- Synopsis:
- Non-root MySQL user.
- Values:
- Default: "g2"
- Where used:
- Synopsis:
- The database schema name.
- Values:
- Default: "G2"
- Where used:
- Synopsis:
- Path on local system where the database files are stored.
- Values:
- Default: None. Application dependent.
- Where used:
- Synopsis:
- The password for the the database "root" user name.
- Values:
- Default: "postgres"
- Where used:
- Synopsis:
- The username for the the database "root" user name.
- Values:
- Default: "postgres"
- Where used:
- Synopsis:
- Path on local system where RabbitMQ files are stored.
- Values:
- Default: None. Application dependent.
- Where used:
- Synopsis:
- the password for the RabbitMQ user.
- Values:
- Default: None. Application dependent.
- Synopsis:
- Should preexisting RabbitMQ exchanges, queues, and mappings be used.
- Values:
- Default: Varies
- True: Connect to an existing exchange or queue using the given name. Fails if the entity does not exist.
- False: Create the entities if they do not exist, or connect to a prexisting entity if it has the right settings. Fails if the settings passed when conncting differ from the settings on the existing entity.
- Where used:
- Synopsis:
- the username for the RabbitMQ user.
- Values:
- Default: None. Application dependent.
- Synopsis:
- This is your acceptance of the End User License Agreement (EULA). The EULA is located at https://senzing.com/end-user-license-agreement.
- Values:
- If you accept the Senzing End User Licence Agreement (EULA), the value is "I_ACCEPT_THE_SENZING_EULA"
- Where used:
- Synopsis:
- Filename for the Senzing API RPM file.
- Values:
- Format:
senzingapi-M.m.P.x86_64.rpm
- Default: none
- Format:
- Where used:
- Synopsis:
- Port on localhost for Senzing API service.
- See Port 8250
- Values:
- Default: 8250
- Where used:
-
Synopsis:
- A URL consisting of host:port running Senzing API server.
- See Port 8250
-
Values:
- Format:
http://${hostname}:${SENZING_API_SERVICE_PORT}
- Default: None
- Format:
-
Examples:
-
Using hostname.
export SENZING_API_SERVER_URL="http://example.com:8250"
-
-
Where used:
- Synopsis:
- Determine how often to check for a change in the Senzing configuration.
- Where used:
- Synopsis:
- Used for
PIPELINE.CONFIGPATH
value in G2 Engine configuration.
- Used for
- Values:
- Default:
/etc/opt/senzing
- Default:
- Where used:
- Where used:
- Filename for the Senzing Data RPM file.
- Values:
- Format:
senzingdata-M.m.P.x86_64.rpm
- Default: none
- Format:
- Where used:
- Synopsis:
- Default "DATA_SOURCE" value for incoming records.
If a JSON line does not have the
DATA_SOURCE
key/value, this value is inserted.
- Default "DATA_SOURCE" value for incoming records.
If a JSON line does not have the
- Values:
- Default: none
- Forms:
- Helm: senzing.dataSource
- Where used:
- Synopsis:
- Path on the local system where Senzing data/nn.nnn.nnn directory is located. It differs from the value of the SENZING_DATA_DIR environment variable used in installing Senzing because it includes the version of the data in the path. This directory contains immutable data files used by Senzing G2.
- Values:
- Default: none
- Usually set to
/opt/senzing/data/1.0.0
- Where used:
-
Synopsis:
-
Database URI in the form:
DATABASE_PROTOCOL://DATABASE_USERNAME:DATABASE_PASSWORD@DATABASE_HOST:DATABASE_PORT/DATABASE_DATABASE.
-
-
Values:
- Default: Use the internal SQLite database.
-
Examples:
-
MySQL
export SENZING_DATABASE_URL=mysql://user:password@my.example.com:3306/G2
-
PostgreSQL
export SENZING_DATABASE_URL=postgresql://user:password@my.example.com:5432/G2
-
Db2:
export SENZING_DATABASE_URL=db2://db2inst1:db2inst1@my.example.com:50000/G2
-
SQLite
export SENZING_DATABASE_URL=sqlite3://na:na@/var/opt/senzing/sqlite/G2C.db
-
-
Forms:
- Helm: senzing.databaseUrl
-
Where used:
-
Synopsis:
- Enable debug information.
-
Values:
- 0 = no debug
- 1 = debug
- Default: 0
-
Examples:
-
Turn debugging on
export SENZING_DEBUG=1
-
-
Forms:
- Helm: senzing.debug
-
Where used:
- Synopsis:
- Time to delay before actually starting process
- Used for simple choreography.
- Where used:
- Deprecated
- Synopsis:
- Path on the local system where Senzing_API.tgz has been extracted. See HOWTO - Create SENZING_DIR.
- Values:
- Default: None
- Usually set to "/opt/senzing".
- Forms:
- Helm: senzing.senzingDir
-
Synopsis:
- The IP address of the system hosting Docker containers.
-
Examples:
-
Manually specify. Example:
export SENZING_DOCKER_HOST_IP_ADDR=10.1.1.100
-
To find the value for SENZING_DOCKER_HOST_IP_ADDR use Python interactively: Example:
python3
Copy and paste the following lines into the Python REPL (Read-Evaluate-Print Loop):
import socket sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) sock.connect(("8.8.8.8", 80)) print("export SENZING_DOCKER_HOST_IP_ADDR={0}".format(sock.getsockname()[0])) sock.close() quit()
Copy and paste the printed export statement into the host terminal.
-
-
Where used:
- Synopsis:
- The desired version of senzing/adminer.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/apt.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/db2-driver-installer.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/entity-search-web-app.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/init-container.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/jupyter.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/phppgadmin.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of portainer/portainer.
- To see latest version, visit versions-latest.sh
- Synopsis:
- The desired version of postgres.
- To see latest version, visit versions-latest.sh
- Synopsis:
- The desired version of senzing/postgresql-client.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of bitnami/rabbitmq.
- To see latest version, visit versions-latest.sh
- Synopsis:
- The desired version of senzing/redoer.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/resolver.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/senzing-api-server.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/console.
- To see latest version, visit versions-latest.sh
- Synopsis:
- The desired version of senzing/senzing-debug.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of coleifer/sqlite-web.
- To see latest version, visit versions-latest.sh
- Synopsis:
- The desired version of senzing/sshd.
- To see latest version, visit versions-latest.sh
- Synopsis:
- The desired version of senzing/stream-loader.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/stream-logger.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/stream-producer.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/web-app-demo.
- To see latest version, visit versions-latest.sh
- Synopsis:
- The desired version of senzing/xterm.
- To see latest version, visit versions-latest.sh
- Where used:
- Synopsis:
- The desired version of senzing/yum.
- To see latest version, visit versions-latest.sh
- Where used:
- Where used:
-
Synopsis:
- Location of socket used to communicate with Docker.
-
Examples:
-
Common Linux location
export SENZING_DOCKER_SOCKET=/var/run/docker.sock
-
-
Where used:
-
Synopsis:
- URL of the docker registry's Version 1 API.
-
Examples:
-
registry.hub.docker.com
export SENZING_DOCKERHUB_API_ENDPOINT_V1=https://registry.hub.docker.com/v1
-
-
Where used:
-
Synopsis:
- URL of the docker registry's Version 2 API.
-
Examples:
-
hub.docker.com
export SENZING_DOCKERHUB_API_ENDPOINT_V2=https://hub.docker.com/v2
-
-
Where used:
-
Synopsis:
- Organization name on hub.docker.com
-
Examples:
-
A "senzing" organization.
export SENZING_DOCKERHUB_ORGANIZATION=senzing
-
-
Where used:
- Synopsis:
- SENZING_DOCKERHUB_USERNAME's password for logging into hub.docker.com
- Where used:
- Synopsis:
- Login username for for hub.docker.com
- Where used:
-
Synopsis:
- Directory on local system where a download will be placed.
-
Examples:
-
Download to
/tmp/my-downloads
export SENZING_DOWNLOAD_DIR=/tmp/my-downloads
-
-
Where used:
- Synopsis:
- Location of where to place a downloaded file.
- Examples:
-
Download to
/tmp/my-downloads/x-file.tmp
export SENZING_DOWNLOAD_FILE=/tmp/my-downloads/x-file.tmp
-
- Synopsis:
- A JSON string that is a parameter to the Senzing Engine's
*.initV2()
function.
- A JSON string that is a parameter to the Senzing Engine's
- Synopsis:
- Default "ENTITY_TYPE" value for incoming records.
If a JSON line does not have the
ENTITY_TYPE
key/value, this value is inserted.
- Default "ENTITY_TYPE" value for incoming records.
If a JSON line does not have the
- Values:
- Default: none
- Forms:
- Helm: senzing.entityType
- Where used:
- Synopsis:
- Path on the local system where Senzing etc directory is located. This directory contains Senzing configuration templates and files.
- Values:
- Default: none
- Usually set to
/etc/opt/senzing
- Where used:
- Synopsis:
- Signify that program should end when queue is empty.
- Values:
- Datatype: boolean
- Default: False
- Where used:
- Synopsis:
- Amount of time to sleep before exiting.
- Used in autoscaling to slow down "cool down".
- Values:
- Default: 0
- Where used:
- Synopsis:
- Number of days before logging Senzing license expiration notices.
- Values:
- Default: 30
- Where used:
- Synopsis:
- Path on the local system where Senzing g2 directory is located. This directory contains Senzing G2 code.
- Values:
- Default: none
- Usually set to
/opt/senzing/g2
- Where used:
- Where used:
-
Synopsis:
- A list of one or more comma-separated SENZING_DATABASE_URLs.
-
Examples:
-
Single SENZING_DATABASE_URL. Example:
export SENZING_GOVERNOR_DATABASE_URLS=postgresql://postgres:postgres@localhost:5432/G2
-
Multiple SENZING_DATABASE_URLs. Example:
export SENZING_GOVERNOR_DATABASE_URLS=postgresql://postgres:postgres@localhost:5432/G2,postgresql://postgres:postgres@localhost:5432/G2_RES
-
-
Where used:
-
Synopsis:
- The number of records "skipped" before executing the analysis for governing.
-
Examples:
-
Analyze once every 10 million records. Example:
export SENZING_GOVERNOR_INTERVAL=10000000
-
-
Where used:
-
Synopsis:
- The character used to separate items in a list.
-
Values:
- Default: "," (a single comma)
-
Examples:
-
Use a plus sign instead of a comma. Example:
export SENZING_GOVERNOR_LIST_SEPARATOR="+"
-
-
Where used:
-
Synopsis:
- The maximum age of the PostgreSQL transaction ID (XID) before "governance" starts.
-
Values:
- Default: 10000000000 (10 billion)
-
Examples:
-
Set to 9 billion. Example:
export SENZING_GOVERNOR_POSTGRESQL_HIGH_WATERMARK=9000000000
-
-
Where used:
-
Synopsis:
- The maximum age of the PostgreSQL transaction ID (XID) before "governance" stops.
-
Values:
- Default: 9000000000 (9 billion)
-
Examples:
-
Set to 7 billion. Example:
export SENZING_GOVERNOR_POSTGRESQL_LOW_WATERMARK=7000000000
-
-
Where used:
-
Synopsis:
- A directory where governor and test code are placed.
-
Examples:
-
Set to 7 billion. Example:
export SENZING_GOVERNOR_PROJECT_DIR=~/test-governor
-
-
Where used:
-
Synopsis:
- The number of seconds to wait before querying the database.
-
Values:
- Default: 15 seconds
-
Examples:
-
Set to 10 minutes. Example:
export SENZING_GOVERNOR_WAIT=600
-
-
Where used:
- Where used:
- Synopsis:
- Time to sleep, in seconds, before doing initialization
- Values:
- Default: 0
- Where used:
- Where used:
- Synopsis:
- URL of source file.
- Values:
- Default: none
- Where used:
- Where used:
- Synopsis:
- Hostname and port of Kafka server.
- Values:
- Default: localhost:9092
- Where used:
- Synopsis:
- Kafka group.
- Values:
- Default: "senzing-kafka-group"
- Where used:
- Synopsis:
- Kafka topic.
- Values:
- Default: "senzing-kafka-topic"
- Where used:
- Synopsis:
- Level of logging
- Values:
- notset
- debug
- info
- warning
- error
- critical
- Default: info
- Forms:
- Helm: senzing.logLevel
- Where used:
- Synopsis:
- Interval between logging Senzing license information.
- Values:
- Default: 1 day
- Where used:
- Synopsis:
- Time, in seconds, between monitoring log records.
- Values:
- Default: 300
- Where used:
- Synopsis:
- Time, in seconds, between monitoring log records.
- Values:
- Default: 600
-
Synopsis:
- Used in
docker-compose
formations to identify the docker network.
- Used in
-
Examples:
-
Search for network in docker-compose:
sudo docker network ls # Choose value from NAME column of docker network ls export SENZING_NETWORK=nameofthe_network
-
-
Where used:
- Synopsis:
- Path on the local system where the
/opt/IBM
code resides. For instance, the Db2 client driver configuration would be located at${SENZING_OPT_IBM_DIR}/db2/clidriver/cfg/db2dsdriver.cfg
- Path on the local system where the
- Values:
- Default: none
- Usually set to
/opt/IBM
- Where used:
- Synopsis:
- Path on the local system where the
/opt/microsoft
code resides.
- Path on the local system where the
- Values:
- Default: none
- Usually set to
/opt/microsoft
- Where used:
-
Synopsis:
- Path on the local system where plugin files are located.
-
Values:
- Default: none
-
Examples:
-
Using an IP address:
export SENZING_PLUGINS_DIR=${GIT_REPOSITORY_DIR}/resources/plugins
-
-
Where used:
- Where used:
- Synopsis:
- A directory where Portainer can keep variable data.
- Where used:
-
Synopsis:
- A database URI in the form native to the database client driver.
- This differs from SENZING_DATABASE_URL, which has been "normalized" and is not in the native format.
-
Examples:
-
Using an IP address:
export SENZING_SQL_CONNECTION=mysql://username:password@hostname:3306/?schema=schemaname
-
-
Where used:
-
Synopsis:
- A path to a Senzing project.
-
Examples:
-
A project in the home directory. Example:
export SENZING_PROJECT_DIR=~/my-senzing-project
-
-
Where used:
-
Synopsis:
- The name of a Senzing project.
- Used as a prefix when creating objects for the project.
-
Examples:
-
A project in the home directory. Example:
export SENZING_PROJECT_NAME=~/test01
-
-
Where used:
- Synopsis:
- Maximum items for internal queue.
- Values:
- Default: 10
- Where used:
- Synopsis:
- Name of the RabbitMQ exchange used for routing messages.
- Values
- Default: "senzing-rabbitmq-exchange"
- Where used:
- Synopsis:
- Name of the RabbitMQ exchange used for routing info messages about loaded records
- Where used:
- Synopsis:
- Host name of the RabbitMQ server used to post records that failed to load
- Values:
- Default: The value of SENZING_RABBITMQ_HOST
- Where used:
- Synopsis:
- The password for the RabbitMQ failure server.
- Values:
- Default: The value of SENZING_RABBITMQ_PASSWORD
- Where used:
- Synopsis:
- The port to use to connect to the RabbitMQ server specified by SENZING_RABBITMQ_FAILURE_HOST
- Values:
- Default: The value of SENZING_RABBITMQ_PORT
- Where used:
- Synopsis:
- Name of the RabbitMQ queue used for records that failed to load.
- Values:
- Default: "senzing-rabbitmq-queue"
- Where used:
- Synopsis:
- The RabbitMQ routing key to use when creating a binding or publishing a record.
- Values:
- Default: "senzing.failure"
- Where used:
- Synopsis:
- The username for the RabbitMQ server.
- Values:
- Default: The value of SENZING_RABBITMQ_USERNAME
- Where used:
- Synopsis:
- Heartbeat time in seconds on connections to the RabbitMQ server.
- Values:
- Default: "60"
- Where used:
- Synopsis:
- Host name of the RabbitMQ server.
- Values:
- Default: "localhost:5672"
- Where used:
- Synopsis:
- Name of the RabbitMQ exchange used for routing info messages about loaded records
- Where used:
- Synopsis:
- Host name of the RabbitMQ server used to post the info about a loaded record
- Values:
- Default: The value of SENZING_RABBITMQ_HOST
- Where used:
- Synopsis:
- The password for the RabbitMQ info server.
- Values:
- Default: The value of SENZING_RABBITMQ_PASSWORD
- Where used:
- Synopsis:
- The port to use to connect to the RabbitMQ server specified by SENZING_RABBITMQ_INFO_HOST
- Values:
- Default: The value of SENZING_RABBITMQ_PORT
- Where used:
- Synopsis:
- Name of the RabbitMQ queue used for communication.
- Values:
- Default: "senzing-rabbitmq-queue"
- Where used:
- Synopsis:
- The RabbitMQ routing key to use when creating a binding or publishing a record.
- Values:
- Default: "senzing.info"
- Where used:
- Synopsis:
- The username for the RabbitMQ server.
- Values:
- Default: The value of SENZING_RABBITMQ_USERNAME
- Where used:
- Synopsis:
- The password for the RabbitMQ queue.
- Values:
- Default: "bitnami"
- Where used:
- Synopsis:
- The port to use to connect to the RabbitMQ server specified by SENZING_RABBITMQ_HOST
- Values:
- Default: "5672"
- Where used:
- Synopsis:
- The number of records to get from the RabbitMQ queue in one request. Reduces the number of overall requests to the RabbitMQ server and improves performance.
- Values:
- Default: 50
- Where used:
- Synopsis:
- The number of records to publish to RabbitMQ in a batch
- Values:
- Default: "1000"
- Where used:
- Synopsis:
- How often (in seconds) to publish a batch of records to the RabbitMQ Queue
- Values:
- Default: "0.0"
- Where used:
- Synopsis:
- Name of the RabbitMQ queue used for communication.
- Values:
- Default: "senzing-rabbitmq-queue"
- Where used:
- Synopsis:
- The RabbitMQ routing key to use when creating a binding to the failure queue or publishing to the failure exchange.
- Values:
- Default: "senzing.failure"
- Where used:
- Synopsis:
- The RabbitMQ routing key to use when creating a binding to the info queue or publishing to the info exchange.
- Values:
- Default: "senzing.info"
- Where used:
- Synopsis:
- The RabbitMQ routing key to use when creating a binding or publishing a record.
- Values:
- Default: "senzing.records"
- Where used:
- Synopsis:
- The username for the RabbitMQ queue.
- Values:
- Default: "user"
- Where used:
- Synopsis:
- Use existing entities. That is, don't create the entities.
- Where used:
- Synopsis:
- Identify seed for random number generator. Value of 0 uses system clock. Values greater than 0 give repeatable results.
- Values:
- Default: "0"
- Where used:
- Synopsis:
- JSON key whose value uniquely identifies a record.
- Used to identify specific records when logging errors.
- Values:
- Default: "RECORD_ID"
- Where used:
- Synopsis:
- Identify highest record number to generate.
- Values:
- Value of 0 means no maximum.
- Default: "0"
- Where used:
- Synopsis:
- Identify lowest record number to generate.
- Values:
- Default: "1"
- Where used:
- Synopsis:
- Write a log record every N mock records.
- Values:
- Default: "10000"
- Where used:
- Synopsis:
- Throttle output to a specified records per second.
- Values:
- Value of 0 means no throttling.
- Default: "0"
- Where used:
- Synopsis:
- Maximum size of a record that will be sent to a Queue.
- Records that exceed the maximum size will be logged.
- Values:
- Value of 0 means no maximum.
- Default: "0"
- Where used:
- Synopsis:
- Used in
PIPELINE_RESOURCEPATH
for G2 Engine configuration.
- Used in
- Values:
- Default:
/opt/senzing/g2/resources
- Default:
- Where used:
- Synopsis:
- Filename for the Senzing API RPM file.
- Values:
- Format:
senzingapi-MM.mm.PP.x86_64.rpm
- Default: none
- Format:
- Where used:
-
Synopsis:
- A parameter for the
docker run
statement to force the container to run as a specific user.
- A parameter for the
-
Values:
- Default: 1001
-
Examples:
-
root
export SENZING_RUNAS_USER="0"
-
-
Where used:
- Synopsis:
- When true, do not perform initial performance evaluation.
- Where used:
- Synopsis:
- Amount of time to sleep, in seconds, before running command.
- Forms:
- Helm: senzing.sleepTime
- Where used:
- Where used:
- Synopsis:
- Indicate that an AWS SQS "dead-letter" queue has been enables.
- This changes the logging behavior.
- Where used:
- Synopsis:
- The Amazon SQS Queue URL used convey messages that cannot be processed by the Senzing Engine.
- Examples:
https://sqs.us-east-1.amazonaws.com/000000000000/senzing-failure-queue
- Where used:
- Synopsis:
- The length of time, in seconds, for which to delay a specific message on the Info queue.
- Values:
- Default: 10
- References:
- Boto3 send_message See
DelaySeconds
parameter.
- Boto3 send_message See
- Where used:
- Synopsis:
- The Amazon SQS Queue URL used convey "withInfo" messages from the Senzing Engine.
- Examples:
https://sqs.us-east-1.amazonaws.com/000000000000/senzing-info-queue
- Where used:
- Synopsis:
- The Amazon SQS Queue URL used convey messages for ingestion into the Senzing Engine.
- Examples:
https://sqs.us-east-1.amazonaws.com/000000000000/senzing-queue
- Where used:
- Synopsis:
- For use with SQS "long-polling"
- Where used:
- Synopsis:
- Identify the subcommand to be run.
- Values:
- Run
program-name --help
for complete list.
- Run
- Forms:
- Helm: senzing.subcommand
- Where used:
- Where used:
- Synopsis:
- Number of threads per process to allocate for processing.
- Values:
- Default: 4
- Where used:
- Where used:
-
Synopsis:
- Path on the local system where Senzing var directory is located. This directory contains files that may mutate during execution.
-
Values:
- Default: none
- Usually set to
/var/opt/senzing
-
Where used:
- Where used:
- Synopsis:
- Port on localhost for Senzing Entity Search WebApp.
- See Port 8251
- Values:
- Default: 8251
- Where used:
- Synopsis:
- Port on localhost for Docker web application service.
- Values:
- Default: none
- Where used:
- Synopsis:
- Name of SQLite database containing Senzing schema.
- Values:
- Usual value:
G2C.db
- Default: none
- Usual value: