Add Compose CLI ECS documentation for redirecting 443 HTTPS traffic to any container port #14739
Conversation
What does this extra example show? How to forward HTTPS 443 traffic to a container's port 8080. At first glance, this may look like a redundant documentation entry. After all, we just showed SSL termination right above this example. We're cluttering the docs! Let me directly address this: - This literally took me 3 straight days to figure out how to do. I arrived at a custom 120 line CloudFormation yaml file before I realized I could do it this way. - There is not a single mention of the `x-aws-protocol` flag on this entire page. This adds a very helpful use case. - The jump to overriding a network load balancer and learning the `x-aws-protocol` flag, plus learning the correct `x-aws-cloudformation` overlay, plus understanding the difference between all the load balancer sub objects (TargetGroup, Listener, LoadBalancer) and knowing which fields to override is non-trivial. - Many web frameworks actively discourage running your server on port 80. It requires root user (sudo) permissions to bind to port 80. You could even argue the port 80 example above this one is encouraging bad practices (see this Digital Ocean explanation https://www.digitalocean.com/community/tutorials/how-to-use-pm2-to-setup-a-node-js-production-environment-on-an-ubuntu-vps#give-safe-user-permission-to-use-port-80 ) I think forwarding HTTPS traffic to a non-privileged container `443:8080` is a VERY common use case, and well worth the extra example here in the docs.
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
joshuakcockrell
changed the title
|
@ndeloof Do you have any feedback on this PR or things making you hesitant to merge it in? |
|
Anyone able to provide feedback on this PR? |
|
This is amazingly helpful, and I hope it gets merged in soon. Quick note, for me I had to change the |
|
This definitely could be explained better and in more detail |
|
Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions. If the updates are still relevant, review our contribution guidelines and rebase your pull request against the latest version of the docs, then mark it as fresh with a Prevent pull requests from auto-closing with a /lifecycle stale |
|
@thaJeztah Do you have someone else you could assign this PR to? It's now been sitting for 1 year without anyone looking at it. I'm happy to rebase and reopen as the example is incredibly helpful and we're currently using it in production, but I'm just not sure what another year of it sitting would accomplish. |
|
I finally had some time and rebased and recreated this pull request here: #17178 |
What does this extra example show? How to forward HTTPS 443 traffic to a container's port 8080.
At first glance, this may look like a redundant documentation entry. After all, we just showed SSL termination right above this example. We're cluttering the docs! Let me directly address this:
x-aws-protocolflag on this entire documentation page. This adds a very helpful use case.x-aws-protocolflag, plus learning the correctx-aws-cloudformationoverlay, plus understanding the difference between all the load balancer sub objects (TargetGroup, Listener, LoadBalancer) and knowing which fields to override is non-trivial.Further examples that this is non-trivial:
I think forwarding HTTPS traffic to a non-privileged container
443:8080is a VERY common use case, and well worth the extra example here in the docs.Proposed changes
Accept this example into the documentation.
Related issues (optional)
docker-archive/compose-cli#693
docker-archive/compose-cli#1472