-
Notifications
You must be signed in to change notification settings - Fork 1k
[docs] improve documentation for building images #2557
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
docker/README.md
Outdated
|
||
To run docker image with dependencies: | ||
* [docker-compose](https://docs.docker.com/compose/install/) | ||
To *run* the docker image with dependencies (e.g. PostgreSQL and Elasticsearch), you can use `docker-compose`. See our [docker-compose repo](https://github.com/temporalio/docker-compose) for reference configurations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is still a missing piece to use the locally built images.
The tags in the docker compose need to be updated to test
Assuming that is the goal of the update, build locally and make use of those built images.
Line 41 in f6e84df
DOCKER_IMAGE_TAG ?= test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice catch thank you, edited
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On this topic, I think its time to add a .env
file to the docker-compose repo.
It would be simpler to override the tag and for version updates as well.
Co-authored-by: Jeremy Breiding <jbreiding@users.noreply.github.com>
Co-authored-by: Jeremy Breiding <jbreiding@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What changed?
improve documentation for building images
Why?
when i was working on auto-setup, it was not obvious from the readme that the main way to build the image was to run
make
at the project root, until Alex told me.How did you test it?
Potential risks
Is hotfix candidate?