search

Azure / orkestra

Orkestra is a cloud-native release orchestration and lifecycle management (LCM) platform for the fine-grained orchestration of inter-dependent helm charts and their dependencies
https://azure.github.io/orkestra
Other
104 stars 16 forks source link

Add Developer Docs to Improve Local Testing #150

Closed jonathan-innis closed 3 years ago

jonathan-innis commented 3 years ago

Currently, there don't appear to be good docs around how to set-up a local environment for debugging. Building and pushing an image to docker is very inconvenient. It would be better if we provided documentation around how to get each piece set-up locally so that it's easier for contributors to start.

nitishm commented 3 years ago

@jonathan-innis Have you tried Tilt? We have a Tiltfile checked in that can be used for development. However, it doesn't provide a debugging environment where you can run delve. Another alternative would be to use Okteto (via the VSCode extension)

We can include the documentation around using these two tools and provide the configuration files for the same.

nitishm commented 3 years ago

This might be a good place to add the instructions https://github.com/Azure/Orkestra/blob/main/docs/DEVELOPMENT.md

jonathan-innis commented 3 years ago

Yeah, I will give those a shot and see what works/makes the most sense.

I have been using the VSCode debugger on the controller runtime running locally and that works great. Issue is more on the dependency side which running a debugger on an image in cluster might solve.