Application Package Reference
This is the application package reference. An application package is the deployment unit in Vespa. To deploy an application, create an application package and vespa-deploy or use the deploy API. The application package is a directory of files and subdirectories:
Directory/file | Required | Description |
---|---|---|
services.xml | Yes | Describes which services to run where, and their main configuration |
hosts.xml | No | The mapping from logical nodes to actual hosts |
validation-overrides.xml | No | Override, allowing this package to deploy even if it fails validation |
models/ | No | Machine-learned models in the application package. Refer to stateless model evaluation, Tensorflow, Onnx, XGBoost, and LightGBM, also see deploying remote models |
schemas/ | No | Contains the *.sd files describing the document types of the application and how they should be searched |
components/ | No | Contains *.jar files containing searcher(s) for the JDisc Container. |
rules/ | No | Contains *.sr files containing rule bases for semantic recognition and translation of the query |
search/ | No | Search chains config |
constants/ | No | Constant tensors |
ext/ | No | Files that are guaranteed to be ignored by Vespa (i.e. they will be excluded when processing the application package and cannot be referenced from any other place in the application package) |
Additional files and directories can be placed anywhere in the application package. These will be not be processed explicitly by Vespa when deploying the application package (i.e. they will only be considered if they are referred to from within the application package), but there is no guarantee to how these might be processed in a future release. To extend the application package in a way that is guaranteed to be ignored by Vespa in all future releases, use the ext/ directory.
An application package can be zipped for deployment:
$ zip -r ../app.zip .Use whatever name for the zip file - then refer to the file instead of the path in deploy commands - example. Note: Using
tar
/ gzip
is not supported.
Deploy
upload | Uploads an application package to the config server. Normally not used, as prepare includes upload |
---|---|
prepare |
|
activate |
|
fetch | Use fetch to download the active application package |
Versioning application packages
An application can be given a user-defined version, available at /ApplicationStatus. Configure the version in services.xml (at top level):
<services> <config name="container.handler.observability.application-userdata"> <version>42</version> </config> ... </services>
Preprocess directives
Use preprocess directives to:
- preprocess:properties: define properties that one can refer to everywhere in services.xml
- preprocess:include: split services.xml in smaller chunks
<services version="1.0" xmlns:preprocess="properties"> <preprocess:properties> <container.port>4099</container.port> </preprocess:properties> <container version="1.0"> <http> <server id="container" port="${container.port}" /> </http> <search /> </container> <preprocess:include file="content.xml" /> </services>Sample content.xml:
<content version="1.0" > <redundancy>1</redundancy> <documents> <document type="music.sd" mode="index" /> </documents> <nodes> <node hostalias="node0"/> <node hostalias="node1"/> <node hostalias="node2"/> </nodes> </content>