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
  • 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
  • task list
  • task cancel
  • task inspect
  • 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
Type '/' to Search

»Waypoint Runner agent

Command: waypoint runner agent

Run a runner for executing remote operations.

»Usage

Usage: waypoint runner agent [options]

Run a remote runner for executing remote operations.

Runners are named or identified via the ID and the label set. The ID can be manually specified or automatically generated. The label set is specified using "-label" flags.

A runner can be registered with the server in two ways. First, a runner token can be created with "waypoint runner token" and used with this command (using the WAYPOINT_SERVER_TOKEN environment variable, "waypoint context", etc.). This will allow the runner to begin accepting jobs immediately since it is preauthorized.

The second approach is to specify only the cookie value (acquired using the "waypoint server cookie" command) and the server address. This will trigger a process that puts the runner in a pending state until a human manually verifies it. This is useful for easily installing runners.

The "-state-dir" flag is optional, but important. This flag allows runners to restart gracefully without regenerating a new ID or losing a rotated authentication token. Runners can be run without a state directory but it is not generally recommended.

»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

  • -enable-dynamic-config - Allow dynamic config to be created when an exec plugin is used.
  • -liveness-tcp-addr=<string> - If this is set, the runner will open a TCP listener on this address when it is running. This can be used as a liveness probe endpoint. The TCP server serves no other purpose.
  • -id=<string> - If this is set, the runner will use the specified id.
  • -cookie=<string> - The cookie value of the server to validate API requests. This is required for runner adoption. If you do not already have a runner token, this must be set.
  • -state-dir=<string> - Directory to store state between restarts. This is optional. If this is set, then a runner can restart without re-triggering the adoption process.
  • -label=<key=value> - Labels to set for this runner in 'k=v' format. Can be specified multiple times.
  • -concurrency=<int> - The number of concurrent jobs that can be running at one time. This has no effect if -odr is set. A value of less than 1 will default to 1.
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