README
¶
Waypoint
- Website: https://www.waypointproject.io
- Tutorials: HashiCorp Learn
- Forum: Discuss
Waypoint allows developers to define their application build, deploy, and release lifecycle as code, reducing the time to deliver deployments through a consistent and repeatable workflow.
Waypoint supports a number of build methods and target platforms out of the box and more can be easily added via plugins:
- Cloud Native Buildpacks
- Docker
- Kubernetes
- AWS EC2 and ECS
- Azure Container Instances
- Google Cloud Run
- Netlify
- And many more...
Waypoint runs on Linux, Mac OS X, and Windows.
Please note: We take Waypoint's security and our users' trust very seriously. If you believe you have found a security issue in Waypoint, please responsibly disclose by contacting us at security@hashicorp.com.
Quick Start
A few quick start guides are available on the Waypoint website and on HashiCorp Learn:
- Getting Started
- Introduction
- Installation
- Docker
- Kubernetes
- Nomad
- Waypoint UI
- AWS ECS
- Azure Container Instance
- Google Cloud Run
Documentation
Full, comprehensive documentation is available on the Waypoint website:
https://www.waypointproject.io/docs
Contributing
Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance.
Directories
¶
| Path | Synopsis |
|---|---|
|
builtin
|
|
|
azure/aci
Package aci contains components for deploying to Azure ACI.
|
Package aci contains components for deploying to Azure ACI. |
|
files
Package files contains a component for validating local files.
|
Package files contains a component for validating local files. |
|
google/cloudrun
Package cloudrun contains components for deploying to Google Cloud Run.
|
Package cloudrun contains components for deploying to Google Cloud Run. |
|
k8s
Package k8s contains components for deploying to Kubernetes.
|
Package k8s contains components for deploying to Kubernetes. |
|
netlify
Package netlify contains components for deploying to Netlify.
|
Package netlify contains components for deploying to Netlify. |
|
cmd
|
|
|
internal
|
|
|
ceb
Package ceb contains the core logic for the custom entrypoint binary ("ceb").
|
Package ceb contains the core logic for the custom entrypoint binary ("ceb"). |
|
client
Package client contains the Waypoint client implementation.
|
Package client contains the Waypoint client implementation. |
|
config
Package config is the configuration structure and related functions.
|
Package config is the configuration structure and related functions. |
|
core
Package core exposes a high-level API for the expected operations of the project.
|
Package core exposes a high-level API for the expected operations of the project. |
|
datasource
Package datasource has the packages and logic that Waypoint uses for sourcing data for remote runs.
|
Package datasource has the packages and logic that Waypoint uses for sourcing data for remote runs. |
|
factory
Package factory contains a "factory" pattern based on argmapper.
|
Package factory contains a "factory" pattern based on argmapper. |
|
pkg/circbufsync
Package circbufsync wraps armon/circbuf to be safe for concurrent read/write operations.
|
Package circbufsync wraps armon/circbuf to be safe for concurrent read/write operations. |
|
pkg/finalcontext
Package finalcontext is used by Waypoint to create a "final" context that we'll use after the real context has been cancelled.
|
Package finalcontext is used by Waypoint to create a "final" context that we'll use after the real context has been cancelled. |
|
pkg/flag
Package flag is a thin layer over the stdlib flag package that provides some minimal features such as aliasing, autocompletion handling, improved defaults, etc.
|
Package flag is a thin layer over the stdlib flag package that provides some minimal features such as aliasing, autocompletion handling, improved defaults, etc. |
|
pkg/iosync
Package iosync provides reader/writer implementations that wrap operations in a mutex so that concurrent reads and writes are safe.
|
Package iosync provides reader/writer implementations that wrap operations in a mutex so that concurrent reads and writes are safe. |
|
pkg/spinner
Package spinner is a simple package to add a spinner / progress indicator to any terminal application.
|
Package spinner is a simple package to add a spinner / progress indicator to any terminal application. |
|
pkg/spinner/_example
Example application that uses all of the available API options.
|
Example application that uses all of the available API options. |
|
plugin
Package plugin has the functions necessary for discovering and launching plugins.
|
Package plugin has the functions necessary for discovering and launching plugins. |
|
server/component
Package component has component implementations for the various resulting types.
|
Package component has component implementations for the various resulting types. |
|
server/logbuffer
Package logbuffer provides a structure and API for efficiently reading and writing logs that may be streamed to a server.
|
Package logbuffer provides a structure and API for efficiently reading and writing logs that may be streamed to a server. |
|
server/singleprocess/state
Package state manages the state that the singleprocess server has, providing operations to mutate that state safely as needed.
|
Package state manages the state that the singleprocess server has, providing operations to mutate that state safely as needed. |
|
serverclient
Package serverclient contains helpers for the server API client.
|
Package serverclient contains helpers for the server API client. |
|
serverinstall/datagen
Package datagen Code generated by go-bindata.
|
Package datagen Code generated by go-bindata. |
|
test-apps
|
|
|
aci
Module
|
|
|
tools
|
|
|
x
|
|
Click to show internal directories.
Click to hide internal directories.