Commit Graph
3274 Commits
Author SHA1 Message Date
Marco Dinis c4d4fca4d9 Docs: prefer v3 for teleport.yaml config examples (#41593) 2024-05-15 17:01:44 +00:00
Edward DowlingandPaul Gottschling 3da49b70ee Add more clarification to ServiceNow plugin setup docs (#41530)
* Add more clarification to ServiceNow plugin setup docs

* Update docs/pages/access-controls/access-request-plugins/servicenow.mdx

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-05-15 15:02:45 +00:00
M.C.M 39e1d96a47 mTLS in fedramp (#41565)
* mTLS in fedramp

* mTLS in fedramp edit
2024-05-15 10:31:05 +00:00
Marco Dinis 8525347113 Docs: AWS OIDC Integration set up guide (#41265)
* Docs: AWS OIDC Integration set up guide

* add examples

* review

* add no ops required

* improve how it works
2024-05-15 07:46:07 +00:00
Gavin Frazar 3ac0a0e4f2 update db guide introductions (#41442) 2024-05-14 22:55:38 +00:00
Paul Gottschling 127184f0a8 Break up /database-access/guides/ (#38574)
* Break up /database-access/guides/

Closes #17641

Organize the guides to enrolling databases in specific cloud providers
(or self-hosted databases) into separate subsections of the "Database
Actions" section, organized by cloud provider (or self-hosted).

We can later add general information to the index page of each
subsection about how Teleport database access works for each cloud
provider. The remaining guides in the "Guides" subsection have to do
with database-agnostic functionality of the Teleport Database Service.

This change also adds a redirect for each page it moves.

* Respond to greedy52 feedback

- In the "Database Access" intro page, move the self-hosted section
  first in the list of links to database-specific guides so it's less
  easy to miss.
- Change "AWS" to "Amazon" in product names.

* Fix linter issues

* Remove redirects added by the DB guide reorg

This prevents us from running into Vercel route limit issues, since the
number of redirects is large.
2024-05-14 20:44:59 +00:00
Gavin Frazar e1c47c0f21 fix docs step numbering (#41508) 2024-05-14 19:16:18 +00:00
Marco Dinis 6e80db34b7 Docs: fix typo in backend reference (#41513) 2024-05-14 14:28:43 +00:00
Zac Bergquist 408d6010e3 docs: add new troubleshooting steps to verify client certs on Windows (#41496) 2024-05-14 01:34:42 +00:00
M.C.M ecb09f133d Fedramp updates (#41344)
* fedramp updates

* fedramp updates

* fedramp updates - post-review v1

* fedramp updates - post-review v2
2024-05-13 23:09:51 +00:00
Paul Gottschling 6a09eb7793 Remove VarList instances from the docs (#41491)
Closes #41443

The VarList component has failed to render for a long time (at least six
months). Since the component has not received widespread adoption in
docs pages, remove instances of the component in preparation for
removing the component itself from the docs engine.
2024-05-13 21:43:08 +00:00
Jakub NyckowskiandRoman Tkachenko 98d6e2765d Update Access Graph Docs (#41307)
* Update TAG docs

* Update images

* Update docs

* Update images
Add EC2 instances to supported AWS types

* Linter fixes

* Update docs/pages/access-controls/access-graph.mdx

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

* Update TAG version

---------

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2024-05-13 20:07:35 +00:00
Noah StrideandPaul Gottschling 428460f535 Add Machine ID Manifesto to the docs (#41257)
* Add Manifesto verbatim

* Add link to manifesto from introduction

* Add manifesto to navbar

* Reword slightly

* Further tidy up the copy

* Tidy up further reading description

* Use "increasingly" decreasingly

* Try to break up "distinct identity" and "liable to exfiltration"

* Update docs/pages/machine-id/introduction.mdx

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

* Further refine manifesto intro

* Avoid using term "powerful"

* cspell "automations"

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-05-13 16:39:30 +00:00
Steven Martin 2001a89e16 docs: updates recommendation for commercial editions help (#41468)
* docs: updates recommendation for commercial editions help

* docs: update support site ref to support portal
2024-05-13 15:15:53 +00:00
Noah Stride 87bf2d4131 Machine ID: Basic Unix Workload Attestation (#41254)
* Log UDS sourced peer info

* Add logging of peer address when non-unix

* Properly group logging attributes when svid is issued

* Add config structs for unix workload attestation and tests

* Add test for entire bot config

* Return `PermissionDenied` when no SVIDs available as per SPIFFE Workload API 5.2.1

* Filter down SVIDs based on workload attestation

* Add improved logging

* Add basic unit test

* Add e2e test that uses workload attestation

* Document workload attestation features
2024-05-13 09:10:08 +00:00
Zac Bergquist fad0d23b1f docs: add desktop troubleshooting step to check for conflicting software (#41427)
Some third-party security tools override the default Microsoft smart
card driver with custom software. These custom drivers can prevent
Windows from reading certificates from Teleport's virtual smart card,
which prevents the automatic logon process from completing.
2024-05-10 23:02:28 +00:00
Isaiah Becker-Mayer 0d45cee246 add the "v" prefix in front of teleport version to correct links (#41380) 2024-05-10 22:24:03 +00:00
Steven Martin cc2316c5ab docs: openssh ssh example update (#41407) 2024-05-10 15:33:02 +00:00
Alex McGrath 65459e872e Remove support for disabling second factor authentication (#40956)
* dont allow disabling second factor

* update docs for 2fa change

* add environmental variable to work around disabled 2fa

* check if its cloud

* update todos

* add a test

* introduce insecure test mode

* fixes for tests
2024-05-10 11:57:34 +00:00
Paul GottschlingandGavin Frazar f893ecbb29 Add own-CA instructions to self-hosted DB guides (#39924)
* 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>
2024-05-09 18:38:05 +00:00
STeve (Xin) Huang d70274a776 [docs] remove steps to download isrgrootx1.pem for MongoDB atlas (#41366) 2024-05-09 18:32:23 +00:00
Steven MartinandPaul Gottschling dadc276273 docs: update tsh config cli description (#39286)
* docs: update tsh config cli description

* docs: tsh config verbiage update

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-05-09 17:47:44 +00:00
Alan Parra bf16543425 Update public docs for device trust web (#41334)
* Update device trust support notice

* Update prerequisites

* Update troubleshooting

* Remove Web UI warning

* Update the App Access section

* Add the Desktop Access section

* Mention Teleport v16 on App Access content

* Mention that the services do the enforcement
2024-05-09 15:20:41 +00:00
Steven Martin 4f19d90814 docs: update faq tls routing question for ease of use (#40640)
* docs: update faq tls routing question for ease of use

* docs: spelling ignore

* docs: variable name fix

* docs: code styling fix
2024-05-09 14:52:34 +00:00
Tiago Silva ee42b77138 Allow configuring clusterDomain in teleport-cluster helm chart (#41311)
This PR allows users to set `clusterDomain` to match Kubernetes Cluster
domain address when running clusters with non default cluster domains.

Fixes #41165

Signed-off-by: Tiago Silva <tiago.silva@goteleport.com>
2024-05-08 18:21:48 +00:00
Zac Bergquist 22138c2146 docs: add local user password policy (#41234)
Also removes the outdated mention of locking accounts after failed
password reset attempts. This functionality was removed in #35325
but the docs were not updated.

Closes #41135
2024-05-07 22:14:03 +00:00
Paul Gottschling c3614f01e0 Remove the "Preview" note from Access Graph docs (#41238) 2024-05-07 18:50:44 +00:00
Forrest df61cf18a5 add condition check dynamo permission to docs (#41156)
* add condition check dynamo permission to docs

* update changelog
2024-05-07 14:35:25 +00:00
Ben ArentandPaul Gottschling 2f774fd4f9 Docs: Teleport Panther Guide (#40736)
* wip Panther guide

* extra formatting and content updates

* Apply suggestions from code review

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

* extra content updates, note machine id can't impersonate

* Update Panther Docs and Image

* Extra copy tweaks

* Update Var Fomatting

* switch to code to show formatting

* cluster vars isn't working for this code segment, change back

* Fix cspell lint

* switchout image

* Apply suggestions from code review

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-05-06 20:26:32 +00:00
STeve (Xin) Huang 978106414f [docs] Update DB access AWS IAM reference page (#38881)
* [docs] Update DB access AWS IAM reference page

* add other aws databases

* reword and fix a few spots

* remove please and add the for service

* address review coments

* fix spelling

* fix link
2024-05-06 18:04:31 +00:00
Steven Martin 9e531fb4dc docs: update identity links in edition comparsion (#41181)
* docs: add session and identity lock link to edition comparsion

* docs: include access monitoring link

* docs: fix access monitoring link
2024-05-03 16:44:03 +00:00
Evan Freed ab62ef7179 docs: bump cloud version to 15.3.0 (#41024)
* docs: bump cloud version to 15.2.5

Prep for cloud upgrade.

* bump to 15.3.0

Signed-off-by: Evan Freed <evan.freed@goteleport.com>

---------

Signed-off-by: Evan Freed <evan.freed@goteleport.com>
2024-05-03 13:42:51 +00:00
Hugo Shaka 8399e0b1c4 generate chart references from values (#41167)
* generate chart references from values

* fixup! generate chart references from values

* Make documentation linter happy

* Fix jira values + bad slack copy-paste
2024-05-02 20:58:56 +00:00
Logan Davis f2ea652e8e Fix minor issue with athena backends documentation (#41122) 2024-05-02 14:20:30 +00:00
Steven Martin 31fdd59c3c docs: update rds db proxy access instructions (#41052)
* docs: update rds db access instructions

* docs: fix command for configure
2024-04-30 16:14:53 +00:00
Andrew Burke 2acf477119 Add auto role request docs (#41030) 2024-04-30 16:02:51 +00:00
Noah StrideandPaul Gottschling 472ff77adc Document TPM join method (#40864)
* Add TPM to join method reference page

* Skeleton out the Linux/TPM guide

* Add yaml for join token

* Flesh out TPM joining guide

* Try var

* Add note on FIPS 140-2 compliance

* Add more vars

* ADd more background to how TPM joining works

* Clarify statement on most secure

* Add `tbot tpm identify` to cli reference

* Rename background to `how it works`

* Update docs/config.json

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

* Update docs/pages/includes/tpm-joining-background.mdx

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

* Update docs/pages/includes/tpm-joining-background.mdx

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

* Update docs/pages/includes/tpm-joining-background.mdx

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

* Update docs/pages/machine-id/deployment/linux-tpm.mdx

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

* Use Create A Bot template

* Expand TPM

* Reword tpm joining background

* Fix trailing ,

* Mention enterprise licensing

* cspell

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-04-30 10:36:22 +00:00
Noah StrideandGavin Frazar 590407de51 Use Bot resource in Machine ID deployment guides (#40944)
* Use bot yaml resource in machine id deployment guides

* Update the number for the k8s guide steps

* Update docs/pages/includes/machine-id/create-a-bot.mdx

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

* Update docs/pages/includes/machine-id/create-a-bot.mdx

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

* Update docs/pages/machine-id/deployment/spacelift.mdx

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

* Update docs/pages/machine-id/deployment/spacelift.mdx

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

* Fix heading level

---------

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>
2024-04-30 09:21:17 +00:00
Noah StrideandPaul Gottschling ef3ee8ea4d Add database-tunnel service to Machine ID reference (#40993)
* 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>
2024-04-29 19:05:00 +00:00
rosstimothy 3c0e27b4f8 Update proxy templates to support resource filtering (#40918)
Historically proxy templates have only supported an exact hostname
match via the `Host` field defined. This limits some of the benefits
of using proxy templates and forces users to do a bunch of extra
work in their ssh config. For example, if a user today wanted to
leverage proxy templates to connect to a host via a label, predicate
expression, or fuzzy match, they would be required to use tsh ls,
find the matching UUID or hostname and provide that to tsh for
evaluation with the template expression.

SSH Config:
```
Match Host *.example.com
    ProxyCommand tsh proxy ssh  %r@$(tsh ls --search=$(echo %h | cut -d. -f1) -f json | jq -r '.[0].metadata.name'):%p
```

The above requires multiple subshells, a connection to the Auth
server, and jq to be installed on the client machine in order to
work.

To reduce the amount of effort required to connect to a resource
proxy templates have been updated with a `Search` and a `Query`
field to support fuzzy search and predicate expressions much like
`tsh ls --search` and `tsh ls --query`. The order of operations
for matching the target host is: 1) Host, 2) Predicate Expression,
3) Query.

In addition to the proxy template changes, tsh proxy ssh
has also been updated to allow resolving the target via
searching or querying -- though ONLY via proxy templates.
There are no additional `--query` or `--search` flags added
to tsh proxy ssh for the time being. This is mostly for CLI UX
reasons since neither tsh ssh or tsh proxy ssh support those
flags today, and only allow filtering by label via supplying
key value pairs in the hostname  (tsh ssh alice@foo=bar,env=dev).

tsh proxy ssh is however still limited to connecting to a single
host at a time. If there are no matches, or multiple matches found
as a result of target resolution, then an error is returned.

With the new functionality, the above example can be simplified to
the following.

SSH Config:
```
Match Host *.example.com
    ProxyCommand tsh proxy ssh  %r@%h
```

Proxy Template:
```
- template: '^(.*).example.com:\d+$'
  search: "$1"
```

This shifts the resposibility of host resolution from the caller
to tsh. It allows resolution to happen in the same process that
will initiate the connection, reducing a dial to the cluster, and
eliminating the need for any subshells, or extra tools outside
of tsh to be present.
2024-04-26 19:44:47 +00:00
Hugo ShakaandNiek den Breeje 13e9d2f2da charts/teleport-cluster: configurable podSecurityContext (#40945)
* Configurable podSecurityContext for auth and proxy deployments

* Lint podSecurityContext for Teleport Cluster chart

* Test podSecurityContext for auth and proxy deployments

* PodSecurityContext schema for Teleport Cluster chart

* Document podSecurityContext for Teleport Cluster chart

---------

Co-authored-by: Niek den Breeje <n.denbreeje@guardian360.nl>
2024-04-26 14:21:42 +00:00
Hugo Shaka 21347e95b8 Add Access Monitoring configuration to the chart (#40765)
* Add Access Monitoring configuration to the chart

* fix configuration
2024-04-26 14:21:39 +00:00
Hugo Shaka bdba571a29 Add extra volumes to the teleport updater (#40915)
* add volume mounnts in kube-agent updater

* update docs
2024-04-26 13:18:05 +00:00
Bernard KimandPaul Gottschling 4db79cad57 Add flux deployment workaround (#40881)
* Add flux deployment workaround

* Apply suggestions from code review

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

* Specify teleport-kube-agent chart

* Add cspell ignore

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-04-25 23:54:25 +00:00
Brian Joerger ce242ae40d Support agentless connections with hardware key support (#39267) 2024-04-25 22:45:00 +00:00
Hugo Shaka 22c1483945 Render slack chart reference from values (#40374)
* Render slack chart reference

* Show the plugin in the repo index

* fix broken doc syntax

* fix link

* fix link
2024-04-25 19:50:33 +00:00
STeve (Xin) Huang 7e640fbbf0 Document Azure CLI setup for AKS with Entra Workload ID (#40635)
* Document Azure CLI setup for AKS with Entra Workload ID

* add How it works section

* address review comments from Tener

* address comments from Paul

* try to fix lint and add version info
2024-04-25 16:48:18 +00:00
Hugo Shaka 1352a8db0a add extraLabels support (#40884) 2024-04-25 16:28:17 +00:00
Steven Martin 7cd5715733 docs: update quotes in code block for gcp workforce identity (#40879) 2024-04-24 20:30:24 +00:00
Rafał Cieślak 453bb211d4 docs: Use db-client instead of db_client for tctl auth export (#40867) 2024-04-24 18:05:51 +00:00