temporal icon indicating copy to clipboard operation
temporal copied to clipboard

Document configuration (development.yaml, dynamicconfig)

Open kennedyjustin opened this issue 3 years ago • 5 comments

Is your feature request related to a problem? Please describe. There is almost no documentation on what the development.yaml file is, how it relates to dynamicconfig, etc. This is the closest thing: https://docs.temporal.io/server/configuration, and it is severely lacking a high-level explanation.

Describe the solution you'd like A page dedicated to what this file is, how it relates to dynamicconfig, where is this file expected to be in a production deployment or docker-compose setup, etc.

Describe alternatives you've considered N/A

Additional context I am running through my local and production setup for the first time (I am a new Temporal user).

kennedyjustin avatar May 23 '22 18:05 kennedyjustin

We recently updated the document at https://docs.temporal.io/server/configuration, could you check again.

yiminc avatar May 27 '22 21:05 yiminc

For me the most confusing part of setting up temporal was the configuration, and now that I'm on the other side of it I think the biggest part missing was documentation on how to use temporal with out-of-the-box docker images (something I have become used to through software products from HashiCorp, Elastic, Postgres, etc.).

Most out-of-the-box docker images can be configured via command arguments or environment variables, and I think this is the way I was expecting to use temporal (and indeed it is how I am using it now). The existence of https://github.com/temporalio/temporal/blob/master/docker/config_template.yaml and https://github.com/temporalio/docker-builds/tree/main/docker helped me understand exactly how its possible to setup temporal via docker images, but I didn't find this documented anywhere, and had rely on combing through the repos to understand it all.

I think a blog post in the same style as https://docs.temporal.io/blog/auto-setup/, but about the topic of building temporal as a binary yourself with a development.yaml contrasted with using a pre-built docker image (temporalio/server) and environment variables would be a huge help to those that want to consume temporal through docker images like me.

With that all said it wasn't clear to me whether blessing a pre-built docker image setup for production use is something that is on the roadmap or if the team strongly recommends building yourself for the medium or long-term future.

So to conclude I guess what I was hoping for was some documentation about:

  1. If one were to go down the path of setting up temporal through the pre-built images, how does configuration work at a high level.
  2. Some discussion about whether pre-build docker images for production use (and potentially even 100% parity with development.yaml through env vars or command options) is something that is on the roadmap or being thought about on the team.

I also want to say that I am new to the community, so I apologize if this is something that has already been hashed out.

kennedyjustin avatar May 28 '22 22:05 kennedyjustin

I am still facing this issue, cannot understand the difference between development.yaml & dynamiconfig

sharadregoti avatar Oct 21 '22 04:10 sharadregoti

+1, the docs on configuration are a bad part of what is otherwise good documentation.

leofdgit avatar Nov 29 '22 10:11 leofdgit