[/map {"- map/map "}) [/map/topicref {"- map/topicref "}) [/map/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicmeta/navtitle {"- topic/navtitle "}) Managing Data Domains (navtitle][/map/topicref/topicmeta/linktext {"- map/linktext "}) Managing Data Domains (linktext][/map/topicref/topicmeta/shortdesc {"- map/shortdesc "}) This section describes how to add or delete data domains, change the number of data domain nodes, and do other maintenance tasks, such as copying, importing, enabling, and monitoring a data domain. (shortdesc] (topicmeta][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) The Endeca data domain and the Dgraph process (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) The Endeca data domain and the Dgraph process (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The Endeca Server application services requests for one or more Endeca data domains. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Adding, removing, changing and updating data domains (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Adding, removing, changing and updating data domains (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) You can create a new data domain, clone an existing data domain, change the number of data domain nodes, and update the data domain to use another data domain profile. (shortdesc] (topicmeta][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Adding a new data domain (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Adding a new data domain (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) You add a data domain with the endeca-cmd create-dd name command, where name is the name of your data domain. Running this command is equivalent to using the createDataDomain operation in the Manage Web Service request. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Removing a data domain (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Removing a data domain (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) You remove a data domain with endeca-cmd delete-dd name, or with the deleteDataDomain request of the Manage Web Service. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Cloning an existing data domain (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Cloning an existing data domain (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) You can add a new data domain that replicates an existing one with the endeca-cmd clone-dd name command, or with the cloneDataDomain operation of the Manage Web Service. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Adding nodes to a data domain (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Adding nodes to a data domain (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) To rescale, or add Dgraph nodes to a running data domain, use the endeca-cmd rescale-dd command, or the rescaleDataDomain operation of the Manage Web Service. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Updating a data domain (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Updating a data domain (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) You update a data domain with the endeca-cmd update-dd name --dd-profile-name command, where name is the name of your data domain, and the --dd-profile-mame option specifies the data domain profile you want to use (this option is required). Running this command is equivalent to using the updateDataDomain operation in the Manage Web Service request. (shortdesc] (topicmeta] (topicref] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Importing, exporting, enabling, or disabling data domains (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Importing, exporting, enabling, or disabling data domains (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) You can import, export, enable, and disable data domains. (shortdesc] (topicmeta][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Exporting and importing a data domain (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Exporting and importing a data domain (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Exporting a data domain takes a snapshot of the data domain's index files, which is useful for backups. Importing a data domain lets you create a new data domain based on an exported index. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Enabling a data domain (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Enabling a data domain (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Enabling a data domain is a means of starting all Dgraph processes serving this data domain. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Disabling a data domain (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Disabling a data domain (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Disabling a data domain is a means of stopping the data domain nodes (the Dgraph processes) serving this data domain. (shortdesc] (topicmeta] (topicref] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Monitoring and backing up data domains (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Monitoring and backing up data domains (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) You can list data domains, their host names and ports, monitor their status, and obtain information about the data domain's index, number of records, and other statistics. You can also back up an index file for a running data domain. (shortdesc] (topicmeta][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Obtaining information about data domains (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Obtaining information about data domains (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) You can list one or more data domains using endeca-cmd list-dd, or the operations from the Manage Web Service. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Monitoring the data domain health (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Monitoring the data domain health (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Use the endeca-cmd get-dd-health to check the health of the data domain and list the status of the Dgraph nodes, including details about each Dgraph process that is not running. Alternatively, you can use the getDataDomainHealth request of the Cluster Web Service. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Checking the status of the data domain nodes (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Checking the status of the data domain nodes (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) A quick way of checking the health of a Dgraph node in the data domain is to get its status from the Endeca Server. Use the endeca-cmd get-dd-status command, or the getDataDomainStats from the Manage Web Service, to obtain information about the size of the data domain's index, the number of indexed records, and the Dgraph statistics page. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Backing up the index (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Backing up the index (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) To back up a data domain's index, take a snapshot of the index files by exporting them. You can later restore the index to this particular state. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Collecting debugging information (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Collecting debugging information (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Before attempting to debug an issue with the data domain, collect the following information. (shortdesc] (topicmeta] (topicref] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Other tasks and characteristics of data domains (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Other tasks and characteristics of data domains (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) You can issue cache warming operations to the data domain's Dgraph processes, and configure session affinity for data domains. You can also learn how to connect to the data domains, how to load data, and how different types of data domains behave, such as read-only, idle, or oversubscribed data domains. (shortdesc] (topicmeta][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Endeca Server memory consumption (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Endeca Server memory consumption (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The Endeca Server query performance is dependent on many characteristics of your specific deployment, such as query workload, query complexity, data domain configuration, and the characteristics of the loaded records, as well as the size of the data domain's index. In view of these characteristics, a hardware sizing must be performed prior to deployment, to assess memory consumption and other hardware needs of your deployment. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) About using control groups (cgroups) for data domains (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) About using control groups (cgroups) for data domains (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) On Oracle Enterprise Linux 6 (Red Hat Enterprise Linux Server release 6), Endeca Server has a new option to use cgroups to limit the total memory usage of Dgraph processes hosted on the machine. Control groups (also known as cgroups) is a kernel resource-controlling feature of the Linux 6 operating system. They provide a way to define and allocate the system resources to one or more specific processes, while controlling, at a high-level, the utilization of these resources, and ensuring that the processes do not consume excessive resources. In this way, cgroups help avoid situations where the hosting machines run out of memory for their functioning and are forced to shut down due to their hosted applications taking over all available resources on the machine. (shortdesc] (topicmeta][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Enabling cgroups for the data domain (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Enabling cgroups for the data domain (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) If the Endeca Server is deployed on Linux 6, you can enable utilization of cgroups for the Endeca Server application and its processes, by making the required changes in the EndecaServer.properties configuration file, on each Endeca Server node hosting a data domain, and then running the specially-provided setup_cgroups.sh script located in $DOMAIN_HOME/EndecaServer/bin directory of your Endeca Server deployment. (shortdesc] (topicmeta] (topicref] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Read-only data domains (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Read-only data domains (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) When defining a data domain profile, you can specify whether the data domain should be created as read-only. Having a read-only data domain is useful in the development environment or for demonstration purposes — a read-only data domain does not allow changes to its index, but lets the application users issue read-type queries, such as regular search and navigation queries. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Auto-idling and oversubscribing behavior of data domains (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Auto-idling and oversubscribing behavior of data domains (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Data domain profiles define two important aspects of data domain behavior — automatic idling and oversubscribing. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Issuing cache warming requests to the Dgraph (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Issuing cache warming requests to the Dgraph (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) In a running data domain, you can issue a request to warm up the cache of its Dgraph processes. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Configuring session affinity for data domains (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Configuring session affinity for data domains (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) When receiving client requests, the Endeca Server cluster routes them to the arbitrary Endeca Server nodes hosting the appropriate data domains. Optionally, you can configure your data domain profile to utilize session affinity for request routing. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) About connecting Web browsers to data domains (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) About connecting Web browsers to data domains (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) For security reasons, you should never allow user Web browsers to connect directly to the machine hosting the Endeca Server and the Endeca data domains. (shortdesc] (topicmeta] (topicref] (topicref] (topicref] (map]