opensource/teleport
3
0
Fork 0
mirror of https://github.com/gravitational/teleport.git synced 2026-11-02 14:59:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add database-tunnel service to Machine ID reference (#40993)

Browse Source 
* Add `database-tunnel` service to Machine ID reference

* Update docs/pages/machine-id/reference/configuration.mdx

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
This commit is contained in:
Noah Stride
2024-04-29 19:05:00 +00:00
committed by GitHub
co-authored by Paul Gottschling
parent c106c41a72
commit ef3ee8ea4d
1 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/pages/machine-id/reference/configuration.mdx
+32
View File
@@ -389,6 +389,38 @@ svids:
- 10.0.0.1
```
#### `database-tunnel`
The `database-tunnel` service opens a listener for a service that tunnels
connections to a database server.
The tunnel authenticates connections for the client, meaning that any
application which can connect to the listener will be able to connect to the
database as the specified user. For this reason, we heavily recommend using the
Unix socket listener type and configuring the permissions of the socket to
ensure that only the intended applications can connect.
```yaml
# type specifies the type of the service. For the database tunnel service, this
# will always be `database-tunnel`.
type: database-tunnel
# listen specifies the address that the service should listen on.
#
# Two types of listener are supported:
# - TCP: `tcp://<address>:<port>`
# - Unix socket: `unix:///<path>`
listen: tcp://127.0.0.1:25432
# service is the name of the database server, as configured in Teleport, that
# the service should open a tunnel to.
service: postgres-docker
# database is the name of the specific database on the specified database
# service.
database: postgres
# username is the name of the user on the specified database server to open a
# tunnel for.
username: postgres
```
### Destinations
A destination is somewhere that `tbot` can read and write artifacts.