search

hashicorp / waypoint

A tool to build, deploy, and release any application on any platform.
https://waypointproject.io
Other
4.76k stars 327 forks source link

Improve documentation around buildpacks #3387

Open jhillyerd opened 2 years ago

jhillyerd commented 2 years ago

Is your feature request related to a problem? Please describe. Buildpacks are magical when they work, but very frustrating when they don't. I thought I'd try building a rust project with waypoint, but there was no default buildpack for it. I tried changing a few settings, but community buildpacks I found did not work. I think this may be because they are not "cloud native" or because I need to find a way to reference them as a docker image.

Describe the solution you'd like The Waypoint documentation assumes I'm familiar with buildpacks, but I am not. The documentation does not guide me anywhere to learn more about them. There should be an outline of steps to consider when a buildpack doesn't work, perhaps guiding you to a Dockerfile if other options are exhausted.

Edit: This would be an example of a buildpack I'd like to use, but I have no idea how to translate the steps they are providing into something that works with Waypoint: https://github.com/paketo-community/rust/#tldr

evanphx commented 2 years ago

Hey @hone, how's things been? Curious if y'all over in cloudnative buildpacks land have thoughts on how we could better document the end user experience to help out folks? Thanks!

samj1912 commented 2 years ago

cc: @AidanDelaney, @jromero, @jkutner from our Buildpacks learning team.

jromero commented 2 years ago

@jhillyerd,

I'd be curious to know the following:

  1. What specific documentation were you referencing for buildpacks on waypoint? Was it this one? Were there others?
  2. Did you stumble upon any https://buildpacks.io/docs documentation that helped or may have helped?
  3. You mention "community buildpacks I found did not work". Any specific error you were getting?
jhillyerd commented 2 years ago

Hi @jromero

  1. I believe I was looking at the doc you referenced, and also https://www.waypointproject.io/docs/lifecycle/build#configuring-an-alternative-buildpack-provider
  2. I don't recall if I looked at https://buildpacks.io/docs/ or not, but given it has no search hits for rust I likely did not spend any time there.
  3. The error I got was that it was not able to pull a docker image for the specified buildpack, likely paketo-community/rust

I think my confusion is that the doc I link in #1 above specifically mentions paketo, but I did not see a way to use the community one in #3 above with Waypoint.