Waypoint
Waypoint Home

Waypoint Documentation

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

Fundamentals

  • Quick Start
    It only takes a few minutes to get started with Waypoint on your local development environment.
  • App Lifecycle
    Waypoint has an opinionated view on the minimum application lifecycle: build, deploy, and release.
  • Projects
    A project contains one or more applications and each one in a project represents a single deployable object.
  • waypoint.hcl
    The waypoint.hcl file configures each Waypoint project and defines how Waypoint builds, deploys, and releases it.

Application Configuration

  • Overview
    Waypoint can configure your application by setting environment variables and writing files.
  • Dynamic Values
    Waypoint can sync app config values with external systems like Kubernetes ConfigMaps, HashiCorp Vault, and more.
  • Files
    Waypoint can write configs to files for apps that expect configurations at a certain path or in a certain format.

Debugging

  • Tips and Troubleshooting
    Common tips and troubleshooting methods.
  • Logs
    Waypoint app logs are aggregated and available to view via the CLI and UI.
  • Exec
    Waypoint enables you to execute commands in the context of a deployed application.

Highlighted Features

  • Waypoint URL Service
    The Waypoint URL service is a free, public service hosted by HashiCorp to view your deployed app.
  • Waypoint Runners
    Waypoint has three types of runners to execute every operation: CLI, remote, and on-demand.
  • Waypoint Triggers
    Trigger URLs are pre-configured Waypoint lifecycle operations for execution inside CI environments.

»Waypoint Documentation

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

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 git@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.