Commit Graph
282 Commits
Author SHA1 Message Date
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
Paul Gottschling 2ef3c0ccea Edit HTTP CONNECT environment var instructions (#35209)
Closes #34888

The example instructions for assigning environment variables to
configure HTTP CONNECT tunneling existed before Teleport installations
based on package managers configured a default systemd unit for
Teleport.

This change edits the instructions for assigning environment variables
for HTTP CONNECT tunneling to use the environment file already
configured within the default systemd unit.
2024-01-22 20:48:37 +00:00
Hugo ShakaandMarco André Dinis 70d58148eb Document always setting the resource version in Terraform (#36774)
* Document resource version in proto files

This will be useful when generating documentation from proto for the TF
provider. With this change, we will display which version value should
be set.

This change is required so we can make version mandatory in TF.

* docs: always set version when using the TF provider

* docs: re-generate the TF reference, with the version updates

* Apply suggestions from code review

Co-authored-by: Marco André Dinis <marco.dinis@goteleport.com>

* re-generate grpc client

* fix typos

* re-generate CRDs

---------

Co-authored-by: Marco André Dinis <marco.dinis@goteleport.com>
2024-01-18 16:49:05 +00:00
Hugo Shaka 32233e0fef integrations/updater: add support for private registries (#31285)
* integrations/updater: add support for private registries

* helm/kube-agent: support setting updater pull credentials
2024-01-16 19:55:21 +00:00
Noah Stride 2c8d699906 Add tctl bots commands to CLI reference (#36430)
* Add `tctl bots` commands to CLI reference

* sort in alphabateical order
2024-01-10 08:53:37 +00:00
Reed Loden 95aa537f68 Increase minimum password length and account lock interval (#36389)
* Increase `MinPasswordLength` from 6 to 12 characters
  - PCI DSS v4.0 control 8.3.6 requires a minimum password length of 12 characters.
  - NIST SP 800-63B section 5.1.1.1 requires a minimum password length of 8 characters.

* Increase `AccountLockInterval` from 20 to 30 minutes
  - PCI DSS v4.0 control 8.3.4 requires a minimum lockout duration of 30 minutes.

This will contribute to better supporting customers to meet certain compliance requirements.

Ref #1936.
Ref #7687.
2024-01-10 04:11:28 +00:00
Hugo Shaka 8ddcf241ad Warn about CPU limits in teleport-cluster Helm chart (#36251)
* Warn about CPU limits

* fixup! Warn about CPU limits
2024-01-04 16:25:12 +00:00
Paul Gottschling 064982fe0f Remove notes that the default cap is blank (#35982)
Closes #20993

This is inaccurate, as there are default `cap` values.
2024-01-02 22:08:52 +00:00
Hugo Shaka 401c1acaad update teleport-kube-agent reference + generate it (#35587)
* Update teleport-kube-agent documentation and generate its ref

* fixup! Update teleport-kube-agent documentation and generate its ref

* Re-render reference + fix false negative chart lint
2023-12-28 18:49:05 +00:00
Hugo ShakaandPaul Gottschling 4213f7ae7a docs: make auth/proxy chart values clearer (#36059)
* docs: make auth/proxy chart values clearer

* Apply suggestions from code review

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-12-27 20:49:46 +00:00
Paul Gottschling 1ad507bfbf Replace "2FA" with "MFA" (and similar) (#35987)
This maintains consistency with Teleport's brand messaging.
2023-12-22 15:59:03 +00:00
Noah StrideandPaul Gottschling 0a61c9e869 Add docs for new bot resource (#35651)
* Add docs for new `bot` resource

* Update docs/pages/machine-id/reference/configuration.mdx

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

* Finish sentence describing traits

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-12-21 12:29:55 +00:00
Paul Gottschling fd08933d0d Sort CLI reference guides alphabetically (#35843)
Closes #21164

The CLI reference is a section of the docs in which each CLI tool has
its own page, so this change sorts each page individually.

The change places H2 sections not related to individual commands (e.g.,
sections for global flags and environment variables) at the top of each
guide, and sorts the sections following these.

In `teleport.mdx`, all commands except for `start` are only documented
in a table at the beignning of the page, so this change sorts the table.
2023-12-19 21:38:45 +00:00
Nic Klaassen 40833feb56 docs: remove athena warning (#35908)
This commit removes a warning not to use the Athena backend if using an
event exporter due to high resource usage.

This issue was fixed in
https://github.com/gravitational/teleport/pull/32547
2023-12-19 21:14:57 +00:00
Hugo Shaka c1cb40eaba charts/kube-agent: updater extraArgs (#35786) 2023-12-15 20:46:38 +00:00
0a09e538f3 Add docs for future assume time on access requests (#35555)
* Add docs for future assume time on access requests

* Update docs/pages/access-controls/access-requests/access-request-configuration.mdx

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

* Update docs/pages/access-controls/access-requests/access-request-configuration.mdx

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

* Update docs/pages/access-controls/access-requests/access-request-configuration.mdx

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

* Update docs/pages/access-controls/access-requests/access-request-configuration.mdx

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

* Add link to RFC339 to access request doc

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-12-14 16:54:14 +00:00
Hugo Shaka 00f3b4c9c3 integrations/operator: fix standaloneHelm chart and guide (#35632)
* fix Helm standalone chart + guide

* add operator to testplan

* Apply suggestions from code review

* fix broken link
2023-12-14 02:49:42 +00:00
Steven Martin 6a99742c2e docs: use default pre-set roles in tsh examples (#34742) 2023-12-12 18:45:35 +00:00
Hugo Shaka b685933264 docs: document join methods and tokens (#34960) 2023-12-08 00:06:03 +00:00
Paul Schisa d9b9342a95 Update config.mdx (#34786)
increase toc depth to three at customer request to minimize scrolling when moving between configuration sections
2023-12-07 14:48:46 +00:00