Expand Docker installation instructions#27211
Conversation
ptgott
force-pushed
the
paul.gottschling/2023-06-01-docker
branch
from
1930189 to
8fdcbcd
Compare
| example, if you want to pull the ARM64 image for | ||
| `public.ecr.aws/gravitational/teleport`, you can use | ||
| `public.ecr.aws/gravitational/teleport:(=teleport.version=)-arm64`. Architecture | ||
| suffixes are not available for `*-distroless` or `*-distroless-debug` images. |
There was a problem hiding this comment.
Why not? Are these multiarch images?
|
|
||
| #### Nightly image builds | ||
|
|
||
| Nightly images point to the latest version of Teleport. They are stable, and we |
There was a problem hiding this comment.
I'm unfamiliar with these.
Why are these called nighty? Do we rebuild them every night? If so, do we really recommend that?
There was a problem hiding this comment.
This text was from the original, so I'm not 100% sure of the context. From the ECR gallery, it looks like all images are pushed daily. I've suggested condensing the two subsections related to specifying the image's version.
|
@stevenGravy This is ready for another look when you have a chance. Thanks! |
|
|
||
| ```code | ||
| $ curl --insecure https://localhost:3080/webapi/ping | ||
| {"auth":{"type":"local","second_factor":"otp","preferred_local_mfa":"otp","local":{"name":""},"private_key_policy":"none","device_trust_disabled":true,"has_motd":false},"proxy":{"kube":{"enabled":true,"listen_addr":"0.0.0.0:3080"},"ssh":{"listen_addr":"0.0.0.0:3080","tunnel_listen_addr":"0.0.0.0:3080","web_listen_addr":"0.0.0.0:3080"},"db":{"postgres_listen_addr":"0.0.0.0:3080","mysql_listen_addr":"0.0.0.0:3080"},"tls_routing_enabled":true},"server_version":"12.1.5","min_client_version":"11.0.0","cluster_name":"localhost","automatic_upgrades":false} |
There was a problem hiding this comment.
Please use the teleport variable so the server version stays current
There was a problem hiding this comment.
I don't think that's as important here since this is example output and doesn't need to match what the user sees.
|
@alexfornuto Following up on this one, thanks! |
alexfornuto
left a comment
alexfornuto
left a comment
There was a problem hiding this comment.
A couple more nits, but generally 👍
| $ docker run --hostname localhost --name teleport \ | ||
| -v ~/teleport/config:/etc/teleport \ | ||
| -v ~/teleport/data:/var/lib/teleport \ | ||
| -p 3025:3025 -p 3080:3080 \ |
There was a problem hiding this comment.
Do we want to update this to use the standard port 443 for the web interface?
There was a problem hiding this comment.
This led to an error on my Macbook that I didn't get with port 3080 (possibly due to port privileges or curl internals?):
curl --insecure https://localhost:443/webapi/ping
curl: (35) LibreSSL SSL_connect: SSL_ERROR_SYSCALL in connection to localhost:443
Closes #27186 Our attempt to simplify the getting started experience (#25415) condensed all getting started instructions into the Linux Server guide. This removed the only example in the docs for running Teleport on Docker. Our Installation page's Docker instructions contain only a list of supported images. This change expands our Installation guide to provide more comprehensive instructions for running Teleport on Docker, including information on ports and file mounts as well as an example of running a Teleport container. This also breaks up the image tables. This lets us share descriptive text between Enterprise and OSS tabs, and makes the information easier to read.
Add more context on the intended scope of the example.
ptgott
force-pushed
the
paul.gottschling/2023-06-01-docker
branch
from
cdcca34 to
6779cd6
Compare
4 participants
Closes #27186
Our attempt to simplify the getting started experience (#25415) condensed all getting started instructions into the Linux Server guide. This removed the only example in the docs for running Teleport on Docker. Our Installation page's Docker instructions contain only a list of supported images.
This change expands our Installation guide to provide more comprehensive instructions for running Teleport on Docker, including information on ports and file mounts as well as an example of running a Teleport container.
This also breaks up the image tables. This lets us share descriptive text between Enterprise and OSS tabs, and makes the information easier to read.