Add load balancer, and quick start documentation. #3
Conversation
docker-compose.full-demo.yml
Outdated
| # `microservices_demo_1`. Because of this, all services | ||
| # are able to communicate by their `container_name`. | ||
|
|
||
| # Only the load balancer ports are mapped out. However, we |
There was a problem hiding this comment.
"Only the load balancer ports need to be mapped out" ?
There was a problem hiding this comment.
I would say "only the load balancer ports are exposed to the host"
There was a problem hiding this comment.
it's the "However, we also leave the ports for the databases and the rabbit queue mapped out" that confused me for a second. Those don't need to be exposed but they are. The LB ports do need to be exposed for the deployment to be accessible.
There was a problem hiding this comment.
Yeah that's much better wording. "exposed" didn't pop into my head. Changing...
docker-compose.full-demo.yml
Outdated
| # This docker-compose file sets up the services | ||
| # and shared infrastructure on a common network called | ||
| # `microservices_demo_1`. Because of this, all services | ||
| # are able to communicate by their `container_name`. |
There was a problem hiding this comment.
| # are able to communicate by their `container_name`. | |
| # are able to communicate by their respective <container_name>. |
container_name is not actual code so it'd be better if we tag it as something that is not code. The above is a suggestion, but not necessarily the best solution.
There was a problem hiding this comment.
I'd argue that this fits the bill - it's a key we provide which will be read in the docker compose file. I'm going with this rubric to determine when I use backticks:
If you would use it in the terminal or modify it in a code or text editor, use a monospaced font.
There was a problem hiding this comment.
Fair enough. I like to put placeholder code in <> (I have no clue how it's called) but as long as we stay consistent both work.
There was a problem hiding this comment.
ohhhh I see what you mean . I was thinking of the key and I think you were thinking of the value. Maybe.. "... are able to communicate by using the value of their container_name key as the hostname"? I just wanted to make it clear which key in the docker compose file we are referencing
README.md
Outdated
| ## Running just shared infrastructure | ||
| If you are running some subset of the services manually, just run `docker-compose up` from this repository to start up the message queue. This does not set up the NGINX load balancer. |
There was a problem hiding this comment.
| ## Running just shared infrastructure | |
| If you are running some subset of the services manually, just run `docker-compose up` from this repository to start up the message queue. This does not set up the NGINX load balancer. |
You will already cover the manual setup in L15
There was a problem hiding this comment.
This one is a bit different but maybe I've worded it poorly. There's three things you can do:
- Manual setup (prebuilt containers everywhere, started with mostly
docker runcommands and somedocker-compose upcommands). - Quick setup (one big docker compose file)
- Running a subset of services locally on your machine (how most devs work in my experience). So for example I might be running
messengerwith just node on my mac, and need to have the rabbit queue available for that.
How does this alternative wording sound?
If you are working on one of the services, such as messenger, that depends on a piece of shared infrastructure to function, you can run
docker-compose upfrom this repository to provide that infrastructure. This does not set up the NGINX load balancer.
There was a problem hiding this comment.
Your suggestion should work! The original wording was indeed unclear/missing some info.
alessfg
added
documentation
Co-authored-by: Alessandro Fael Garcia <[email protected]>
Co-authored-by: Alessandro Fael Garcia <[email protected]>
What
Adds:
messengerapplicationI also moved the setup guides to a docs folder since I couldn't get github to handle markdown in expands - and I also don't want the platform README to be all about setting up the whole demo.