Does not work when running buildkite agent from docker container

adragoset commented 6 years ago

This pattern will never work when running the build-kite agent from the official container. Supposing the buildkite agent is run from buildkite/agent like docker installation and the docker.sock is passed in from the host using a host mount /var/run/docker.sock:/var/run/docker.sock. In this situation the agent and the plugin are both using the host docker installation however the workdir folder only exists in the agent container and not on the host. This causes the workdir bind mount for the plugin to attempt to bind to a non existant host folder. The only correct way to do this is to create a docker volume and copy the agents build context into the docker volume. Once a docker volume exists that would then be mounted to the docker plugin container. Additionally the agent container would have to be responsible for cleaning up volumes of failed or completed builds.

lox commented 6 years ago

This pattern will never work when running the build-kite agent from the official container.

Indeed, it's something we've been trying to figure out a holistic solution too. We should mention that in those docs, apologies that you've run into it. As you say, the issue is that lots of our plugins mount $PWD which will be /buildkite/builds/blah/blah which won't exist on the host.

There are a few solutions. The simplest is to volume mount in the builds directory from the host into the agent container, so that /var/lib/buildkite-agent/builds from the host is mounted in the same place in the container. You will also need /usr/local/bin/buildkite-agent on the host to make it work. This approach unfortunately falls apart in Kubernetes or on Google ContainerOS, as the root partition is mounted read-only and no-exec.

The next most complicated is to support an env for what volumes to mount (see https://github.com/buildkite-plugins/docker-compose-buildkite-plugin/pull/157 for more context). This would be something like BUILDKITE_DOCKER_DEFAULT_VOLUMES=buildkite-builds:/buildkite/builds or similar and all plugins would have to respect this rather than just assuming $PWD can be mounted. This gets complicated. /cc @asford

The other approach is to use https://github.com/buildkite/sockguard or a similar socket proxy to rewrite paths, but that is also very complicated as $PWD might be a sub-dir of a volume, which makes it tricky to mount into a container.

The idea of the agent managing docker volumes for builds is actually a really interesting one that I haven't considered before 🤔We would still need a way for docker-using plugins to figure out what volume to use to mount in the checkout dir.

asford commented 6 years ago

We manage this in our environment by establishing a single buildkite external volume, covering the entire /buildkite directory. We then mount this into the agent and all docker-compose based build steps via BUILDKITE_DOCKER_DEFAULT_VOLUMES, so that the workdir is available in all contexts at the same path.

We've an example at https://github.com/uw-ipd/buildkite-agent, which is unfortunately a little muddled due to our support for cuda & non-cuda build agents. This same tactic would probably work on a kube-based deployment, but I haven't verified that fact.

@adragoset If you're currently blocked I'd be happy to help add support for this configuration to this plugin.

adragoset commented 6 years ago

@lox @asford Thanks for the quick response i think i'll play around with the method mentioned by @asford and attempt to mount a master volume to the agent that holds the entire /buildkite directory and then subsequently attempt mounting that to the docker plugin container. If @asford wants to update config for this plugin that would be great or i can submit a pr once i get it figured out. Im still getting some of my environment setup and purchasing licenses and whatnot so it may take me a couple days to get around too updating the plugin myself. Right now I'm just mounting docker into the agent container and calling docker directly in build scripts to build containers for the test projects i converted to use buildkite for testing agent deployment into my orchestration system.

asford commented 6 years ago

@adragoset Sounds good. I'm happy to help you port that functionality to this plugin, but won't be able to take point on that change this week. Feel free to @ me on anything related to that work. buildkite-plugins/docker-compose-buildkite-plugin#157 should (hopefully) provide a good skeleton.

🤔 @lox Do you think it'd be worth creating an end-to-end description of this style of deployment someone in/around the buildkite documentation? It seems like folks who gravitate toward the docker-based agent install are most likely customers for docker-based build steps. The fact that these two related modes barely compatible out of the box is a bit confusing, and having the solution embedded across PR and issue threads isn't super discoverable.

lox commented 5 years ago

@asford Yup, I agree we need to do a better job of clarifying it. We've been trying to figure out a good solution to the problem, but in the meantime we need to at least call it out in the documentation.

peterbygrave commented 5 years ago

Is there any update on this issue? The documentation on the website doesn't seem to reflect this problem and I have spent the day trying to work out what I had done wrong.

lox commented 5 years ago

Sorry you've spent a day on this @peterbygrave! It's a difficult docker problem unfortunately, can you tell us a bit more about the specific issues you are facing? Did any of the suggestions in this thread help?

peterbygrave commented 5 years ago

So I shifted to the running native buildkite agent to get it up and running. I will re-visit this when I am sure I have my docker-plugin steps all working.

I would echo @asford comment that end-to-end description is needed before I would be comfortable acting on a solution.