search

woodpecker-ci / woodpecker

Woodpecker is a simple, yet powerful CI/CD engine with great extensibility.
https://woodpecker-ci.org
Apache License 2.0
4.16k stars 360 forks source link

Add documentation for KUBERNETES_SERVICE_HOST in Agent #3747

Closed jcgl17 closed 3 months ago

jcgl17 commented 4 months ago

This PR adds some documentation that was missing (from my perspective as a new user). I am running the Agent outside of Kubernetes, and therefore didn't have the benefit of KUBERNETES_SERVICE_HOST already being set. Hopefully this documentation addition can help other newcomers get up and running without also needing to drill into the actual code :)

P.S. I know that this env var isn't a WOODPECKER_BACKEND_K8S_-prefixed one, but I figured that this was still the appropriate place to document it. Please let me know if there's a better place to put this information!

qwerty287 commented 4 months ago

Thanks!

This is not a woodpecker-specific config, right?

Then I'd rather put it somewhere else. Maybe to "Tips and tricks" (https://woodpecker-ci.org/docs/administration/backends/kubernetes#tips-and-tricks)?

jcgl17 commented 4 months ago

It's not Woodpecker-specific in the sense that Woodpecker is its only user or original user. However, Woodpecker itself does explicitly use it in its own way rather than the variable being used only implicitly by one of Woodpecker's dependencies.

That being said, I've now moved it into the Tips and Tricks section.

Edit: fixed link

woodpecker-bot commented 4 months ago

Deployment of preview was torn down