Make the Adding Nodes guide more usable #12504
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/11841-adding-nodes-self-hosted
branch
from
0158d01 to
b7fc3c7
Compare
strideynet
approved these changes
May 18, 2022
| --token=(=presets.tokens.first=) \ | ||
| --ca-pin=(=presets.ca_pin=) \ | ||
| --auth-server=10.12.0.6:3025 | ||
| $ echo "export CA_PIN=${CA_PIN?}" |
There was a problem hiding this comment.
This feels a bit weird, but I can't really think of another way of doing it other than:
echo "export CA_PIN=${CA_PIN?}\nexport INVITE_TOKEN=${INVITE_TOKEN?}"
Which feels worse :(
There was a problem hiding this comment.
Would it make more sense to show the export commands the user would run on the Node's host, then let the readers work out for themselves that they should paste the values of the variables from a terminal on their local machine?
There was a problem hiding this comment.
Perhaps that's easier :) Or a bit less weird.
ptgott
force-pushed
the
paul.gottschling/11841-adding-nodes-self-hosted
branch
2 times, most recently
from
f033bf4 to
655055d
Compare
r0mant
approved these changes
May 24, 2022
| ``` | ||
|
|
||
| If you want to provide your own token, you can do so using the `--token` flag: | ||
| <Details title="Tokens with known values"> |
There was a problem hiding this comment.
Nit: Maybe say "Provide your own token value" as a title instead or something like this, and add a warning to use cryptographically secure token values for better security.
ptgott
force-pushed
the
paul.gottschling/11841-adding-nodes-self-hosted
branch
from
655055d to
7698fcc
Compare
See: #11841 This change makes the Adding Nodes guide more usable for self-hosted clusters based on manual testing. - Make it clearer that you can use tctl on your local machine with a self-hosted cluster. For convenience, all instructions in this guide assume you are using tctl from a local machine. - Misc. minor edits for clarity. - Move different methods of using tokens into Details boxes, since following the guide only requires the first "tctl nodes add" command. - Use environment variables to store the CA pin, invite token, and Proxy/Auth address, making it slightly more convenient to copy the "teleport start" command and run it on the Node. - Turn the Node Tunneling section into a Details box below the instruction to assign the Auth/Proxy address to an environment variable, and better integrate the text into the guide. Previously, the Node Tunneling section also advised the reader to create a token, which they would have doe already at this point in the guide.
Also remove some erroneous command output
ptgott
force-pushed
the
paul.gottschling/11841-adding-nodes-self-hosted
branch
from
7698fcc to
efe04b2
Compare
This was referenced Jun 2, 2022
ptgott
added a commit
that referenced
this pull request
Jun 3, 2022
* Make the Adding Nodes guide more usable See: #11841 This change makes the Adding Nodes guide more usable for self-hosted clusters based on manual testing. - Make it clearer that you can use tctl on your local machine with a self-hosted cluster. For convenience, all instructions in this guide assume you are using tctl from a local machine. - Misc. minor edits for clarity. - Move different methods of using tokens into Details boxes, since following the guide only requires the first "tctl nodes add" command. - Use environment variables to store the CA pin, invite token, and Proxy/Auth address, making it slightly more convenient to copy the "teleport start" command and run it on the Node. - Turn the Node Tunneling section into a Details box below the instruction to assign the Auth/Proxy address to an environment variable, and better integrate the text into the guide. Previously, the Node Tunneling section also advised the reader to create a token, which they would have doe already at this point in the guide. * Respond to PR feedback Also remove some erroneous command output
ptgott
added a commit
that referenced
this pull request
Jun 3, 2022
* Make the Adding Nodes guide more usable See: #11841 This change makes the Adding Nodes guide more usable for self-hosted clusters based on manual testing. - Make it clearer that you can use tctl on your local machine with a self-hosted cluster. For convenience, all instructions in this guide assume you are using tctl from a local machine. - Misc. minor edits for clarity. - Move different methods of using tokens into Details boxes, since following the guide only requires the first "tctl nodes add" command. - Use environment variables to store the CA pin, invite token, and Proxy/Auth address, making it slightly more convenient to copy the "teleport start" command and run it on the Node. - Turn the Node Tunneling section into a Details box below the instruction to assign the Auth/Proxy address to an environment variable, and better integrate the text into the guide. Previously, the Node Tunneling section also advised the reader to create a token, which they would have doe already at this point in the guide. * Respond to PR feedback Also remove some erroneous command output
ptgott
added a commit
that referenced
this pull request
Jun 3, 2022
* Make the Adding Nodes guide more usable See: #11841 This change makes the Adding Nodes guide more usable for self-hosted clusters based on manual testing. - Make it clearer that you can use tctl on your local machine with a self-hosted cluster. For convenience, all instructions in this guide assume you are using tctl from a local machine. - Misc. minor edits for clarity. - Move different methods of using tokens into Details boxes, since following the guide only requires the first "tctl nodes add" command. - Use environment variables to store the CA pin, invite token, and Proxy/Auth address, making it slightly more convenient to copy the "teleport start" command and run it on the Node. - Turn the Node Tunneling section into a Details box below the instruction to assign the Auth/Proxy address to an environment variable, and better integrate the text into the guide. Previously, the Node Tunneling section also advised the reader to create a token, which they would have doe already at this point in the guide. * Respond to PR feedback Also remove some erroneous command output
Closed
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.
See: #11841
This change makes the Adding Nodes guide more usable for self-hosted
clusters based on manual testing.
Make it clearer that you can use tctl on your local machine with
a self-hosted cluster, including changing the tctl.mdx partial. For
convenience, all instructions in this guide assume you are using
tctl from a local machine.
Misc. minor edits for clarity.
Move different methods of using tokens into Details boxes, since
following the guide only requires the first "tctl nodes add" command.
Use environment variables to store the CA pin, invite token, and
Proxy/Auth address, making it slightly more convenient to copy the
"teleport start" command and run it on the Node.
Turn the Node Tunneling section into a Details box below the
instruction to assign the Auth/Proxy address to an environment
variable, and better integrate the text into the guide. Previously,
the Node Tunneling section also advised the reader to create
a token, which they would have doe already at this point in the guide.