June 20-22 Announcing HashiConf Europe full schedule: keynotes, sessions, labs & more Register Now
  • 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
    • Overview
      • Overview
      • Helm
      • Heroku, Vercel, etc.
      • Kubernetes
  • Getting Started
    • Overview
    • Compatibility Promise
    • Protocol Version Table
    • Release Notifications
      • Overview
      • Upgrade to 0.2.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
      • 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
Type '/' to Search

»Additional Runners

The waypoint install command installs and manages a single Waypoint runner. Waypoint supports any number of additional runners. Additional runners must be run manually today. A future version of Waypoint will introduce more automated management for additional runners.

»Manually Running a Runner

The instructions below are only if you're installing additional runners manually. waypoint install automatically installs a single runner and you don't need to manually add any additional runners until the load requires it.

To run a runner, use the waypoint runner agent command:

$ WAYPOINT_SERVER_ADDR=<server addr> \
  WAYPOINT_SERVER_TLS=true \
  WAYPOINT_SERVER_TOKEN=<auth token> \
  waypoint runner agent


» Runner configuration:
  Server address: waypoint.example.com:9701

» Runner logs:

...
$ WAYPOINT_SERVER_ADDR=<server addr> \
  WAYPOINT_SERVER_TLS=true \
  WAYPOINT_SERVER_TOKEN=<auth token> \
  waypoint runner agent


» Runner configuration:
  Server address: waypoint.example.com:9701

» Runner logs:

...

The environment variables specify how to connect to the server:

  • WAYPOINT_SERVER_ADDR should be the address to the Waypoint server that the runner can reach. The port should be for the gRPC API, and is typically 9701.

  • WAYPOINT_SERVER_TLS should be set to a truthy value (e.g. "1") if the server is listening on TLS.

  • WAYPOINT_SERVER_TLS_SKIP_VERIFY should be set to a truthy value (e.g. "1") if the TLS cert is invalid and can be safely ignored, such as in a development environment.

  • WAYPOINT_SERVER_TOKEN should be an auth token the runner can use to communicate to the server. You can generate a new auth token using waypoint user token.

If the runner process remains running and doesn't show any errors, the runner is now registered with the server and can now be used.

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