Document usage with remote runners

[thiskevinwang]

Description

There are at least 2 ways to use this plugin with remote runners. Neither are great. At least one works. Documentation is greatly needed.

-platform=docker on EC2

• See it work once with my own eyes

This requires a custom runner image to be passed to waypoint runner install.
Furthermore, that image needs ...

• nixpacks installed
• waypoint-plugin-nixpacks in a location that is detected by waypoint
  • see https://developer.hashicorp.com/waypoint/docs/extending-waypoint/creating-plugins/compiling#installing-the-plugin

FROM hashicorp/waypoint:latest
ARG PLUGIN_NAME=waypoint-plugin-nixpacks
COPY ./bin/$PLUGIN_NAME $HOME/.config/waypoint/plugins/$PLUGIN_NAME

waypoint runner agent, on EC2

• See it work once with my own eyes

In this route, the EC2 machine itself has

• nixpacks installed
• The plugin binary present at $HOME/.config/waypoint/plugins/waypoint-plugin-nixpacks
  • Getting the plugin here is currently a highly manual process — git cloning the runner branch of this repo, and cp-ing the committed binary.
• manually authenticated with Docker hub — this is to test usage with a registry component

[thiskevinwang]

TIL: you can use the gh CLI to upload assets to an existing release. This might make fetching from a remote runner ever so slightly easier.

gh release upload v0.1.0-beta.2 ./bin/waypoint-plugin-nixpacks

[thiskevinwang]

curl -o $HOME/.config/waypoint/plugins/waypoint-plugin-nixpacks -LO https://github.com/thiskevinwang/waypoint-plugin-nixpacks/releases/download/v0.1.0-beta.2/waypoint-plugin-nixpacks