Commit Graph
49 Commits
Author SHA1 Message Date
STeve (Xin) Huang b043372f40 [docs] GCP MySQL IAM authentication support (#38943)
* [docs] GCP MySQL IAM authentication support

* review comments

* remove legacy OTP flow

* address review comments
2024-03-07 20:40:15 +00:00
STeve (Xin) Huang c26314652a [docs] IAM-auth-as-IAM-roles for Redshift (#34940)
* [docs] IAM-auth-as-IAM-roles for Redshift

* new section for iam role auth

* clarify two methods

* review comments

* fix spelling, thanks to docs lint!
2024-02-01 16:52:50 +00:00
Krzysztof Skrzętnicki 71fd30e251 Add Vitess guide (MySQL protocol) (#35650)
* Add Vitess guide (MySQL protocol)

* Update cspell
2023-12-13 11:57:22 +00:00
Paul Gottschling 683d99a0c8 Update diagrams in the docs (#35143)
* Update diagrams in the docs

Closes #31324

We introduced a new Lucidchart library for adding diagrams to docs
pages. This change:

- Replaces all MermaidJS diagrams with ones that use the new library,
  which enables us to phase out the `remark-mermaid` plugin.
- Replaces some other diagrams with the new library.

* Minor tweaks to diagram images

Responds to strongeron feedback
2023-12-04 21:50:09 +00:00
Paul Gottschling 732b9bbf58 Remove unused images from the docs (#32164)
Used the following command to find unused images. This lists all image
files in the docs and, for each image, searches all docs pages for
references to the image file (which include the `/img` path segment but
usually not `docs`). If there are no matches, it prints the image file
name:

```bash
$ find docs/img -name "*.png" | sed -E "s|docs/(.*)|\1|" | xargs -I{} bash -c '
grep -qR "{}" docs/pages; if [ $? -ne 0 ]; then echo {}; fi'
```

Also fixes a minor linter error that did not come up in earlier commits.
2023-09-20 18:12:08 +00:00
Marek Smoliński 70238be048 [docs] Self-hosted ClickHouse Database Access (#28460) 2023-09-12 22:32:38 +00:00
STeve (Xin) Huang d617f1cb91 [docs] add Discovery Service to Database Access architecture page (#30569)
* [docs] add discovery service to Database Access architecture page

* code review comments
2023-08-18 13:42:26 +00:00
Gabriel CoradoandPaul Gottschling 5a4c3d3ea6 MongoDB Atlas IAM authentication docs (#26831)
* docs(db): add section on how to configure mongo atlas aws iam auth

* Apply suggestions from code review

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

* docs(mongodb-atlas): code review changes

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-06-06 16:44:06 +00:00
Gavin FrazarandAlex Fornuto b93abb2053 Add IAM auth info to ElastiCache guide (#26989)
* Add IAM auth info to ElastiCache guide

* Update docs/pages/database-access/guides/redis-aws.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

---------

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-06-02 18:37:27 +00:00
23573a8d89 Uncomment Mermaid diagram specs (#26366)
* Uncomment Mermaid diagram specs

Two guides include Mermaid diagram specifications that were commented
out until production docs builds supported Mermaid. This change
uncomments the diagram specs.

* replace pngs with mermaid and rm

* remove outdated warning

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
Co-authored-by: Steven Martin <steven@goteleport.com>
2023-05-22 15:08:09 +00:00
affe590597 docs: Add Msft SQL Server client examples and link in sql server guide (#23263)
* Add Msft SQL Server client examples and link in sql server guide

* Apply suggestions from code review

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

* put sql server connection details in table

* Update docs/pages/connect-your-client/gui-clients.mdx

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* update desription of db client tools

* correct capitalization

* remove extra space

* rename jpg file to fix spelling check

* optimize images

* verbiage updates

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* include note in pk sql server

* column length fixes

* change to using same include for sql server connect note

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-05-18 15:47:52 +00:00
STeve (Xin) Huang 9619c6ae50 [docs] Amazon Athena guide for Application Access (#25329)
* [docs] Amazon Athena guide for Application Access

* review comments

* update cspell.json

* Alex's comment and fix lint
2023-05-18 13:02:25 +00:00
Marek Smoliński 348d999f25 docs: AWS OpenSearch (#26008) 2023-05-11 08:03:44 +00:00
Marek Smoliński 31e1a1ec82 docs: Oracle Database Access (#23925) 2023-04-05 14:55:24 +00:00
Andrew Burke 91a6dea62a Add Azure auto-join docs (#22752)
This change adds documentation for Azure VM auto-joining.
2023-03-31 22:38:44 +00:00
STeve (Xin) Huangandalexfornuto e2fbeacf97 Docs: AWS RDS Proxy Guide (#21322)
* init RDS proxy guide

* update diagram

* update doc

* add missing png

* copy edits...

Minor phrasing adjustment, replaced scoped blocks for cloud with Vars, fixed code fencing for commands and json

* RDS Proxies -> RDS Proxy instances

* database agent -> Database Service instance

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-07 14:32:26 +00:00
816038605b New guide: AWS DynamoDB with Database Access (#19956)
* move application-based dynamodb guide

* update and move images

* init new dynamo guide

* Apply suggestions from code review

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* updates based on review

* Add NoSQL workbench to gui clients doc

* cluster > plane

* add redirect for dynamo through app access

* gui-client cleanup

* Update docs/pages/database-access/guides/aws-dynamodb.mdx

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* Apply suggestions from code review

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* update labs link

* Apply suggestions from code review

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* updates based on review

* Apply suggestions from code review

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

* move service nodes into AWS cloud

* edits based on review feedback

* clarify AWS IAM roles

* Adjust explanation of user role

* reference generated token

* Move dynamic registration to next steps

* explain advantage to DynamoDB through App service

* merge conflict resolution

* clarify database region restrictions

---------

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 18:42:18 +00:00
a5909b016c [Docs] Redshift Serverless Guide (#20168)
* init Redshift Serverless guide

* Apply suggestions from code review

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Update docs/pages/database-access/guides/redshift-serverless.mdx

* update for review feedback

* Apply suggestions from code review

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

* update based on review feedback

* clarify ambiguous pronoun

* Apply suggestions from code review

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

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 16:43:56 +00:00
e9b774f731 [Docs] Update Azure Postgres/MySQl guide for Flexi (#20504)
* update Azure identity screenshots

* update databse config partial

* Update Azure database guide for flexible servers

* modify partial for inter-page use

* Apply suggestions from code review

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* post-review edits

* Update docs/pages/database-access/guides/azure-postgres-mysql.mdx

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* Apply suggestions from code review

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

---------

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 15:46:19 +00:00
Gabriel Coradoandalexfornuto 2ec17fd7e6 Update Azure SQL server guide (#20705)
* docs(database-access): update Azure SQL server guide

* make bullet notation consistent

* consistent parentheticals

* copy edits

* optimize image for web

* feat(docs): update system managed identity image

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-01-30 14:26:35 +00:00
Gabriel Coradoandalexfornuto c746ab6b30 Azure SQL Server auto-discovery documentation (#19100)
Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2022-12-08 13:06:39 +00:00
Alex Fornuto 32408a0a81 spelling, typos, and non-example nouns fixed (#18943) 2022-12-01 16:57:10 +00:00
Marek Smoliński 1b333577a1 Add Cassandra and ScyllaDB docs (#17833) 2022-11-08 10:43:02 +01:00
Gabriel Corado 4a68f6e346 Azure AD user managed identity authentication for SQL server documentation (#17693) 2022-11-01 23:39:43 +00:00
STeve (Xin) Huang b696ca12a3 Documentation for Azure Cache for Redis (Database Access) (#17387) 2022-10-27 20:32:25 +00:00
17cdeadd74 [Docs] Database Access for Elastic Guide (#17393)
* sort list of db guides alphabetically

* add Elastic guide

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* additional edits from review

* add spaces to next steps include

This is so that additional ul items added to a guide using this partial will have consistent spacing

* remove instructions and add tip

Resolves #r995144908 and #r995566035

* fix Database Access config and add scopes

* Move note into relevant tab

* adjust example user mapping

* incorporate more feedback

* incorporate feedback from @tener

* Update docs/pages/database-access/guides/elastic.mdx

Co-authored-by: Krzysztof Skrzętnicki <krzysztof.skrzetnicki@goteleport.com>

* bypass linter rule

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Krzysztof Skrzętnicki <krzysztof.skrzetnicki@goteleport.com>
2022-10-25 15:05:14 +00:00
a90334f48c azure mysql postgres auto discovery docs (#15986)
* Add screenshots for azure IAM setup

* Update azure mysql postgres guide to explain discovery

* Update db service config yaml reference

* Update docs/pages/database-access/guides/azure-postgres-mysql.mdx

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Fix typo in admonition type

* Redact IDs in azure screenshots

* Clarify that role assignment applies to either principal type

* Advise restarting db service after checking credentials

* optimize images

* Update docs/pages/database-access/guides/azure-postgres-mysql.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Update docs/pages/database-access/guides/azure-postgres-mysql.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Update docs/pages/database-access/guides/azure-postgres-mysql.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Co-authored-by: alexfornuto <alex@fornuto.com>
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2022-09-20 05:24:32 +00:00
Paul GottschlingandAlex Fornuto dc371d91b6 Update the CockroachDB logo in our guide (#15978)
Using the company's new logo.

Co-authored-by: Alex Fornuto <github@alexf.co>
2022-09-06 23:34:24 +00:00
STeve (Xin) Huang 4aeb9ea441 Documentation for AWS DynamoDB guide (#14319) 2022-08-10 16:34:01 +00:00
STeve (Xin) Huang cfbea378c3 Documentation for ElastiCache (#13133) 2022-06-30 16:10:57 +00:00
Jakub NyckowskiandPaul Gottschling a3bc24e28b Add Snowflake integration docs (#12816)
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-06-30 02:53:19 +00:00
0fcaf92d25 Fix resource links (#12840)
* Fix resource links

Fixes #12839

Some video links still refer to the outdated "/teleport/" path.
This change adds the videos these links refer to to the "img"
directory and updates the links.

Note that two of the three MDX files that are changed here do not
actually render the video. I've changed the links here anyway in
case someone uses these as a reference for the link format.

* Apply suggestions from code review

Co-authored-by: Ben Arent <ben@goteleport.com>
Co-authored-by: Roman Tkachenko <roman@goteleport.com>

Co-authored-by: Ben Arent <ben@goteleport.com>
Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2022-06-10 20:59:59 +00:00
Steven Martin 1304d69fe3 Include Teleport agent installation instructions for App,DB Guides (#12171)
* Include installation instructions for Teleport DB and App service.  Added diagrams to db and app.
2022-04-29 02:49:15 +00:00
Gabriel Corado c8502b3af4 Update DBeaver guides to use authenticated local proxy. (#12037)
* docs(db): add postgres DBeaver guide

* docs(db): update mysql and sql server dbeaver guides
2022-04-19 10:44:27 -03:00
86ad572b78 Add Redis docs (#10693)
Add Redis documentation on how to setup Redis.

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Marek Smoliński <marek@goteleport.com>
2022-03-11 18:05:13 +00:00
Roman Tkachenko 8ea2c70996 Add SQL Server guide (#10293) 2022-02-18 22:37:29 +00:00
Roman Tkachenko bd01152781 Add guide for Azure Postgres/MySQL database access (#9729) 2022-02-01 23:38:39 +00:00
STeve Huang adf7200787 Documentation update for Redshift auto discovery support (#9990) 2022-02-01 14:42:47 +00:00
Roman Tkachenko 21e48b2549 Update docs for TLS routing (#9048) 2021-11-22 13:29:36 -08:00
Roman Tkachenko e1774a8f8b Add dynamic registration and discovery guides (#8694) 2021-11-04 15:52:35 -07:00
Alen 93934eff16 Db access gui client improvements (#7950)
* Modifying db GUI guides to include pgAdmin Windows access and DBeaver MySQL access instructions
* Cert to Certificates to match screenshot
* Clearing up wording for readability and adding mysql.dbeaver_min_ver to config.json
2021-09-11 17:45:51 -07:00
Roman Tkachenko 346941c755 Add MongoDB Atlas guide (#7864) (#7951) 2021-08-17 15:05:02 -07:00
Roman Tkachenko 7bc95b7c61 Add MongoDB Compass GUI guide (#7658) 2021-07-25 11:43:07 -07:00
Roman Tkachenko 0b0f631757 Add MongoDB guide, MySQL Cloud SQL guide and other 7.0 docs updates (#7350) 2021-07-12 09:12:21 +03:00
Roman Tkachenko fc713b7216 Application and database access documentation updates (#6932) 2021-05-18 17:03:49 -07:00
Alexey IvanovandAlexander Klizhentas ee4038812a Rename images to match logical pixels (#6381)
Co-authored-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-04-09 20:26:13 -07:00
Alexander Klizhentas cfd23e9417 Documents dual authz with Mattermost (#6400)
Add Cloud SQL guide
Update preview
2021-04-09 17:45:02 -07:00
Alexey IvanovandAlexander Klizhentas e7817e68f0 Optimize images (#6019)
Co-authored-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-03-16 21:25:19 -07:00
Alexey Ivanov fa4d7eb977 Update docs structure (#5849) 2021-03-04 10:07:48 -08:00