Edit Database Access guides for Cloud users #11668
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
zmb3
approved these changes
Apr 1, 2022
ptgott
force-pushed
the
paul.gottschling/10637-2
branch
from
ecffdc5 to
7e35d83
Compare
ptgott
added a commit
that referenced
this pull request
Apr 5, 2022
See #10637 - Add tabbed instructions in the Prerequisites for users of different scopes. - Add instructions to make it clearer where things are running, since the previous guides did not mention that you need to install and run the Teleport Database Service on a separate host. This adds a new section re: the Database Service that mirrors instructions in other Database Access guides. Note that this branch cherry-picks all docs/pages/includes changes from #11668. Please add feedback on the partials to that branch, and I will keep this branch rebased to that one.
ptgott
force-pushed
the
paul.gottschling/10637-2
branch
from
7e35d83 to
a130309
Compare
ulysseskan
reviewed
Apr 7, 2022
|
|
||
| </ScopedBlock> | ||
|
|
||
| Fetch short-lived client certificate for your Azure database using the |
There was a problem hiding this comment.
Fetch a short-lived client certificate ...
ulysseskan
reviewed
Apr 7, 2022
| @@ -256,7 +321,7 @@ $ tsh db connect azure-db | |||
|
|
|||
| <Admonition type="note"> | |||
| The appropriate database command-line client (`psql`, `mysql`) should be | |||
| available in PATH of the machine you're running `tsh db connect` from. | |||
| available in `PATH` of the machine you're running `tsh db connect` from. | |||
There was a problem hiding this comment.
available in the PATH ...
ulysseskan
approved these changes
Apr 7, 2022
ptgott
added a commit
that referenced
this pull request
Apr 7, 2022
See #10637 - Add tabbed instructions in the Prerequisites for users of different scopes. - Add instructions to make it clearer where things are running, since the previous guides did not mention that you need to install and run the Teleport Database Service on a separate host. This adds a new section re: the Database Service that mirrors instructions in other Database Access guides. Note that this branch cherry-picks all docs/pages/includes changes from #11668. Please add feedback on the partials to that branch, and I will keep this branch rebased to that one.
ptgott
force-pushed
the
paul.gottschling/10637-2
branch
from
a130309 to
3f47931
Compare
ptgott
force-pushed
the
paul.gottschling/10637-2
branch
from
b52a153 to
f0e9e7b
Compare
This edits Database Access guides that show you how to access specific databases. These guides follow the same structure and use the same partials, so it made sense to address them in a single commit. See #10637 Edits made - Some Prerequisites sections were either absent or required "Teleport," which I've clarified with a scoped Tabs component to indicate the appropriate client tools for each deployment type. Since we instruct users on deploying the Auth/Proxy later in the guide, I restricted this to client tools. Also flesh out the Prerequisites a bit in general. - Add ScopedBlocks for minor details that vary between scopes. - Ensure that all commands that take place on the Database Service node are described correctly as taking place on that node. - Change the tctl-auth-sign.mdx partial. Since the start-auth-proxy.mdx partial now instructs self-hosted users to run tctl commands on the Auth Service host, we no longer need the Self-Hosted tab. As a result, I have turned the Cloud tab into a ScopedBlock. - Reorder self-hosted guide sections so users start the Auth/Proxy before running "tctl auth sign". Otherwise, this command will not work. - Minor style/grammar tweaks
ptgott
force-pushed
the
paul.gottschling/10637-2
branch
from
f0e9e7b to
ddeede6
Compare
Also appease the linter.
ptgott
force-pushed
the
paul.gottschling/10637-2
branch
from
ddeede6 to
815a886
Compare
ptgott
added a commit
that referenced
this pull request
Apr 8, 2022
Backports #11668 * Edit Database Access guides for Cloud users This edits Database Access guides that show you how to access specific databases. These guides follow the same structure and use the same partials, so it made sense to address them in a single commit. See #10637 Edits made - Some Prerequisites sections were either absent or required "Teleport," which I've clarified with a scoped Tabs component to indicate the appropriate client tools for each deployment type. Since we instruct users on deploying the Auth/Proxy later in the guide, I restricted this to client tools. Also flesh out the Prerequisites a bit in general. - Add ScopedBlocks for minor details that vary between scopes. - Ensure that all commands that take place on the Database Service node are described correctly as taking place on that node. - Change the tctl-auth-sign.mdx partial. Since the start-auth-proxy.mdx partial now instructs self-hosted users to run tctl commands on the Auth Service host, we no longer need the Self-Hosted tab. As a result, I have turned the Cloud tab into a ScopedBlock. - Reorder self-hosted guide sections so users start the Auth/Proxy before running "tctl auth sign". Otherwise, this command will not work. - Minor style/grammar tweaks * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
Apr 11, 2022
Backports #11668 * Edit Database Access guides for Cloud users This edits Database Access guides that show you how to access specific databases. These guides follow the same structure and use the same partials, so it made sense to address them in a single commit. See #10637 Edits made - Some Prerequisites sections were either absent or required "Teleport," which I've clarified with a scoped Tabs component to indicate the appropriate client tools for each deployment type. Since we instruct users on deploying the Auth/Proxy later in the guide, I restricted this to client tools. Also flesh out the Prerequisites a bit in general. - Add ScopedBlocks for minor details that vary between scopes. - Ensure that all commands that take place on the Database Service node are described correctly as taking place on that node. - Change the tctl-auth-sign.mdx partial. Since the start-auth-proxy.mdx partial now instructs self-hosted users to run tctl commands on the Auth Service host, we no longer need the Self-Hosted tab. As a result, I have turned the Cloud tab into a ScopedBlock. - Reorder self-hosted guide sections so users start the Auth/Proxy before running "tctl auth sign". Otherwise, this command will not work. - Minor style/grammar tweaks * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
Apr 11, 2022
Backports #11668 * Edit Database Access guides for Cloud users This edits Database Access guides that show you how to access specific databases. These guides follow the same structure and use the same partials, so it made sense to address them in a single commit. See #10637 Edits made - Some Prerequisites sections were either absent or required "Teleport," which I've clarified with a scoped Tabs component to indicate the appropriate client tools for each deployment type. Since we instruct users on deploying the Auth/Proxy later in the guide, I restricted this to client tools. Also flesh out the Prerequisites a bit in general. - Add ScopedBlocks for minor details that vary between scopes. - Ensure that all commands that take place on the Database Service node are described correctly as taking place on that node. - Change the tctl-auth-sign.mdx partial. Since the start-auth-proxy.mdx partial now instructs self-hosted users to run tctl commands on the Auth Service host, we no longer need the Self-Hosted tab. As a result, I have turned the Cloud tab into a ScopedBlock. - Reorder self-hosted guide sections so users start the Auth/Proxy before running "tctl auth sign". Otherwise, this command will not work. - Minor style/grammar tweaks * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
Apr 13, 2022
See #10637 - Add tabbed instructions in the Prerequisites for users of different scopes. - Add instructions to make it clearer where things are running, since the previous guides did not mention that you need to install and run the Teleport Database Service on a separate host. This adds a new section re: the Database Service that mirrors instructions in other Database Access guides. Note that this branch cherry-picks all docs/pages/includes changes from #11668. Please add feedback on the partials to that branch, and I will keep this branch rebased to that one.
ptgott
added a commit
that referenced
this pull request
Apr 13, 2022
* Edit Redis guides for Cloud users See #10637 - Add tabbed instructions in the Prerequisites for users of different scopes. - Add instructions to make it clearer where things are running, since the previous guides did not mention that you need to install and run the Teleport Database Service on a separate host. This adds a new section re: the Database Service that mirrors instructions in other Database Access guides. Note that this branch cherry-picks all docs/pages/includes changes from #11668. Please add feedback on the partials to that branch, and I will keep this branch rebased to that one. * Address PR feedback
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.
This edits Database Access guides that show you how to access
specific databases. These guides follow the same structure and use the
same partials, so it made sense to address them in a single commit.
See #10637
Edits made
Some Prerequisites sections were either absent or required
"Teleport," which I've clarified with a scoped Tabs component to
indicate the appropriate client tools for each deployment type.
Since we instruct users on deploying the Auth/Proxy later in the
guide, I restricted this to client tools. Also flesh out the
Prerequisites a bit in general.
Add ScopedBlocks for minor details that vary between scopes.
Ensure that all commands that take place on the Database Service node
are described correctly as taking place on that node.
Change the tctl-auth-sign.mdx partial. Since the start-auth-proxy.mdx
partial now instructs self-hosted users to run tctl commands on the
Auth Service host, we no longer need the Self-Hosted tab. As a result,
I have turned the Cloud tab into a ScopedBlock.
Reorder self-hosted guide sections so users start the Auth/Proxy
before running "tctl auth sign". Otherwise, this command will not
work.
Minor style/grammar tweaks