mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-04 02:21:02 +08:00
* Add own-CA instructions to self-hosted DB guides Closes #14728 In guides where we show how to configure Teleport to protect a self-hosted database that uses mTLS to communicate with the Database Service, show how to configure the Database Service to trust a custom CA. This includes the following self-hosted database guides: - Postgres - Vitess - MySQL - Elasticsearch - ClickHouse - Standalone Redis - Standalone MongoDB - Cassandra/Scylla - Oracle This change does not touch guides that: - Already include instructions to configure the Database Service to trust a custom CA via the `ca_cert_file` config field, e.g., the CockroachDB and Redis cluster guides. - Use a different authentication mechanism, e.g., the SQL Server PKINIT guide. * Respond to feedback - Change `db-client` to `db_client` in commands beside `tctl auth export`. (greedy52) - Use consistent Proxy Service example addresses in the Clickhouse guide. (Tener) - Fix wording around the function of a CA. (GavinFrazar) - Clarify remote `tctl` permissions in partials. (GavinFrazar) - Clarify the need for `Db` impersonation privileges. (GavinFrazar) * Update docs/pages/includes/database-access/self-hosted-introduction.mdx Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com> * Respond to greedy52 feedback - Edit `tctl-auth-sign-3-files.mdx` to instruct the user to append the database client CA to your database's existing cert file. - Use Tabs for tctl-auth-sign-3-files.mdx --------- Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>
Teleport Docs
Teleport docs are built using Next.js. Please see the README in the docs repo for details on how to make and test changes to Teleport docs.
Linting and checking for bad links
Run make -C build.assets test-docs from the root directory of this repo.