Operate Fredhopper using Deployment Package

This page is a short overview of the available commands in the Fredhopper Deployment Package.

Make sure to review the documentation for these commands before executing them.

To run any of the commands be sure to login as user fredhopper and be sure to be in the user fredhopper home directory.

	Operation	Action(s)	Notes
Deployment Agent	Start	Execute bin/deployment-agent	The Deployment Agent will start in the current terminal or console window. The agent should always be started as a system service, see also instructions for Linux and Windows
	Stop	Execute bin/deployment-agent-client stop-agent	The agent will refuse to stop if any processes are still running. The --force switch can be used to force stopping of those processes.
	Verify	Execute bin/deployment-agent-client info	Information over the current deployment agent version is printed to the current window.
Instances	Start configured instance	Execute bin/instance <INSTANCE> start	Start the given instance based on information from config/topology.txt. The instance can be on any host.
	Stop a configured instance	Execute bin/instance <INSTANCE> stop	Start the given instance based on information from config/topology.txt. The instance can be on any host.
	Remove an instance	remove configuration entry from config/topology.txt Execute bin/deployment-agent-client --location <HOST> remove --force <INSTANCE> to remove permanently from <HOST>
	Add new live instance	Follow Add a new query instance to an installation
ETL	Convert CSV into FAS XML	Execute bin/run-etl-job run.kjb "-DINSTANCE=<INSTANCE>" "-DTRIGGER=load-data"	This will convert the source data from the <INSTANCE>/data/baseline directory into FAS XML and write it into the <INSTANCE>/data/fas-xml/<UNIVERSE> directories. The actual command may differ depending on the environment and the data sources.
	Convert CSV into incremental FAS XML & apply incremental updates	Execute bin/run-etl-job run-incremental.kjb "-DINSTANCE=<INSTANCE>" "-DTRIGGER=load-data"	This will convert the source data from the <INSTANCE>/data/incremental directory into FAS XML, write it into the <INSTANCE>/data/fas-xml-incremental/<UNIVERSE> directories and then move them to the directory of the running instance The actual command may differ depending on the environment and the data sources.
Indexing	Reindex	Execute bin/reindex <INSTANCE>	The existing index on the Business Manager will be recreated from the FAS XML stored in the <INSTANCE>/data/fas-xml/<UNIVERSE> directories. The Business Manager will be restarted, and publication will be impossible until the index is published using bin/fresh-index-to-live <INSTANCE>
	Check current index	bin/chk-valid-index <INSTANCE>	Checks the index of the given <INSTANCE> and all its sub indexes against minimal number of items configured with the MINITEMS setting in config/fasrc
	Publish index and configuration	bin/fresh-index-to-live <INSTANCE>	All configured live servers are updated with the current index and configuration. The <INSTANCE> should be the name of the indexer instance. Be sure to first publish the config via the Business Manager
	Manually remove an index (wipeindex)	Ensure that the instance is stopped Execute bin/deployment-agent-client --location <HOST> delete --instance <INSTANCE> data/indices	This command removes the FAS index from the given instance.
Captures	Import a capture	Execute bin/capture-import <INSTANCE> path/to/capture.zip	This command overwrites the existing index and/or configuration with the index and/or configuration from the capture.
	Export a capture	Execute bin/capture-export <INSTANCE> path/to/output.zip <OPTIONS>	A capture is written into the provided output file. The options define which parts of the instance to export, by default the configuration, log files, and index are exported. Option Meaning -c Export configuration -i Export index -l Export log files -x Export processed FAS XML
Cleanup	Remove old files	bin/cleanup	(Linux Only) Removes old log files and temporary files from all instances on the host. This command should typically be executed from cron(1) each day
System Configuration	Process Memory Assignment	Execute bin/deployment-agent-client --location <HOST> set-option <INSTANCE> <PROCESS>_memory=<MEMORY>	Changes the assigned memory for the process of the instance persistently. The setting will be effective after the next restart of the process. This command can be used to change the memory assignment also for the ETL and deployment processes, by using the etl and deployment instance and the kitchen and pan process names.
	Java Home Directory	Execute bin/deployment-agent-client --location <HOST> set-option <INSTANCE> javahome=<JAVA_HOME PATH>	Sets the Java to use for running processes of the given instance.
	Java Options	See how to change java options	Edit the options used for running Java.
Other JVM Controls	Get Stack Traces/Thread Dump	Execute jstack <Process ID>	Prints the current thread dump from the process to the console. Windows On Windows this command may fail to get the stack traces of a processes running in a different user session or as a service.
	List running java processes	Execute jps -v	Lists the currently running java processes. Windows On Windows this command may fail to list processes that are running in a different user session or as a service.