teleport-actions/Teleport Database Tunnel
Opens a local tunnel in the background of your workflow to a database protected by Teleport.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| anonymous-telemetry | Enables anonymous telemetry. See https://goteleport.com/docs/machine-id/reference/telemetry/ for more information. | no | — |
| ca-pins | Specifies one or more trusted CAs to initially validate the identity of the Auth Server when connecting directly to it. This is not required for Teleport Cloud or when connecting via a Teleport Proxy | no | — |
| certificate-ttl | Specify the length that the generated credentials should be valid for. Defaults to "1h" | no | — |
| database | Specify the name of the database within the Teleport database service to which a connection should be opened | — | — |
| diag-port | Specify an alternative port for the diagnostics service. | no | 57263 |
| disable-env-vars | Disables the automatic setting of environment variables like`TELEPORT_IDENTITY_FILE` by the action. This can be useful in more complex workflows where multiple identities are being used. | no | — |
| listen | Specify a listener URI for the local tunnel, e.g. tcp://localhost:1234 | yes | — |
| proxy | Specify the address of your Teleport Proxy. | yes | — |
| service | Specify the name of the Teleport database, generally the resource name in Teleport. | yes | — |
| timeout-ms | The maximum amount of time to wait in milliseconds for the tunnel to become ready. Set to 0 to skip waiting. | no | 30000 |
| token | Specify the Teleport token to use to join. | yes | — |
| username | Specify the name of the database user that should access the database. | — | — |
Outputs
no outputs