Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the OpenSSH guide more usable #12183

Merged
merged 2 commits into from
Jun 6, 2022
Merged

Make the OpenSSH guide more usable #12183

merged 2 commits into from
Jun 6, 2022

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Apr 22, 2022

See #11841

  • Add a Prerequisites section and divide the instructions into steps via
    H2 headings.
  • Use ScopedBlocks to add instructions for Cloud users.
  • Fill in missing instructions (e.g., adding host_cert permissions for
    Cloud users and editing the file permission of the host key/cert)
  • Since all supported versions of Teleport now include "tsh config,"
    remove the manual OpenSSH configuration option. This makes the guide
    much simpler to follow.
  • Add a Details box explaining "tsh config" The original OpenSSH guide
    included some technical details about the proxy subsystem, but
    without enough context to understand the configuration generated by
    tsh config. I've moved the technical details into a Details box, and
    expanded them, so readers interested in how the local SSH config they
    generate via "tsh config" works.

@stevenGravy
Copy link
Contributor

would be good to add that the output of below can be added to ~/.ssh/authorized_keys for a user and that would allow connecting through. You don't have to put the cert in the OpenSSH server.

$ tctl auth export --type=user

@ptgott ptgott force-pushed the paul.gottschling/11841-7 branch from 0a9e42a to 889b485 Compare May 6, 2022 17:57
@ptgott ptgott marked this pull request as ready for review May 6, 2022 17:59
@github-actions github-actions bot requested review from r0mant, xinding33 and zmb3 May 6, 2022 17:59
@ptgott
Copy link
Contributor Author

ptgott commented May 6, 2022

@stevenGravy Thanks! I finally got this to work using the instructions in the original guide (modified a bit), and I can make time to incorporate the authorized_keys approach you mentioned.

@ptgott ptgott force-pushed the paul.gottschling/11841-7 branch from 889b485 to fb6496c Compare May 6, 2022 18:11
@ptgott ptgott force-pushed the paul.gottschling/11841-7 branch from ab1f027 to be0fced Compare May 24, 2022 15:38
@ptgott ptgott enabled auto-merge (squash) June 6, 2022 14:44
ptgott added 2 commits June 6, 2022 10:44
See #11841

- Add a Prerequisites section and divide the instructions into steps via
  H2 headings.
- Use ScopedBlocks to add instructions for Cloud users.
- Fill in missing instructions (e.g., adding host_cert permissions for
  Cloud users and editing the file permission of the host key/cert)
- Since all supported versions of Teleport now include "tsh config,"
  remove the manual OpenSSH configuration option. This makes the guide
  much simpler to follow.
- Add a Details box explaining "tsh config" The original OpenSSH guide
  included some technical details about the proxy subsystem, but
  without enough context to understand the configuration generated by
  tsh config. I've moved the technical details into a Details box, and
  expanded them, so readers interested in how the local SSH config they
  generate via "tsh config" works.
- Indicate that you need to specify the SSH port when connecting to an
  OpenSSH host via configuration generated by tsh config.
@ptgott ptgott force-pushed the paul.gottschling/11841-7 branch from be0fced to 7a21445 Compare June 6, 2022 14:44
@ptgott ptgott merged commit 27c38c7 into master Jun 6, 2022
ptgott added a commit that referenced this pull request Jun 7, 2022
* Make the OpenSSH guide more usable

See #11841

- Add a Prerequisites section and divide the instructions into steps via
  H2 headings.
- Use ScopedBlocks to add instructions for Cloud users.
- Fill in missing instructions (e.g., adding host_cert permissions for
  Cloud users and editing the file permission of the host key/cert)
- Since all supported versions of Teleport now include "tsh config,"
  remove the manual OpenSSH configuration option. This makes the guide
  much simpler to follow.
- Add a Details box explaining "tsh config" The original OpenSSH guide
  included some technical details about the proxy subsystem, but
  without enough context to understand the configuration generated by
  tsh config. I've moved the technical details into a Details box, and
  expanded them, so readers interested in how the local SSH config they
  generate via "tsh config" works.
- Indicate that you need to specify the SSH port when connecting to an
  OpenSSH host via configuration generated by tsh config.

* Respond to PR feedback
ptgott added a commit that referenced this pull request Jun 8, 2022
* Make the OpenSSH guide more usable

See #11841

- Add a Prerequisites section and divide the instructions into steps via
  H2 headings.
- Use ScopedBlocks to add instructions for Cloud users.
- Fill in missing instructions (e.g., adding host_cert permissions for
  Cloud users and editing the file permission of the host key/cert)
- Since all supported versions of Teleport now include "tsh config,"
  remove the manual OpenSSH configuration option. This makes the guide
  much simpler to follow.
- Add a Details box explaining "tsh config" The original OpenSSH guide
  included some technical details about the proxy subsystem, but
  without enough context to understand the configuration generated by
  tsh config. I've moved the technical details into a Details box, and
  expanded them, so readers interested in how the local SSH config they
  generate via "tsh config" works.
- Indicate that you need to specify the SSH port when connecting to an
  OpenSSH host via configuration generated by tsh config.

* Respond to PR feedback
@ptgott ptgott deleted the paul.gottschling/11841-7 branch November 3, 2022 21:34
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