Waypoint Documentation

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

Fundamentals

What is HCP Waypoint?
HCP Waypoint lets platform teams define patterns to let developers deploy application infrastructure.
Templates
Templates define the infrastructure and configurations that developers need to create new projects.
Add-ons
Add-ons define infrastructure that developers can add to existing projects.

Templates

Managing templates
Templates consist of a published no-code module in Terraform Cloud and a template definition in HCP Waypoint.
Using templates
Developers create HCP Waypoint projects from templates and get pre-configured infrastructure for their applications.

Add-ons

Managing add-ons
Add-ons consist of a published no-code module in Terraform Cloud and an add-on definition in HCP Waypoint.
Using add-ons
Developers can install add-ons to their HCP Waypoint projects to gain additional application functionality by way of pre-configured infrastructure.

Administration

Role-based access control
Role-based access control lets you restrict access to specific HCP Waypoint functionality based on user roles.
Terraform Cloud integration
HCP Waypoint templates and add-on definitions leverage Terraform Cloud no-code modules to deploy their underlying infrastructure.

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

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 integration library 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.