Skip to content

docs: update docker guide to allow for server access and show troubleshooting#24549

Merged
stevenGravy merged 12 commits intomasterfrom
stevenGravy/docs/dockerguide
Apr 28, 2023
Merged

docs: update docker guide to allow for server access and show troubleshooting#24549
stevenGravy merged 12 commits intomasterfrom
stevenGravy/docs/dockerguide

Conversation

@stevenGravy
Copy link
Copy Markdown
Contributor

  • distroless container does not have shell enabled so the ssh example will no longer work. updated
  • show troubleshooting with debug image

Copy link
Copy Markdown
Contributor

@ptgott ptgott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
@stevenGravy
Copy link
Copy Markdown
Contributor Author

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?

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.

@ptgott
Copy link
Copy Markdown
Contributor

ptgott commented Apr 14, 2023

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)?

@alexfornuto
Copy link
Copy Markdown
Contributor

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.

@ptgott
Copy link
Copy Markdown
Contributor

ptgott commented Apr 25, 2023

@alexfornuto Maybe it would make sense to include docker-compose instructions in /docs/installation? Were you looking for how to run a teleport binary via a docker-compose.yaml file?

Comment thread docs/pages/includes/enterprise/docker-images.mdx Outdated
Copy link
Copy Markdown
Contributor

@ptgott ptgott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some final comments.

Comment thread docs/pages/includes/docker-images-oss.mdx Outdated
Comment thread docs/pages/includes/enterprise/docker-images.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
$ 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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Comment thread docs/pages/management/guides/docker.mdx Outdated
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
stevenGravy and others added 4 commits April 28, 2023 11:49
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
@stevenGravy stevenGravy added this pull request to the merge queue Apr 28, 2023
Merged via the queue into master with commit 978b3d4 Apr 28, 2023
@stevenGravy stevenGravy deleted the stevenGravy/docs/dockerguide branch April 28, 2023 18:19
@public-teleport-github-review-bot
Copy link
Copy Markdown

@stevenGravy See the table below for backport results.

Branch Result
branch/v12 Failed
branch/v13 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants