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

»Waypoint Documentation

Learn and develop your knowledge of Waypoint with these tutorials and code resources.

»Getting Started

  • Begin with this brief quick start tutorial.
  • Continue with an introductory tutorial on Docker, Kubernetes, or Nomad.

»Deploying to the Cloud

Take Waypoint to the cloud with tutorials that deploy to public cloud infrastructure.

  • AWS - Visit the Elastic Container Service tutorial or the Elastic Kubernetes Service tabs in the Kubernetes tutorial.
  • Azure - Deploy to Azure Container Instances.
  • Google Cloud - Learn from the Google Cloud Run tutorial or the Google Kubernetes Engine tabs in the Kubernetes tutorial.

»Running Code Samples

A growing number of code samples is available in the hashicorp/waypoint-examples repository at GitHub. Use these examples or contribute your own.

git clone https://github.com/hashicorp/waypoint-examples.git
git clone https://github.com/hashicorp/waypoint-examples.git

»contrib Tools and Helpers

Some services and tools that Waypoint use involve some additional setup to run and manage locally.

The contrib folder aims to help users reduce friction around getting started using these tools locally to explore Waypoint. You can find these optional tools and content on the Waypoint GitHub repository.

An example of this is leveraging kind to setup a local kubernetnes cluster to install Waypoint server: kind+k8s.

Don't see a tool here that you need to get started? Feel free to open a new enhancement request issue on GitHub, or contribute your own!

»Extending

The plugin documentation describes more resources available to use in your Waypoint configuration. Contribute by writing your own plugin with this plugin tutorial.

Integrate Waypoint into your continuous delivery workflow with examples for GitHub Actions, GitLab CI/CD, CircleCI, or Jenkins.

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