Commit Graph
3131 Commits
Author SHA1 Message Date
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
Paul Gottschling ae7e32f8e9 Add missing redirects (#38528)
The changes in #38161 reorganized pages in the Server Access section of
the docs, but did not add redirects for these pages. This change adds
the missing redirects.
2024-03-04 19:46:46 +00:00
Andrew Burke 49ddda276f Clarify home directory creation (#38830) 2024-03-04 18:50:31 +00:00
Steven Martin d933baa76c docs: update usage based address to show as https (#38784)
* docs: update usage based address to show as https

* change to just show host and port for reporting service
2024-03-01 18:20:24 +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 92818abe85 Add tsh/tctl instructions to upgrading guides (#38766)
Make these guides consistent with other how-to guides.

Closes #38681
2024-03-01 18:18:59 +00:00
Paul Gottschling d5e18cc0b7 Add admin user in the teleport-cluster guide (#38729)
Closes #10583

The local user we show how to create in the `teleport-cluster` guide
only has privileges to access Kubernetes resources, but does not have
administrative access to the cluster (e.g., to manage dynamic
resources).

This change takes the approach of the Linux server guide (the index page
of the docs) and shows how to add a user with the `editor,access` roles
in addition to a role that can access Kubernetes clusters.
2024-03-01 18:15:21 +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
Paul Gottschling 7272d92c86 Simplify and fix Kubernetes Getting Started guide (#38682)
* Simplify and fix Kubernetes Getting Started guide

Fixes #36026

- **Remove `kubernetes_users` in the example role**. Teleport
  impersonates a user with the Teleport user's name if the user has no
  `kubernetes_users` values, so don't provide one in this guide.

- **Remove the step to choose manual or guided enrollment**. The rest of
  the guide only shows the guided enrollment, making Step 1 redundant.

- **Reorder sections.**  Move the step to create RBAC resources first.
  This way, we can refer to the Kubernetes RBAC resources we created
  earlier when connecting to the cluster.

- **Condense redundant steps re: testing the connection:** There are two
  separate steps that test access to the cluster. Condense these
  instructions to simplify the guide.

- **Edit the "Set up and test access" section:** Include steps that more
  closely resemble the flow of the guide, including the namespace and
  groups to include in the "Test Connection" view.

- **Have the user fetch pods in the `teleport-agent` namespace**, since
  we created the namespace in the guide and can guarantee the output.

* Add context between instructions

Responds to tigrato feedback

* Fix misspellings
2024-03-01 16:50:20 +00:00
Noah StrideandZac Bergquist f2747ca7a9 Update docs for tbot-distroless image (#38840)
* Change image in Machine ID Kubernetes Guide

* Update installation page with advice on tbot image

* Update docs/pages/installation.mdx

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

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2024-03-01 16:30:23 +00:00
20cfeb2fd1 Add in documentation for Okta access list synchronization. (#38355)
* Add in documentation for Okta access list synchronization.

Documentation has been added for Okta access list synchronization.

* Apply suggestions from code review

Co-authored-by: Lisa Kim <lisa@goteleport.com>

* Reword default owners blurb.

* Apply suggestions from code review

Co-authored-by: Lisa Kim <lisa@goteleport.com>

* Consistently capitalize Access Lists, reduce images, tweak wording.

* Apply suggestions from code review

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

* Update docs/pages/application-access/okta/hosted-guide.mdx

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

* Remove yaml config bits, clarify hosted guide.

* Correct spelling.

* Correct emphasis.

---------

Co-authored-by: Lisa Kim <lisa@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2024-02-29 19:59:53 +00:00
Bernard KimandPaul Gottschling 6099ca6e2c Add note about auth and proxy services (#38744)
* Add note about auth and proxy services

* auto -> automatic

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-02-29 02:00:36 +00:00
Brian JoergerandPaul Gottschling 689d62069b Update Hardware Key support docs - OpenSSH Server access unsupported (#38711)
* Add OpenSSH Server access to list of unsupported features for Hardware Key support.

* Update docs/pages/access-controls/guides/hardware-key-support.mdx

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-02-28 20:31:10 +00:00
Cam Hutchison 7835864494 ci: Remove drone(gen) from repo (#38739)
Remove `.drone.yml` and `dronegen` which generates it from the repo,
disabling drone on master. Remove references to drone in docs.

The remaining piplines in `.drone.yml` were the tag build and promote
pipelines which now run on GitHub Actions, the push build pipelines that
are currently of limited value and will be re-done differently with a
little thought, and the `teleport-docker-cron-ecr` pipeline which no
longer works as of v15 due to the removal of the legacy OCI images (the
teleport-labs stuff that the pipeline builds is to be removed shortly
too).
2024-02-28 20:04:41 +00:00
Paul Gottschling 4b873f88f8 Remove ScopedBlocks from the docs (#38698)
There was a lingering one in the self-hosted ClickHouse guide. Remove it
to help with the Mintlify migration and render diagrams as expected.
2024-02-28 18:58:03 +00:00
Steven Martin 9b503e59c6 retitle IGS to Identity (#38584)
* retitle IGS to Identity

* restore IGS comments
2024-02-27 17:42:37 +00:00
Paul Gottschling 5688a13f71 Update license generation instructions (#38287)
Closes #37174

Update the `obtainlicense` partial to be consistent with the changes
introduced in #36673.
2024-02-26 15:32:09 +00:00
Paul Gottschling 9bf7ff7920 Use tctl users update in add-role-to-user.mdx (#38445)
Closes #19067

This allows a reader to copy commands to update a local user without
needing to open a YAML file in a text editor.
2024-02-26 15:31:47 +00:00
Steven Martin b33977598c docs: remove tip on OpenSSH that no longer applies for no labels (#38618) 2024-02-26 14:33:23 +00:00
Steven Martin 811e201048 docs: update iam joining helm example (#38608)
* docs: update iam joining helm example

* remove extra space
2024-02-26 11:29:39 +00:00
Isaiah Becker-Mayer ca0bdc0cac Adds a Windows Desktop Service section to scaling (#38370)
* Adds a `Windows Desktop Service` section to scaling

Also adds a link in the windows desktop reference page, as well
as including the CLI in the reference page bullet list.

* link to the specific hash
2024-02-25 16:53:07 +00:00
Gavin Frazar 6fad74e86c [docs] add postgresql query cancellation troubleshooting (#38352)
* add postgresql query cancellation troubleshooting

* link to psql docs

* explain how to find a query pid in redshift

* fix lint
2024-02-24 08:20:54 +00:00
Andrew Burke 122b5a7138 Fix host user creation mode docs (#38366)
* Update host user creation docs

* Remove comma

* Reorder modes

* Remove more references to drop

* Deprioritize insecure-drop
2024-02-23 17:00:26 +00:00
Logan Davis 728602ee03 Update docs for latest cloud version. (#38448) 2024-02-23 16:42:10 +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
STeve (Xin) Huang 056e2ec498 [docs] update TLS routing conn upgrade with WebSocket support (#38167)
* [docs] update TLS routing conn upgrade

* remove "now"
2024-02-22 15:53:32 +00:00
Bernard Kim fb2e08cdf6 Query latest compatible version before installation (#38401) 2024-02-21 18:18:32 +00:00
Gavin Frazar 7cec562a5f add DB CA migration and rotation guides (#38137)
* add nav slugs for DB CA migration and rotation guides
* add DB CA guides
* use --phase last in CA rotation guide example commands, so they're less tedious to
  edit
* link to the database CA rotation guide for db and db_client CA rotation
* deprecate spec.ca_cert in db reference
* recommend parallel database ca rotation
* explain reconfig post rotation to fix db vuln
* update cspell to ignore -noout
2024-02-21 01:49:47 +00:00
Zac Bergquist 14e11894ea Fix docs typo (#38453)
No backport necessary, as this was caught before the backport merged
2024-02-20 22:40:32 +00:00
Edoardo Spadolini 29bf72d916 Clarify on-prem usage reporting and trusted clusters (#38446)
* Clarify on-prem usage reporting and trusted clusters

* Fix internal link
2024-02-20 21:54:29 +00:00
Steven Martin 75900add23 docs: updates to access graph instructions (#38449) 2024-02-20 21:14:16 +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
William Loy 91ea1c6d27 fix indention in helm code example (#38356)
* fix indention in helm code example

localAuth: false must be nested under authentication whereas the example appears it can be at the same indention as enterpriseImage

* Update CHANGELOG.md
2024-02-19 22:02:31 +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
Trent Clarke eb8396b73f [docs] Updates Okta SSO docs to include sync service (#36398)
* [docs] Updates Okta SSO docs to include SCIM & sync service

Expanded to cover:
 * Running Okta as a hosted integration
 * SCIM configuration
 * Okta to Teleport user conversons
 * Updated enrolment screenshot
 * Gotchas

* linter appeasement

* Linter appeasement
2024-02-19 11:29:10 +00:00
rosstimothy ccf1a3d46f Add supported load information to scaling docs (#38178)
* Add supported load information to scaling docs

* fix: correct existing lint failures
2024-02-16 17:38:11 +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
Edward Dowling 89a3140dfb Revert "Fix opsgenie plugin to use correct annotation to determine whether or…" (#38338)
This reverts commit 3455f3b6b1.
2024-02-16 16:26:51 +00:00
Steven Martin 6f0565a539 docs: updates to cloud tenant data locations (#38294)
* docs: updates to cloud tenant data locations

* spelling fix

* lint fixes

* update verbiage on where ent cloud runs

* Team data storage update in comparsion
2024-02-16 13:14:47 +00:00
William LoyandPaul Gottschling 3701a0f5ac Add fips instructions for helm chart (#38244)
* Update fedramp.mdx

* Update CHANGELOG.md

* Update docs/pages/access-controls/compliance-frameworks/fedramp.mdx

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

* Update CHANGELOG.md

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

* Update CHANGELOG.md

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-02-15 21:08:49 +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
Jakub Nyckowski 3d5afe3f5d Update access graph documentation (#37779)
The documentation for the Access Graph has been updated to better reflect its functionalities. It now states that the tool visualizes access to all resources, instead of merely SSH servers, enrolled with your Teleport clusters. It also removes the limitation of only supporting SSH nodes.
2024-02-15 16:58:31 +00:00
Paul Gottschling b56d976c52 Add notes on upgrading Teleport on Docker (#37965)
Closes #17421

Expand the "Docker" section of the Installation guide. The required
instructions are fairly straightforawrd, so this note is mainly to
assure users that this is possible.
2024-02-14 21:31:20 +00:00
Michael Wilson bb58d864dc Set the access request max duration to 14 days. (#37947)
* Set the access request max duration to 14 days.

The max duration for an access request is now 14 days. The default requester
role is now set to allow for this as well.

* Tweak comments, docs.

* Add in Okta requester/Okta resources so that we're not modifying the base requester role.

* Fix init tests, fix okta-resources role name.

* Add user group read to the preset.

* Rename okta-resources to okta-access.

* Use role version 7.
2024-02-14 17:50:27 +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
Paul Gottschling b21543ae0d Remove the "Contributing" docs section (#38062)
Closes #12660

We have moved all information for documentation contributors to the
README of `github.com/gravitational/docs`. This change removes this
information from the Teleport docs site.

The advantages of this approach are that:
- All information for docs contributors is in one place
- We can free up a navigation sidebar entry, since we no longer need the
  "Contribute" link.
2024-02-13 19:34:42 +00:00
Brian Joerger 9415702773 Update affected docs. (#37960) 2024-02-12 18:41:54 +00:00
Edward Dowling 3455f3b6b1 Fix opsgenie plugin to use correct annotation to determine whether or not to create alerts (#37929)
* Fix bug in opsgenie plugin mixing up notify-services and schedules

* Update docs for opsgenie plugin to use correct schedules

* Remove accidental change to opsgenie client

* Update opsgenie client tests
2024-02-12 17:38:15 +00:00