Getting Started

Follow these steps to deploy an application to the dev zone in the Vespa Cloud. Find more details and tips in the developer guide. Alternative versions of this guide:

• Getting started, without Vespa CLI
• Getting started, with an app having Java components
• Getting started, using pyvespa - for Python developers
• Run Vespa locally, using Docker.

1. Install the Vespa CLI using Homebrew:

   $ brew install vespa-cli
   

2. Create a tenant in the Vespa Cloud:

   Create a tenant at console.vespa-cloud.com (unless you already have one). This requires a Google or GitHub account, and will start your free trial.

3. Configure the Vespa client:

   $ vespa config set target cloud && \
     vespa config set application tenant-name.myapp
   

   $ export VESPA_CLI_HOME=$PWD/.vespa TMPDIR=$PWD/.tmp
   $ mkdir -p $TMPDIR
   $ vespa config set target cloud
   $ vespa config set application vespa-team.album-rec-java
   

   Use the tenant name from step 2. This guide uses myapp as application name and default as instance name - learn more.

4. Authorize Vespa Cloud access:

   $ vespa auth login
   

   $ export VESPA_CLI_API_KEY="$(echo "$VESPA_TEAM_API_KEY" | openssl base64 -A -a -d)"
   

   Follow the instructions from the command to authenticate.

5. Get a sample application:

   $ vespa clone album-recommendation myapp && cd myapp
   

   An application package is the full application configuration. See sample-apps for other sample apps you can clone instead.

6. Add public certificate:

   $ vespa auth cert
   

   This creates a self-signed certificate for data plane access (reads and writes), and adds it to the application package. See the security model for details.

7. Deploy the application:

   $ vespa deploy --wait 600
   

   The first deployment will take a few minutes while nodes are provisioned. Subsequent deployments on existing nodes will be quicker.

8. Feed documents:

   $ vespa feed ext/documents.jsonl
   

9. Run queries:

   $ vespa query "select * from music where album contains 'head'"
   

   $ vespa query \
     "select * from music where true" \
     "ranking=rank_albums" \
     "ranking.features.query(user_profile)={{cat:pop}:0.8,{cat:rock}:0.2,{cat:jazz}:0.1}"
   

   These requests use the Query API.

Next steps

• Set up deployment to production.
• Follow the Vespa Blog for product updates and use cases.
• Explore the Vespa documentation.