Files, processes and ports

This is a reference of directories used in a Vespa installation, processes that run on the Vespa nodes and ports used. Also see log files.

Directories

DirectoryDescription
$VESPA_HOME/bin/ Command line utilities and scripts
$VESPA_HOME/sbin/ Server programs, daemons, etc
$VESPA_HOME/lib64/ Dynamically linked libraries, typically third-party libraries
$VESPA_HOME/lib/jars/ Java archives
$VESPA_HOME/logs/vespa/ Log files
$VESPA_HOME/var/cache/vespa/config Disk cache for config proxy (only used when config proxy is in diskcache mode)
$VESPA_HOME/var/db/vespa/config_server/serverdb/ Config server database and user applications
$VESPA_HOME/share/vespa/ A directory with sample applications and XML schemas for application package validation
$VESPA_HOME/conf/vespa Various config files used by Vespa or libraries Vespa depend on

Processes and ports

The following is an overview of which ports and port ranges are used by the different services in a Vespa system. Note that for services capable of running multiple instances on the same node, all instances will run within the listed port range.

Many services are allocated ports dynamically. So even though the allocation is deterministic, i.e. the same system will get the same ports on subsequent startups, a particular service instance may get different ports when the overall system setup is changed through services.xml. Use vespa-model-inspect to see port allocations.

  • The number of ports used in a range depends on number of instances that are running
  • Not all ports within a range are used, but they are assigned each service to support future extensions
  • The range from 19100 is used for internal communication ports, i.e. ports that are not necessary to use from an external API
  • See Configuring Http Servers and Filters for how to configure Container ports and services.xml for how to configure other ports
ProcessHostPort/rangepsFunction
Config server Config server nodes 19070 - 19071 java (...) -jar $VESPA_HOME/lib/jars/standalone-container-jar-with-dependencies.jar Vespa Configuration server
Config sentinel All nodes 19098 $VESPA_HOME/sbin/vespa-config-sentinel Sentinel that starts and stops vespa services and makes sure they are running unless they are manually stopped
Config proxy All nodes 19090 java (…) com.yahoo.vespa.config.proxy.ProxyServer Communication liaison between Vespa processes and config server. Caches config in memory
File distribution All nodes 19092 - 19093 $VESPA_HOME/sbin/vespa-filedistributor-bin File distribution process for distributing bundles to e.g. containers
Slobrok Admin nodes dynamically allocated in 19000 - 19899 range $VESPA_HOME/sbin/vespa-slobrok Service location object broker.
logd All nodes $VESPA_HOME/sbin/vespa-logd Reads local log files and sends them to log server
Log server Log server node 19081 and 19083 java (...) -jar lib/jars/logserver-jar-with-dependencies.jar Vespa Log server
Distributor Content cluster dynamically allocated in 19100 - 19899 range $VESPA_HOME/sbin/vespa-distributord-bin Content layer distributor processes
Cluster controller Content cluster dynamically allocated in 19100 - 19899 range java (...) -jar $VESPA_HOME/lib/jars/container-disc-jar-with-dependencies.jar Cluster controller processes, manages state for content nodes
Dispatch Content cluster dynamically allocated in 19100 - 19899 range $VESPA_HOME/sbin/vespa-dispatch-bin Dispatcher, communicates between container and content nodes. Can be multi-level in a hierarchy
proton Content cluster dynamically allocated in 19100 - 19899 range $VESPA_HOME/sbin/vespa-proton-bin Searchnode process, receives queries from the dispatcher and returns results from the indexes. Also receives feed and indexes documents
container Container cluster 8080 java (...) -jar $VESPA_HOME/lib/jars/container-disc-with-dependencies.jar Container running servers, handlers and processing components

Vespa start / stop

Start and stop all services on a node:

$ $VESPA_HOME/bin/vespa-start-services
$ $VESPA_HOME/bin/vespa-stop-services
Likewise, for the config server:
$ $VESPA_HOME/bin/vespa-start-configserver
$ $VESPA_HOME/bin/vespa-stop-configserver
Learn more about which processes are run at Vespa startup.

Pre-start check

To run an automated node check before Vespa is started, provide a check script, returning 0 if service vespa-services start is allowed to run. This is useful when autostarting:

$ export VESPA_VALIDATIONSCRIPT=/tmp/foo.bar.sh
$ cat /tmp/foo.bar.sh
#!/bin/sh
echo detect some problem
exit 1
$ $VESPA_HOME/bin/vespa-start-services
... starting ...
detect some problem
validation script '/tmp/foo.bar.sh' failed
$VESPA_HOME/bin/vespa-start-services failed: exit code 1 from command:
$VESPA_HOME/libexec/vespa/start-vespa-base.sh