Oracle Endeca Server Administrator's Guide · Version 7.6.1 · December 2013
Copyright © 2003, 2013, Oracle and/or its affiliates. All rights reserved.
A configuration file, EndecaServer.properties, sets global parameters for Endeca Server, such as the default locations of mandatory files and directories.
$MW_HOME/user_projects/domains/endeca_server_domain/config/EndecaServer.propertiesThe path on Windows is similar. The configuration file includes: The default values in the file are set by the Endeca Server installer.
The SSL-specific parameters, such as endeca-ssl-keystore, in the Endeca.Server.properties are empty at installation time. These values are filled in if you later run the generate_ssl_keys utility that creates the SSL keys and certificates.
| Endeca Server parameter | Description |
|---|---|
| endeca-require-https | If set to true, specifies that Endeca Server enforces the use of the HTTPS port. If set to false, uses the HTTP port. |
| endeca-runtime-basedir | The location of the Endeca Server's endeca-server directory. The default is the $ENDECA_HOME/endeca-server location. |
| endeca-data-dir | The location where the data files for all the Endeca data domains are stored for this Endeca Server instance. The default location is the $DOMAIN_HOME/EndecaServer/data directory. Note that you can specify only one directory (that is, specifying multiple directories is not allowed). |
| endeca-offline-dir | The location where the data files for an Endeca data domain are exported by the export-dd of endeca-cmd. The default is the $DOMAIN_HOME/EndecaServer/offline directory. Note that you can specify only one directory (that is, specifying multiple directories is not allowed). |
| endeca-logs-dir | The location of the Dgraph process standard out/err log and request log, as well as the PID file. The default is the $DOMAIN_HOME/EndecaServer/logs directory. You can specify only one directory (that is, specifying multiple directories is not allowed). |
| endeca-dgraph-install | The location of the Endeca Server Dgraph application directory. The default is the $ENDECA_HOME/endeca-server/dgraph directory. |
| endeca-webserver-port | The port on which the Endeca Server listens for requests. The default is 7001 (for non-SSL deployments), or 7002 (for SSL deployments). |
| endeca-ds-port-min and endeca-ds-port-max | The range of port numbers from which the
Endeca Server selects the HTTP/HTTPS ports and the bulk-load ports for the
Dgraph processes. Once a port is assigned to a Dgraph process, that port is not
used for subsequent Dgraph port assignments (unless the data domain is
disabled). This port assignment strategy prevents port collisions among the
Dgraph processes.
The defaults for endeca-ds-port-min are 7011 (for non-SSL deployments) or 7012 (for SSL deployments). The defaults for endeca-ds-port-max are 8011 (for non-SSL deployments) or 8012 (for SSL deployments). |
| endeca-ds-pin-timeout-min | The default minimum value is 60000 milliseconds (ms). This is the lowest timeout value the Dgraph process can use when PinDataVersion request is issued. This parameter, as well as endeca-ds-pin-timeout-max and endeca-ds-pin-timeout-default are used in the Endeca Server to enable index version pinning requests. For information about index data version pinning, see the Oracle Endeca Server Developer's Guide. |
| endeca-ds-pin-timeout-max | The default maximum value is 300000 ms. This is the highest timeout value the Dgraph process can use when PinDataVersion request is issued. |
| endeca-ds-pin-timeout-default | The default value for the timeout is 120000 ms. This is the default timeout value used by the Dgraph if you do not specify the value in the PinDataVersion request. (You typically use this request of the Conversation Web Service to pin a data version). |
| endeca-ds-cert-file | The path of the SSL certificate file. This certificate file is used by all clients and servers to specify their identity when using SSL to connect to the Oracle Endeca Server. If the generate_ssl_keys utility was run, the default path is to the $DOMAIN_HOME/config/ssl/dgraphCert.pem file. If the utility was not run, this setting is empty. |
| endeca-ds-ca-file | The path of the certificate authority file. This file is used by all clients and servers to authenticate the other endpoint of a communication channel. If the generate_ssl_keys utility was run, the default path is to the $DOMAIN_HOME/config/ssl/dgraphCA.pem file. If the utility was not run, this setting is empty. |
| endeca-secure-mode | If set to true, specifies that Endeca Server is using SSL and that the Dgraphs should be started in SSL mode. If set to false, Endeca Server and the Dgraphs are not using SSL. |
| endeca-memory-to-index-size-ratio | Specifies the ratio of virtual memory
allocated for a data domain to the index size. The default is 2.0. This setting
is used by the Endeca Server for data domain allocation on its nodes. It
affects how the Endeca Server calculates whether it has sufficient amount of
memory to allocate memory on its nodes to the newly-created data domains. For
example, if the index size is 40MB and the default ratio of 2 is used, the
Endeca Server will attempt to allocate 80 MB for the data domain.
Note: This setting should only be modified by the system
administrator of the overall Endeca Server deployment (such as a cluster), and
should not be modified by the system administrators of specific data domains
hosted in the Endeca Server. Before modifying this setting, learn more about
how this setting is used and assess how it applies to your own deployment. For
more information on how this setting is used, see the topic on data domain
allocation in the
Oracle Endeca Server Cluster Guide.
|
| endeca-threads-allowed-per-core | Specifies how many threads are actually
allowed on a single core, on each Endeca Server node. The default is 1. This
setting is used by the Endeca Server for data domain allocation. It affects how
the Endeca Server calculates whether it has sufficient number of processing
threads to allocate on its nodes to the newly-created data domains.
Note: This setting should only be modified by the system
administrator of the overall Endeca Server deployment (such as a cluster), and
should not be modified by the system administrators of specific data domains
hosted in the Endeca Server. For more information on this setting, see the
topic on data domain allocation in the
Oracle Endeca Server Cluster Guide.
|
| endeca-cgroups-enabled, endeca-cgroups-specified-by-percentage, endeca-cgroups-reserved-ram-mb, endeca-cgroups-reserved-swap-mb, endeca-cgroups-reserved-ram-percentage, endeca-cgroups-reserved-swap-percentage | These settings are only applicable to the Endeca Server deployment on Linux 6 (Red Hat Enterprise Linux 6). These settings control how the Endeca Server uses the cgroups feature in Linux 6. For information, see About using control groups (cgroups) for data domains. |
| Cluster Coordinator parameter | Description |
|---|---|
| endeca-cluster-coordinator-dir | The location of the Endeca Cluster
Coordinator root directory.
The default is the $ENDECA_HOME/endeca-server/cluster-coordinator directory. |
| endeca-cluster-coordinator-hosts | The default is
localhost (which should be used for a
single-node installation).
For an Endeca Server cluster deployment, this parameter must contain comma-separated localhost names of all Managed Servers that are part of the Cluster Coordinator ensemble. Always use the localhost names, also known as the top-level domain names, for this field, such as host1, host2, host3. Do not use the Fully Qualified Domain Names. |
| endeca-cluster-coordinator-clientPort | The port of the server on which the Cluster
Coordinator is running. This the port at which the clients will connect.
The default is 2181. |
| endeca-cluster-coordinator-tickTime | The length of a single tick, which is the
basic time unit for the Cluster Coordinator.
A tick is measured in milliseconds. It is used to regulate heartbeats and timeouts. The default is 2000 milliseconds. |
| endeca-cluster-coordinator-initLimit | The number of ticks that the initial
synchronization phase can take. This number specifies the length of time the
nodes have to connect to the leader node.
The default is 10 ticks. |
| endeca-cluster-coordinator-syncLimit | The number of ticks that can take place
between one node sending a request for an update and receiving an
acknowledgment from the leader node.
The default is 5 ticks. |
| endeca-cluster-coordinator-dataDir | The location of the directory where the
in-memory database snapshots for the Cluster Coordinator and the transaction
log of updates to its database are stored.
The default is the $DOMAIN_HOME/EndecaServer/data directory. |
| endeca-cluster-coordinator-serverPort | The port that follower nodes use to connect
to the leader node.
The default server port is 3181. |
| endeca-cluster-coordinator-leaderPort | The port that the Cluster Coordinator
servers use to do leader election.
The default leader port is 4181. |
| endeca-cluster-coordinator-maxClientCnxns | Limits the number of concurrent connections
(at the socket level) that a single client, identified by IP address, may make
to a single member of the cluster ensemble.
This is used to prevent certain classes of DoS attacks, including file descriptor exhaustion. Setting this to 0 (the default) entirely removes the limit on concurrent connections. |
| endeca-cluster-coordinator-minSessionTimeout | Specifies the minimum session timeout in
milliseconds that the server will allow the client to negotiate.
The default is 4000 milliseconds. Note that this parameter is intended for use by Oracle Endeca Support only. |
| endeca-cluster-coordinator-maxSessionTimeout | Specifies the maximum session timeout in
milliseconds that the server will allow the client to negotiate.
The default is 180000 milliseconds. Note that this parameter is intended for use by Oracle Endeca Support only. |
The following configuration settings in EndecaServer.properties are specific to the Endeca Server Data Enrichment module. The Data Enrichment module is used for enrichments by Studio.
| Data Enrichment parameters | Description |
|---|---|
| endeca-data-enrichment-pluginsDir, endeca-data-enrichment-resourceDir, endeca-data-enrichment-collectionBatchSize, endeca-data-enrichment-collectionMatchRetries, endeca-data-enrichment-taskHistorySize | These properties define the configuration
for the Data Enrichment module. The Data Enrichment module is packaged with the
Endeca Server and is used with Studio.
If you are not using Data Enrichment module in Studio,
ignore these parameters. If you are using the Data Enrichment module in the
context of Studio, you can use the defaults for these parameters without
changing them. Note the following about these parameters:
|
Oracle Endeca Server Administrator's Guide · Version 7.6.1 · December 2013
Copyright © 2003, 2013, Oracle and/or its affiliates. All rights reserved.