Commit Graph
301 Commits
Author SHA1 Message Date
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
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
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
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
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
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
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
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
Zac Bergquist 8cd1c429f5 Fix up some poor wording (#40832)
Closes #40294
Closes #39172
2024-04-23 22:01:41 +00:00
Roman Tkachenko 65d05fd28b Remove standalone Okta service docs (#40799) 2024-04-23 15:27:27 +00:00
Taras 18e3fd1e18 helm: Expose flag to enable/disable passwordless auth (#40651)
* helm: Expose flag to enable/disable passwordless auth

* Add lint/snap for "passwordless"

* Use relative link
2024-04-22 14:34:17 +00:00
Steven Martin 362ce97707 docs: add tctl inventory to CLI ref (#40615)
* docs: add tctl inventory to cli ref

* docs: correct version variable reference

* docs: spell fixes for tctl inventory clis

* docs: applied suggestions

* docs: lint fix

* docs: lint fix

* docs: update verbiage for inventory listing note
2024-04-18 10:45:11 +00:00
Anton MiniailoandHugo Shaka 7ec26dd1fb Mention in the documentation that we ignore "kube-system" and "kube-public" namespaces for kube app discovery (#40529)
* Mentioned in the documentation that we ignore "kube-system" and "kube-public" namespaces for kube app discovery.

* Use admonition

Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>

* Rerender kube agent docs

---------

Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
2024-04-12 22:21:01 +00:00
Ben Arent b50eecbb42 Broken External Links (#40235) 2024-04-04 23:02:15 +00:00
Krzysztof SkrzętnickiandPaul Gottschling cfc1222bfb [docs] Database Access Controls (#39109)
* Documentation: Database object permissions

* Address review feedback

* Add note about admin user permissions

* Review feedback

* Address review feedback

* Suggest clarifications in the introduction (#39725)

Add more context around what a database object is.

* fix lint

* Update feature name

* clarify import process description

* rephrase

* minor changes

* typo/cspell fixes

* silence misguided warning

* lint disable

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-04-04 10:31:01 +00:00
rosstimothy 4e1c604b32 Add support for exact matching on an element in a delimited label (#40166)
Updates the resource parser with two new functions: `contains` and
`split`. When used together they provide the ability to
search for resources that have labels with multiple values in a
delimited list. For example, if a resource has label `foo=bar,baz,bang`
then `split(labels[foo], ",")` would transform the
comma label value from a string into a list: ["bar", "baz", "bang"]
The list could then be fed to `contains` to determine if bar exists
in the list: `contains(split(labels[foo], ","), bar)`.
2024-04-03 17:17:37 +00:00
Paul Gottschling b5c8c1396e Clarify environment vars in the teleport unit file (#40018)
Closes #38824

In the Networking reference, the discussion of environment variables
didn't make it sufficiently clear that `/etc/default/teleport` is the
environment file specified in the Teleport unit file.

This change includes the unit file to make it more explicit how the file
uses `/etc/default/teleport`.
2024-04-01 22:31:07 +00:00
Hugo Shaka e77e5e080b Allow the operator chart to deploy CRDs separately (#39382) 2024-03-27 20:37:20 +00:00
Hugo Shaka 9784347b26 helm: support Athena backend (#39801)
* add aws athena support

* update reference

* improve test readability

* address feedback
2024-03-27 16:02:05 +00:00
Noah StrideandPaul Gottschling a3097a00d9 Modify tbot docs to show --proxy-server/proxy_server in preference to --auth-server (#38925)
* Modify `tbot` docs to show `--proxy-server`/`proxy_server` in preference to `--auth-server`

* Apply suggestions from code review

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

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

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-03-18 09:58:36 +00:00
Andrew Burke a79ad92f52 Update testplan and docs (#38942) 2024-03-15 23:50:47 +00:00
Steven MartinandEdoardo Spadolini 3e7b51b541 docs: advise cockroachdb storage backend requires enterprise (#39332)
* docs: advise cockroachdb storage backend requires enterprise

* update wording

Co-authored-by: Edoardo Spadolini <edoardo.spadolini@goteleport.com>

---------

Co-authored-by: Edoardo Spadolini <edoardo.spadolini@goteleport.com>
2024-03-14 15:06:08 +00:00
13ceef6f4e docs: cockroachdb storage backend configuration (#37880)
* docs: cockroachdb storage backend configuration

* fix missing code block end quotes

* Update docs/pages/reference/backends.mdx

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

* Update crdb deploy and config references

* Update docs/pages/reference/backends.mdx

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

* Update docs/pages/reference/backends.mdx

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

* Update docs/pages/reference/backends.mdx

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

* Fix auth server lint

* Fix spellcheck lint

* Update docs/pages/reference/backends.mdx

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

* Update docs/pages/reference/backends.mdx

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

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Alexander Klizhentas <klizhentas@gmail.com>
2024-03-10 18:57:35 +00:00
Paul Gottschling 176935cbfa Remove Teleport Team mentions from the docs (#38940)
- Remove the `team` scope from config.json.
- Edit the Edition comparison table to remove the "Team" column.
- Change the Teleport Team getting started guide to a Teleport
  Enterprise Cloud getting started guide.
- Remove other Teleport Team mentions from the docs.
2024-03-05 17:17:15 +00:00
Edoardo Spadolini 20e076477c Tweak docs to account for the timeout in SIGHUP/SIGQUIT (#38870) 2024-03-01 18:19:05 +00:00
Paul Gottschling 91480dae09 Add a Discovery Service section (#38848)
* Add a Discovery Service section

Closes #38741

Add a dedicated sidebar section for the Teleport Discovery Service.
Since the Discovery Service is a separate agent service from the SSH
Service, Kubernetes Service, etc., it makes sense to add a dedicated
section for this service. In the future, we can include configuration
guides, architecture guides, etc. in this section.

To create the new section, this change moves existing auto-discovery
guides from other sections of the docs.

* Respond to hugoShaka feedback

- Move the Kubernetes application discovery docs
- Edit the "Kubernetes Access" intro to include a link to Kubernetes
  auto-discovery
2024-03-01 16:58:26 +00:00
Jeff AndersonandZac Bergquist 861dbba5d5 Add note about pgbouncer incompatibility (#37338)
* Add note about pgbouncer incompatibility

* PgBouncer instead of IMPORTANT

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

* Update cspell.json

add pgbouncer to cspell.json

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2024-02-23 15:11:07 +00:00
Steven Martin f7b88225f0 docs: document location of SQLite in Teleport data directory (#38379)
* docs: document location of SQLite in Teleport data directory

* docs: update verbiage

* docs: prose fix

* spell fix
2024-02-20 13:49:55 +00:00
Justinas StankevičiusandPaul Gottschling 74f264ac05 Add a guide for deploying TAG using Helm (#38266)
* Update TAG version to 1.11.0

* Add a guide for deploying TAG using Helm

* Fix prose lint

* Add auto-generated reference for TAG Helm chart

* Apply suggestions from code review

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

* Update TAG example role to v7

* Fix link to TAG Helm guide

* Pin TAG Helm chart version

Pins to the same version as TAG itself,
Helm chart and TAG are versioned in lockstep

* Call out the teleport Helm chart more explicitly

* Bump TAG version to 1.13.0

Expecting it to be released by the time these docs go live.

* Replace teleport-cluster parameters with Vars

* Elaborate trust of the TAG CA in Teleport

* Fix the marker style

* Fix the link to teleport-cluster reference

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-02-19 18:42:07 +00:00
Zac Bergquist 89d4a899bf Document the new screen_size field for windows desktops (#38048)
See #34580 for the associated implementation
2024-02-16 16:28:26 +00:00
Paul Gottschling 58d6953c4e Enforce "automatic update" (#38282)
See #36816

The docs are inconsistent in using "automatic updates" vs. "automatic
upgrades". Prefer the former to be consistent with the
`teleport-ent-updater` script.

- Replace "automatic upgrade" with "automatic update" in docs pages.
- Replace "automatic upgrade" uses in the `teleport-kube-agent` chart
  and regenerate the docs.
- Catch uses of "automatic upgrade" in the `consistent-terms` Vale rule
2024-02-15 19:56:48 +00:00
Paul Gottschling a53bef2bbb Fix SEO issues reported by SEMRush (#38161)
Fix an incorrect sitemap link. The Teleport docs engine generates the
sitemap based on the contents of `docs/pages`. This directory tree
included a file called `docs/pages/server-access/guides/openssh.mdx`,
but the `config.json` for the docs content included a redirect from this
page to `docs/pages/server-access/guides/openssh/openssh.mdx`, meaning
that a page in the sitemap became inaccessible.

This change fixes the `/server-access` section of the docs to resolve
the sitemap issue. To do so, it creates the `server-access/openssh`
directory and moves OpenSSH guides into this directory. It updates
`config.json` and the Server Access menu page accordingly.

This change also adds a missing meta description to the self-hosted
Access Graph guide.
2024-02-15 19:40:17 +00:00
Zac Bergquist d059e4c22b Address some outstanding docs issues (#38093)
* Add teleport join openssh to CLI reference

Closes #33516

* docs: move event handler config to /etc

Closes #37967

* Clarify use of tctl auth export

Closes #30920
2024-02-15 17:40:13 +00:00
Hugo ShakaandPaul Gottschling 90c5ea6e5b Document managing users, roles and accesslists through IaC (#36622)
* Document managing users, roles and accesslists through IaC

* reformat docs/config.json

* address feedback

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* align label names

* address feedback

* update teleportrole version

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-02-13 20:04:04 +00:00
6fafba9119 Update backend reference with working proxy configuration (#37934)
* Update backend reference with working proxy configuration

the local loopback does not work in this case.  After discussing internally, recommendation is to use 0.0.0.0 for the diag addr but with a warning this should NOT be exposed to the public internet or used on other instances

* Update backends.mdx

* Update docs/pages/reference/backends.mdx

Co-authored-by: Steven Martin <steven@goteleport.com>

* Update docs/pages/reference/backends.mdx

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

* Update backends.mdx

* Update docs/pages/reference/backends.mdx

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

---------

Co-authored-by: Steven Martin <steven@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2024-02-12 14:43:16 +00:00
rosstimothy 5ba0488858 Recommend on-demand mode and continuous backups in DynamoDB docs (#37920)
* Recommend on-demand mode and continuous backups in DynamoDB docs

Removes mention to provisioned mode and manually setting capacity
in favor of using on-demand mode. Enabling continuous backups was
also elevated into the main configuration reference since they are
strongly encouraged.

Additionally all occurrences of `back-end` were replaced with
`backend` to be consistent with all other usages.

* remove autoscaling references from aws chart docs
2024-02-08 17:36:18 +00:00
Hugo Shaka a2f748ccbb charts/kube-agent: support restricted PSS by default (#37821)
* charts/kube-agent: update secContext to support restricetd PSS

* re-render templates entirely
2024-02-06 18:37:36 +00:00
Steven Martin 06c1a05fae docs: include separate in helm reference for proxyListenerMode (#37733) 2024-02-05 15:52:28 +00:00
Hugo ShakaandRoman Tkachenko b8deacfaff update tf ref and changelog (#37590)
* update tf ref and changelog

* Apply suggestions from code review

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

* fix md

* typos

* typo2

* lint

---------

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2024-01-31 19:16:29 +00:00
Hugo Shaka 6841c77574 helm: make proxies replicable when usign an ingress (#37430) 2024-01-29 21:54:25 +00:00
Hugo Shaka 70b37da284 document role versions 5, 6 and 7 (#37360) 2024-01-29 16:57:48 +00:00
853297286f Add new tctl bots update command (#36496)
* Add new `tctl bots update` command

This adds a new command to update roles and logins for existing bots,
with flags to both set and append as desired.

changelog: Add new `tctl bots update` command to update bot roles and logins

* Pluralize "add-" flags for consistency

* Add docs for `tctl bots update`

Also merges in some other misc docs changes for `tctl bots ...`

* Fix docs lint

* Fix incorrect example

* Apply suggestions from code review

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

* Use the bot service's `UpdateBot()` RPC instead of modifying directly

This switches to use the new `UpdateBot()` RPC instead of modifying
the bot user and role directly. Also, tweaks CLI messaging to be a
bit less chatty.

* Update tool/tctl/common/bots_command.go

Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>

* Move set functions into their own reusable package

The set package adds a little extra functionality but is still
missing various important functions, like subset/superset,
difference, intersection, xor/symmetric difference, etc.

This changes the API slightly, so the tctl command is updated to use
the new package.

* Remove duplicate tests

* Reword flag help strings for clarity

* Remove set abstraction

Removes the Set package and unrolls all related function calls in
bots_command.

* Add unit tests for `updateBotLogins()` and `updateBotRoles()`

This also makes a minimal API wrapper interface for mocking.

* Use utils function to convert sets to a string slice

* Update docs/pages/reference/cli/tctl.mdx

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2024-01-22 22:17:26 +00:00