https://github.com/hashicorp/waypoint-plugin-examples
An example repository that demonstrates how to create and run an external Waypoint plugin
https://github.com/hashicorp/waypoint-plugin-examples
example golang grpc hashicorp plugin waypoint
Last synced: 4 months ago
JSON representation
An example repository that demonstrates how to create and run an external Waypoint plugin
- Host: GitHub
- URL: https://github.com/hashicorp/waypoint-plugin-examples
- Owner: hashicorp
- License: mpl-2.0
- Archived: true
- Created: 2020-09-29T14:43:29.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-08-30T13:55:41.000Z (over 2 years ago)
- Last Synced: 2025-01-08T13:07:48.187Z (about 1 year ago)
- Topics: example, golang, grpc, hashicorp, plugin, waypoint
- Language: Go
- Homepage:
- Size: 4.12 MB
- Stars: 20
- Watchers: 11
- Forks: 19
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# waypoint-plugin-examples
Example external plugins for Waypoint
For a full guide on building plugins with Waypoint please see the
[Extending Waypoint](https://www.waypointproject.io/docs/extending-waypoint) documentation
## [Plugin Template](./template)
This template can be used to scaffold new Waypoint plugins. All the main Waypoint components and interfaces are
implemented in this sample.
## [Go Builder Plugin](./plugins/gobuilder_final)
This plugin is the final example code from the plugin development guide in the Waypoint documentation.
## [Filepath Plugin](./plugins/filepath)
Plugin which implements Registry, Platform, and ReleaseManager which interacts with the local file system
## Running the Sample App
1. Build the sample plugins
This command will build the plugins and move them to the ./plugins/example_app/.waypoint/plugins folder
```shell
cd plugins
make
### Build Go Builder Plugin
make -C gobuilder_final
make[1]: Entering directory '/home/nicj/go/src/github.com/hashicorp/waypoint-plugin-examples/plugins/gobuilder_final'
Build Protos
protoc -I . --go_out=plugins=grpc:. --go_opt=paths=source_relative ./builder/output.proto
Compile Plugin
go build -o ./bin/waypoint-plugin-gobuilder ./main.go
make[1]: Leaving directory '/home/nicj/go/src/github.com/hashicorp/waypoint-plugin-examples/plugins/gobuilder_final'
### Build Filepath Builder Plugin
make -C filepath
make[1]: Entering directory '/home/nicj/go/src/github.com/hashicorp/waypoint-plugin-examples/plugins/filepath'
protoc -I . --go_out=plugins=grpc:. --go_opt=paths=source_relative ./registry/output.proto
protoc -I . --go_out=plugins=grpc:. --go_opt=paths=source_relative ./platform/output.proto
protoc -I . --go_out=plugins=grpc:. --go_opt=paths=source_relative ./release/output.proto
make[1]: Leaving directory '/home/nicj/go/src/github.com/hashicorp/waypoint-plugin-examples/plugins/filepath'
### Install Plugins
mkdir -p ./example_app/.waypoint/plugins
cp ./gobuilder_final/bin/* ./example_app/.waypoint/plugins
cp ./filepath/bin/* ./example_app/.waypoint/plugins
```
The ./plugins/example_app folder has a simple Golang application and the following Waypoint file
```hcl
project = "custom-waypoint-plugin"
app "example" {
build {
use "gobuilder" {
output_name = "app"
source = "./"
}
registry {
use "filepath" {
directory = "./bin"
}
}
}
deploy {
use "filepath" {
directory = "./deployments"
}
}
release {
use "filepath" {}
}
}
```
You can build the application using the following command:
```shell
cd ./example_app
waypoint init
✓ Configuration file appears valid
✓ Local mode initialized successfully
✓ Project "guides" and all apps are registered with the server.
✓ Plugins loaded and configured successfully
✓ Authentication requirements appear satisfied.
Project initialized!
You may now call 'waypoint up' to deploy your project or
commands such as 'waypoint build' to perform steps individually.
```
And then:
```shell
waypoint init
waypoint up
» Building example...
✓ Application built successfully
✓ Application binary pushed to registry
» Deploying example...
✓ Created deployment deployments/app.1.deployment
✓ File is ready!
» Releasing example...
✓ Created release deployments/release
✓ Symlink to File is ready!
The deploy was successful! A Waypoint deployment URL is shown below. This
can be used internally to check your deployment and is not meant for external
traffic. You can manage this hostname using "waypoint hostname."
Release URL: deployments/release
Deployment URL: https://seemingly-settled-weevil--v20.waypoint.run
```
## Community Built Plugins
Here are a list of plugins which have been created by folks within the Waypoint
community.
- [swisscom/waypoint-plugin-cloudfoundry](https://github.com/swisscom/waypoint-plugin-cloudfoundry) - Plugin for Waypoint that adds support to deploy artifacts on Cloud Foundry.
- [scaleway/waypoint-plugin-scaleway](https://github.com/scaleway/waypoint-plugin-scaleway) - Plugin for Waypoint that adds support to deploy [containers](https://www.scaleway.com/en/serverless-containers/).
- [seaplane-io/waypoint-plugin-seaplane](https://github.com/seaplane-io/waypoint-plugin-seaplane) - Plugin to use [Seaplane](https://www.seaplane.io) compute services with Waypoint.
### Adding a plugin
If you are creating a plugin and would like to be featured on this list please
submit a PR and add your plugin to the list above using the following format.
```markdown
- [organization/Plugin Name](url to plugin repository) - Brief description of plugin
```