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
  • build
  • deploy
  • destroy
  • exec
  • init
  • install
  • login
  • logs
  • release
  • ui
  • up

  • artifact build
  • artifact list-builds
  • artifact list
  • artifact push
  • auth-method list
  • auth-method inspect
  • auth-method set oidc
  • auth-method delete
  • config get
  • config set
  • config source-get
  • config source-set
  • config sync
  • context
  • context clear
  • context create
  • context delete
  • context inspect
  • context list
  • context rename
  • context use
  • context verify
  • context set
  • deployment deploy
  • deployment destroy
  • deployment list
  • docs
  • fmt
  • hostname delete
  • hostname list
  • hostname register
  • job list
  • job inspect
  • job cancel
  • job get-stream
  • plugin
  • project apply
  • project inspect
  • project list
  • release list
  • runner agent
  • runner list
  • runner inspect
  • runner adopt
  • runner forget
  • runner reject
  • runner token
  • runner profile list
  • runner profile inspect
  • runner profile set
  • server bootstrap
  • server cookie
  • server config-set
  • server install
  • server restore
  • server run
  • server snapshot
  • server uninstall
  • server upgrade
  • status
  • trigger create
  • trigger update
  • trigger delete
  • trigger inspect
  • trigger list
  • user inspect
  • user invite
  • user modify
  • user token
  • version
  • workspace create
  • workspace inspect
  • workspace list

  • k8s bootstrap
  • token exchange
  • token invite
  • token new

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

Type '/' to Search

»Waypoint Server upgrade

Command: waypoint server upgrade

Upgrades Waypoint server in the current context to the latest version

»Usage

Usage: waypoint server upgrade [options]

Upgrade Waypoint server in the current context to the latest version or the server image version specified. By default, Waypoint will upgrade to server version "hashicorp/waypoint:latest". Before upgrading, a snapshot of the server will be taken in case of any upgrade failures.

If a runner was installed via "waypoint install" then that runner will also be upgraded to the latest version after the server is upgraded. Any other manually installed runners will not be automatically upgraded.

»Global Options

  • -plain - Plain output: no colors, no animation.
  • -app=<string> (-a) - App to target. Certain commands require a single app target for Waypoint configurations with multiple apps. If you have a single app, then this can be ignored.
  • -project=<string> (-p) - Project to target.
  • -workspace=<string> (-w) - Workspace to operate in.

»Command Options

  • -auto-approve - Confirm server upgrade.
  • -context-name=<string> - Waypoint server context to upgrade.
  • -platform=<string> - Platform to upgrade the Waypoint server from, defaults to the platform stored in the context.
  • -snapshot-name=<string> - Filename to write the snapshot to. If no name is specified, by default a timestamp will be appended to the default snapshot name.
  • -snapshot - Enable or disable taking a snapshot of Waypoint server prior to upgrades.

»docker Options

  • -docker-server-image=<string> - Docker image for the Waypoint server.
  • -docker-odr-image=<string> - Docker image for the Waypoint On-Demand Runners. This will default to the server image with the name (not label) suffixed with '-odr'.

»ecs Options

  • -ecs-cluster=<string> - Configures the Cluster to upgrade.
  • -ecs-server-image=<string> - Docker image for the Waypoint server.
  • -ecs-region=<string> - Configures which AWS region to install into.
  • -ecs-cpu=<string> - Configures the requested CPU amount for the Waypoint server task in ECS.
  • -ecs-mem=<string> - Configures the requested memory amount for the Waypoint server task in ECS.
  • -ecs-odr-image=<string> - Docker image for the Waypoint On-Demand Runners. This will default to the server image with the name (not label) suffixed with '-odr'.
  • -ecs-task-role-name=<string> - IAM Execution Role to assign to the on-demand runner. If this is blank, an IAM role will be created automatically with the default permissions.
  • -ecs-odr-mem=<string> - Configures the requested memory amount for the Waypoint On-Demand runner in ECS.
  • -ecs-odr-cpu=<string> - Configures the requested CPU amount for the Waypoint On-Demand runner in ECS.

»kubernetes Options

  • -k8s-advertise-internal - Advertise the internal service address rather than the external. This is useful if all your deployments will be able to access the private service address. This will default to false but will be automatically set to true if the external host is detected to be localhost.
  • -k8s-context=<string> - The Kubernetes context to upgrade the Waypoint server to. If left unset, Waypoint will use the current Kubernetes context.
  • -k8s-namespace=<string> - Namespace to install the Waypoint server into for Kubernetes.
  • -k8s-openshift - Enables installing the Waypoint server on Kubernetes on Red Hat OpenShift. If set, auto-configures the installation.
  • -k8s-server-image=<string> - Docker image for the Waypoint server.
  • -k8s-odr-image=<string> - Docker image for the Waypoint On-Demand Runners
  • -k8s-runner-service-account=<string> - Service account to assign to the on-demand runner. If this is blank, a service account will be created automatically with the correct permissions.
  • -k8s-runner-service-account-init - Create the service account if it does not exist.

»nomad Options

  • -nomad-annotate-service=<key=value> - Annotations for the Service generated.
  • -nomad-auth-soft-fail - Don't fail the Nomad task on an auth failure obtaining server image container. Attempt to continue without auth.
  • -nomad-dc=<string> - Datacenters to install to for Nomad.
  • -nomad-host=<string> - Hostname of the Nomad server to use, like for launching on-demand tasks.
  • -nomad-namespace=<string> - Namespace to install the Waypoint server into for Nomad.
  • -nomad-odr-image=<string> - Docker image for the on-demand runners. If not specified, it defaults to the server image name + '-odr' (i.e. 'hashicorp/waypoint-odr:latest')
  • -nomad-policy-override - Override the Nomad sentinel policy for enterprise Nomad.
  • -nomad-region=<string> - Region to install to for Nomad.
  • -nomad-server-cpu=<string> - CPU required to run this task in MHz.
  • -nomad-server-memory=<string> - MB of Memory to allocate to the server job task.
  • -nomad-runner-cpu=<string> - CPU required to run this task in MHz.
  • -nomad-runner-memory=<string> - MB of Memory to allocate to the runner job task.
  • -nomad-server-image=<string> - Docker image for the Waypoint server.
  • -nomad-host-volume=<string> - Nomad host volume name.
  • -nomad-consul-service - Create service for Waypoint UI and Server in Consul.
  • -nomad-consul-service-hostname=<string> - If set, will use this hostname for Consul DNS rather than the default, i.e. "waypoint-server.service.consul".
  • -nomad-consul-service-ui-tags=<string> - Tags for the Waypoint UI service generated in Consul.
  • -nomad-consul-service-backend-tags=<string> - Tags for the Waypoint backend service generated in Consul. The 'first' tag will be used when crafting the Consul DNS hostname for accessing Waypoint.
  • -nomad-consul-datacenter=<string> - The datacenter where Consul is located.
  • -nomad-consul-domain=<string> - The domain where Consul is located.
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