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, and see next steps for self-hosted deployment options. Alternative versions of this guide:



  1. Install the Vespa client:

    Using Homebrew:

    $ brew install vespa-cli
    

    Alternatively, download it for Windows, Linux and macOS.

  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. Make note of the tenant name, it is used in the next steps.

  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 a full list.

  6. Add public certificate:

    $ vespa auth cert
    

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

  7. Deploy the application:

    $ vespa deploy --wait 600
    

    The first deployment will take a few minutes while nodes are provisioned - track progress using the link in the response. 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.

You have now completed a successful deployment to the dev environment! Find next steps and troubleshooting below.

Deploy sample applications

Vespa sample applications is a repository of applications that can be deployed on a local machine or in Vespa Cloud. These are great resources to get more familiar with Vespa. To deploy using Vespa Cloud, run the following steps instead:

  1. Get the application (using one of these):
    $ git clone --depth 1 https://github.com/vespa-engine/sample-apps.git && \
      cd sample-apps/the-sample-application
    
    $ vespa clone the-sample-application myapp && \
      cd myapp
    
  2. Where the README says vespa deploy, do this instead, using your own tenant name:
    $ vespa config set target cloud && \
      vespa config set application tenant-name.myapp
    $ vespa auth login
    $ vespa auth cert
    $ vespa deploy --wait 600
    

Next steps

Notes