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

Update DBeaver guides to use authenticated local proxy. #12037

Merged
merged 3 commits into from
Apr 19, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs(db): add postgres DBeaver guide
gabrielcorado committed Apr 18, 2022

Verified

This commit was signed with the committer’s verified signature.
JounQin JounQin
commit 18538806ebf2f6a390a739e03215311a15e8afcb
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/pages/database-access/guides/gui-clients.mdx
Original file line number Diff line number Diff line change
@@ -79,6 +79,25 @@ Ensure that your environment includes the following:
<ScopedBlock scope={["oss", "enterprise"]}>

<Tabs>
<TabItem label="Authenticated Proxy">
Starting the local database proxy with the `--tunnel` flag will create an
authenticated tunnel that you can use to connect to your database instances.
You won't need to configure any credentials when connecting to this tunnel.

Here is an example on how to start the proxy:

```bash
# First, login into the database.
$ tsh db login <database-name>

# Then, start the local proxy.
$ tsh proxy db --tunnel <database-name>
Started authenticated tunnel for the <engine> database "<database-name>" in cluster "<cluster-name>" on 127.0.0.1:62652.
```
You can then connect to the address the proxy command returns, in our example it
is `127.0.0.1:62652`.
</TabItem>
<TabItem label="TLS routing">
If you're using Teleport in [TLS routing](../../setup/operations/tls-routing.mdx)
mode where each database protocol is multiplexed on the same web proxy port, use
@@ -178,6 +197,20 @@ certificate, key and root certificate from the configuration above:
Click "Save", and pgAdmin should immediately connect. If pgAdmin prompts you
for password, leave the password field empty and click OK.
## PostgreSQL DBeaver
To connect to your PostgreSQL instance, use the authenticated proxy address.
This is `127.0.0.1:62652` in the example above (see the “Authenticated Proxy”
section on [Get connection information](./gui-clients.mdx#get-connection-information)
for more information).
Use the "Database native" authentication with an empty password:
![DBeaver Postgres Configure
Server](../../../img/database-access/dbeaver-pg-configure-server.png)
Clicking on "Test connection" should return a connection success message. Then,
click on "Finish" to save the configuration.
## MySQL Workbench
[MySQL Workbench](https://www.mysql.com/products/workbench/) is a GUI