docs: update docker guide to allow for server access and show troubleshooting#24549
docs: update docker guide to allow for server access and show troubleshooting#24549stevenGravy merged 12 commits intomasterfrom
Conversation
stevenGravy
commented
Apr 13, 2023
- distroless container does not have shell enabled so the ssh example will no longer work. updated
- show troubleshooting with debug image
There was a problem hiding this comment.
Thanks for looking into this!
This change brings up what I think is an underlying issue with the Docker guide: what is the purpose of the guide? I think it's caught between a general guide to running Teleport on Docker and a getting started guide to trying out Teleport locally. This change moves the needle in the "trying out Teleport" direction.
Personally, I think that's okay—I haven't tested out the change, but if it works, this should be more reliable and simpler to understand than our Docker Compose guide.
But if we're going this route, we should move this out of the "Integrations" subsection and into "Try out Teleport".
When you've seen users follow this guide, what problems do you see them using this guide in order to solve? Are they getting started with Teleport or trying to deploy a production Teleport container in an environment that's not Kubernetes?
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Yes, this is more of a Try Out Teleport. It doesn't show setting up a full blown example on a server and is more of how to get a simple example up and going. This allows them to setup Teleport in a docker container, not have to host it outside of docker and see the ability to connect to a server. |
That makes sense to me. @alexfornuto what would you think of us replacing the Docker Compose guide with this one in "Try out Teleport" (i.e., getting rid of the Docker Compose guide)? |
I'm for it, with one caveat. When I first looked up the Docker Compose guide I was looking for a starter compose file for Teleport, not the full demo it is. I agree that this guide should replace that one as a simpler "try it out", but would like to include (here or somewhere else) a docker compose starter for folks. |
|
@alexfornuto Maybe it would make sense to include |
| $ docker run --hostname localhost --rm \ | ||
| --entrypoint=/usr/local/bin/teleport \ | ||
| ${TELEPORT_DOCKER_IMAGE} configure > ~/teleport/config/teleport.yaml | ||
| ${TELEPORT_DOCKER_IMAGE} configure --roles=proxy,auth > ~/teleport/config/teleport.yaml |
There was a problem hiding this comment.
Do we need to use the home directory here? This might be unexpected for a user who wants to create their own project directory for this demo
There was a problem hiding this comment.
This is how we've had it for quite a while. This lets them spin it up in a user account dir vs requiring sudo checks an things. I would leave it as is.
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
|
@stevenGravy See the table below for backport results.
|