New Interested in participating in the HCP Waypoint Private Beta Program? Apply here
  • Infrastructure
    • terraform
    • packer
  • Networking
    • consul
  • Security
    • vault
    • boundary
  • Applications
    • nomad
    • waypoint
    • vagrant
  • HashiCorp Cloud Platform

    A fully managed platform to automate infrastructure on any cloud with HashiCorp products.

    • consul
    • terraform
    • vault
    • packerbeta
    Visit cloud.hashicorp.com
  • Overview
  • Tutorials
  • Docs
  • CLI
  • Plugins
  • Community
GitHub
Download
    • v0.8.x (latest)
    • v0.7.x
    • v0.6.x
    • v0.5.x
    • v0.4.x
    • v0.3.x
    • v0.2.x
    • v0.1.x
    • Overview
      • Overview
      • Helm
      • Heroku, Vercel, etc.
      • Kubernetes
  • Getting Started
    • Overview
    • Compatibility Promise
    • Protocol Version Table
    • Release Notifications
      • Overview
      • Upgrade to 0.2.0
      • Upgrade to 0.3.0
      • Upgrade to 0.4.0
      • Upgrade to 0.5.0
      • Upgrade to 0.6.0
      • Upgrade to 0.7.0
      • Upgrade to 0.8.0

    • Install
    • Externally Built Images
    • Building Container Images
    • Helm Deployment
    • YAML-Free Deployment
    • YAML Directory Deployment
    • Resource Status
    • ConfigMaps and Secrets

    • Overview
    • Git Integration
    • Remote Operations
    • Overview
    • Build
    • Deploy
    • Release
    • Hooks
    • Labels
    • Workspace and Label Scoping
    • Overview
      • Overview
      • Input Variables
      • External Data
      • artifact
      • deploy
      • entrypoint
      • labels
      • path
      • workspace
      • Overview
      • Full Reference
      • Templating
      • Overview
      • Expressions
      • JSON Syntax
    • app
    • build
    • config
    • deploy
    • hook
    • plugin
    • registry
    • release
    • runner
    • url
    • use
    • variable
  • URL Service
  • Logs
  • Exec
    • Overview
    • Dynamic Values
    • Files
    • Internal Values
    • Workspace and Label Scoping
    • Overview
      • Overview
      • OIDC
      • Overview
      • Maintenance
      • Production
      • Security
    • Express Server Install
    • Overview
    • Configuration
    • Profiles
    • On-Demand Runner
    • Additional Runners
  • Workspaces
  • Plugins
  • Triggers

    • Overview
      • Overview
      • Registering Plugin Components
      • Handling Configuration
      • Implementing the Builder Interface
      • Compiling the Plugin
      • Creating an Example Application
      • Testing the Plugin
    • Initializing the SDK
    • Passing Values Between Components
      • Overview
      • Authenticator
      • ConfigSourcer
      • Configurable
      • ConfigurableNotify
      • Builder
      • Registry
      • Platform
      • ReleaseManager
      • Destroy
      • Status
      • Default Parameters
      • Overview
    • Overview
    • Disable
    • Overview
    • GitHub Actions
    • GitLab CI/CD
    • CircleCI
    • Jenkins
  • Troubleshooting
  • Glossary

    • Overview
    • Architecture
    • Operation Execution
  • Roadmap

The Waypoint website is being redesigned to help you find what you are looking for more effectively.

Type '/' to Search

»Upgrading to Waypoint 0.3.0 from 0.2.x

Waypoint 0.2.x can be upgraded to Waypoint 0.3.0 using a standard upgrade.

»Breaking Changes

v0.3.0

  • ui: dropped support for Internet Explorer

v0.3.2

  • plugin/k8s: scratch_path now uses an array of strings instead of a string, allowing you to specify multiple directories to be mounted as emptyDir

»Other Considerations

»Server Image

waypoint install uses the hashicorp/waypoint:latest container image for Kubernetes, Nomad, and Docker. When upgrading, your platform may require you to pull the latest image instead of using a cache.

Kubernetes and Nomad both specify an "always pull" policy for :latest images so restarting the Deployment or Job should pull the latest released version. Docker may require an explicit docker pull and container recreate.

»Verifying the Server Version with the UI

You can verify the server version by loading the UI and looking at the footer. You should see a version starting with v0.3. If you see an earlier version, your platform may be using an old cached image.

»Verifying the Server Version with the CLI

For 0.3.1 and forward, you can verify both the CLI version and server version by running:

$ waypoint version
CLI: v0.3.1 (622f37bd1)
Server: v0.3.1
$ waypoint version
CLI: v0.3.1 (622f37bd1)
Server: v0.3.1

For 0.3.0, you can verify the server version using the following CLI command and inspecting the log output in the CLI. We didn't have a better way prior to v0.3.1 to describe the server version. Therefore, we try to exchange a purposely invalid token with the verbose flag (-v) in order to see the server version advertised.

$ ./waypoint token exchange abcd1234 -v
2020-12-10T10:48:33.951-0800 [INFO]  waypoint: waypoint version: full_string="Waypoint v0.3.0 (5db76632)" version=v0.3.0 prerelease= metadata= revision=5db76632
2020-12-10T10:48:33.951-0800 [INFO]  waypoint.server: attempting to source credentials and connect
2020-12-10T10:48:33.980-0800 [INFO]  waypoint: server version info: version=v0.3.0-177-ed413ab93 api_min=1 api_current=1 entrypoint_min=1 entrypoint_current=1
2020-12-10T10:48:33.980-0800 [INFO]  waypoint: negotiated api version: version=1
! An invite token is required.
  Run `waypoint token invite` to generate an invite token.
$ ./waypoint token exchange abcd1234 -v
2020-12-10T10:48:33.951-0800 [INFO]  waypoint: waypoint version: full_string="Waypoint v0.3.0 (5db76632)" version=v0.3.0 prerelease= metadata= revision=5db76632
2020-12-10T10:48:33.951-0800 [INFO]  waypoint.server: attempting to source credentials and connect
2020-12-10T10:48:33.980-0800 [INFO]  waypoint: server version info: version=v0.3.0-177-ed413ab93 api_min=1 api_current=1 entrypoint_min=1 entrypoint_current=1
2020-12-10T10:48:33.980-0800 [INFO]  waypoint: negotiated api version: version=1
! An invite token is required.
  Run `waypoint token invite` to generate an invite token.

In this output, find the line starting with server version info and verify that the version key has a version starting with v0.3. If it starts with an older version, your platform may be caching the Waypoint Docker image.

github logoEdit this page

Using Waypoint

The best way to understand what Waypoint can enable for your projects is to give it a try.

Waypoint tutorials
Waypoint documentation
Tutorial

Get Started - Kubernetes

Build, deploy, and release applications to a Kubernetes cluster.

View
Tutorial

Introduction to Waypoint

Waypoint enables you to publish any application to any platform with a single file and a single command.

View

Waypoint is maintained by HashiCorp, Inc.

View Code of Conduct
DocumentationCLI ReferenceTutorialsIntegrations
All systems normal