Edit the Machine ID getting started guide #12868
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ptgott
force-pushed
the
paul.gottschling/11806-machine-id-cloud
branch
from
9db0af4 to
39440cd
Compare
zmb3
reviewed
May 25, 2022
| @@ -4,24 +4,25 @@ description: Getting started with Teleport Machine ID | |||
| --- | |||
|
|
|||
| In this getting started guide, you will use Machine ID to create a bot user for | |||
| a machine and use that identity to connect to said machine. | |||
| a machine, then use that identity to connect to the machine. | |||
There was a problem hiding this comment.
I think this is technically inaccurate.
The machine you are connecting to is a "host". The identity machine ID is issuing is for a [bot] "user" to connect to said host.
In other words, the identity you create and the machine you connect to are separate. This wording makes them sound the same.
| 2. Create a bot user | ||
| 3. Start Machine ID | ||
| 4. Use certificates issued by Machine ID to connect to a remote machine | ||
| 1. Download and install Teleport (=teleport.version=) on the host that will run |
There was a problem hiding this comment.
Should we say tbot instead of "Teleport" here?
| @@ -157,8 +161,27 @@ the foreground to better understand how it works. | |||
| --ca-pin=sha256:1111111111111111111111111111111111111111111111111111111111111111 \ | |||
There was a problem hiding this comment.
Don't we have some sort of variable we can use for tokens and CA pins in the docs?
ptgott
force-pushed
the
paul.gottschling/11806-machine-id-cloud
branch
from
39440cd to
8180cf5
Compare
ptgott
force-pushed
the
paul.gottschling/11806-machine-id-cloud
branch
from
8180cf5 to
7167577
Compare
zmb3
approved these changes
Jun 14, 2022
ptgott
force-pushed
the
paul.gottschling/11806-machine-id-cloud
branch
from
7167577 to
ee92be0
Compare
klizhentas
approved these changes
Jun 18, 2022
Fixes #11806 - Add more scope-specific information to the Prerequisites section - Add the tctl.mdx partial to make it clearer for each scope how to connect to the cluster to run tctl commands. - Add the Cloud tenant address to the "tbot start" example command for Cloud users.
ptgott
force-pushed
the
paul.gottschling/11806-machine-id-cloud
branch
from
ee92be0 to
636cdc5
Compare
This was referenced Jun 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #11806
connect to the cluster to run tctl commands.
Cloud users.