Commit Graph
4069 Commits
Author SHA1 Message Date
Zac Bergquist 660c5dad75 docs: mention desktop support for AD and local users (#53369) 2025-03-29 15:03:08 +00:00
Sakshyam ShahandPaul Gottschling 5c83b29ca9 docs: explain awsic plugin install --assume-role-arn flag (#53512)
* docs: explain awsic plugin install  flag

* expand the use system credential sentence

* Update docs/pages/admin-guides/management/guides/aws-iam-identity-center/migrating-identity-center-from-okta-to-teleport.mdx

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2025-03-28 20:54:00 +00:00
Noah Stride 4592f344d5 Add MWI to list of billing metrics (#53549)
* Add MWI to list of billing metrics

* two -> three
2025-03-28 20:08:38 +00:00
Noah Stride ccbe5c5a18 Document allow_reissue (#53439) 2025-03-27 23:33:09 +00:00
Hugo Shaka 22b05490d6 Support adding introduction text into Terraform reference pages (#53474)
* TF docs: add introduction support in generic template

* TF docs: link database guide
2025-03-27 17:31:37 +00:00
Noah StrideandPaul Gottschling b3448877b5 Add documentation for workload-identity-aws-ra tbot service (#53322)
* Add cdocumentation for `workload-identity-aws-ra` service

* Apply suggestions from code review

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

* Adjust name to be full roles anywhere

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2025-03-27 13:52:43 +00:00
Gavin Frazar 8d38eac6ce [docs] Fix role reference request_access docs (#53471)
* Fix request_access godoc

* Update terraform docs

* Update operator CRD docs
2025-03-26 22:43:56 +00:00
Zac Bergquist 76ac553af5 docs: fix typo in config example (#53464) 2025-03-26 21:19:52 +00:00
STeve (Xin) Huang 70ccd1bb14 [docs] Move discovery reference and fix ElastiCache/MemoryDB db access reference (#52854)
* Move discovery reference and fix ElastiCache/MemoryDB db access reference

* adding redirect

* fix spelling

* fix trailing slash

* fix links

* change to wildcard
2025-03-26 15:37:18 +00:00
Noah Stride 5b868adf81 Document new static_jwks field for the GitLab join token (#53389)
* Document new `static_jwks` field for the GitLab join token

* Fix mispell

* Empty commit for cla check
2025-03-26 09:46:13 +00:00
Zac Bergquist f7395357a8 docs: clarify pgevents retention period (#53422)
The retention period goes in the URL _fragment_, which comes
after the rest of the query parameters.
2025-03-25 23:25:48 +00:00
Sakshyam Shah 12b1173edc fix access list default owner flag name (#53420) 2025-03-25 22:59:23 +00:00
Paul GottschlingandZac Bergquist c5d9fc43e4 Edit DNS guidance for registered apps (#52973)
* Edit DNS guidance for registered apps

Closes #30361

Add an explicit warning against creating DNS records that map
application subdomains to the hosts of registered applications. Use the
`dns-app-access` partial in `connecting-apps.mdx` to simplify reuse.

* Respond to zmb3 feedback

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

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2025-03-25 19:02:11 +00:00
Paul Gottschling 35c75311a8 Remove string style (#53344)
See gravitational/docs-website#97

The docs engine removes these using a custom plugin during builds.
Remove string styles in the docs content so we can remove the plugin.
2025-03-25 18:15:44 +00:00
Noah Stride 7cbb46d2ed Support configuring StaticJWKS for the GitLab join method (#53386)
* Update protobuf

* Implement and test ValidateTokenWithJWKS

* Update join logic to use new method for static jwks

* Update Terraform Provider

* Update operator docs/files

* Update goldenfile
2025-03-25 18:03:09 +00:00
Gus Luxton 871f9bfc8a docs: Fix broken link to predicate language in proxy templating docs (#53366) 2025-03-25 13:19:24 +00:00
Noah Stride b946365941 Document disable_exec_plugin option for Kubertnetes output (#53326) 2025-03-25 08:52:40 +00:00
Noah Stride cabc9d6af4 Update Spacelift integration docs as per deprecated runner image (#53339)
* Add warning to old README

* Update Spacelift guide to show configuring new Terraform provider
Machine ID functionality

* Replace mention of `tbot`
2025-03-24 14:46:46 +00:00
Paul Gottschling 861128ac83 Fix 18 vale warnings (#53300)
Include inlining the partial:

docs/pages/includes/machine-id/recover-circle-ci-claims.mdx

This is because it's only used by two pages and, as a partial, violates
the rule in which each Var with a given name must be used multiple
times on a single page. Since this Vale rule uses the `raw` scope, it is
not possible to ignore it with an MDX comment.
2025-03-24 14:24:51 +00:00
Paul Gottschling 6c14c2b16e Replace (!toc!) syntax with DocCardList (#53331)
DocCardList is a Docusaurus-native component that achieves the same
goal as our custom `remark-toc` plugin, but with Docusaurus APIs instead
of file system lookups. Replace `(!toc!)` mentions so we can remove
`remark-toc`.
2025-03-24 12:53:16 +00:00
Paul Gottschling 0cfc88ef9f Clarify the config file in Installation (#53185)
Closes #52000

Add an H3 section to the Linux H2 of the Installation guide clarifying
that users must create a configuration file and linking to guidance on
doing so.
2025-03-24 12:19:10 +00:00
Noah StrideandPaul Gottschling 848025c02a Update Identity output docs to include ssh_config option (#53271)
* Update Identity output docs to include `ssh_config` option

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

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2025-03-24 10:26:44 +00:00
Hugo ShakaandJoao Ubaldo 8c8b3832c9 [buddy] helm: add support for secondFactors (#53274)
* Helm: add support for multiple second factors

* Helm: better handle webauthn

* Helm: add tests

* Helm: update contributing reference link

* Helm: add doc

* Helm: update default value

* helm: deprecate secondFactor and user secondFactors by default

---------

Co-authored-by: Joao Ubaldo <me@joaoubaldo.com>
2025-03-23 11:00:28 +00:00
Hugo Shaka 4fad952d20 helm: add topology spread constraints (#53276) 2025-03-21 14:50:43 +00:00
175a5504b1 docs: Add tctl plugins install refrerence (#52878)
* docs: Add `tctl plugins install` refrerence

* Update tctl.mdx

* Apply suggestions from code review

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

* Update tctl.mdx

* Update tctl.mdx

* explain required and optional fields

---------

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
Co-authored-by: Sakshyam Shah <sshah@goteleport.com>
2025-03-21 02:50:11 +00:00
rosstimothy dd6a69654f Update self-host upgrade guide (#51807)
The guide now reflects that rolling Auth upgrades are allowable in
certain scenarios. The guide also explicitly calls out when client
tools should be upgraded.
2025-03-20 17:50:14 +00:00
Paul Gottschling e30705cac0 Use the Docusaurus format for the sidebar (#53231)
Remove the `navigation` section from config.json and add a file called
`sidebar.json` containing sidebar data.
2025-03-20 17:38:12 +00:00
Steven MartinandZac Bergquist 4b342558ee docs: update role v5 reference info (#53219)
* docs: update role v5 reference info

* docs: spelling fix

* docs: update role v5+ language for joining sessions

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

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2025-03-20 17:01:12 +00:00
Paul Gottschling 63d865df1d Clarify prereqs for self-hosted Terraform guides (#53184)
Closes #5377

Aside from a Route 53 zone and key pair, the two Terraform modules for
self-hosted clusters do not require existing resources. Clarify the
additional prerequisites in the Prerequisites sections of these guides.
Add bullets to existing prerequisites to make these sections consistent
with other docs guides.
2025-03-20 13:12:35 +00:00
9096a28164 Oracle RDS guide (#52784)
* minimal draft

* Add note on enabling TLS for Oracle RDS

* Full Oracle RDS guide

* update SQL Server adutil installation instructions

* Update Oracle RDS database documentation to include audit logging steps. Small corrections to self-hosted guide.

* Fix typos

* Apply suggestions from code review

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

* Remove tabs

* Address part of review comments

* add small comments

* Apply suggestions from code review

Co-authored-by: Gabriel Corado <gabriel.oliveira@goteleport.com>

* expand troubleshooting, tls setup

* note on SQLcl and alternatives

* misaligned columns aligned shall be now

* Typos/spelling

* drop empty line

* Optimize PNG

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Gabriel Corado <gabriel.oliveira@goteleport.com>
2025-03-20 10:35:22 +00:00
Michael 46437e307a Add UseAnyProxyPublicAddr to app spec (#52693)
This adds a new field, UseAnyProxyPublicAddr, that will be used to
tell the web api/ui to rebuild the request app's FQDN based on the proxy
public addr that the request came from (upcoming PR to consume this)
2025-03-20 00:40:06 +00:00
e157cda64a docs: Identity Center Okta to Teleport migration guide (#51861)
* docs: Identity Center Okta to Teleport migration guide

* Apply suggestions from code review

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

* Updated diagrams

* Review feedback

- Rearranged to move migration path into "how it works"
- Added Uninstall section
- Added edit section

* cspell update

* Apply suggestions from code review

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

* Applied feedback

* Apply feedback

* Apply feedback

* Adds decription of installation commands

* linter appeasement

* address review comments

* organize ic docs

* move how to guide to root docs page, add detailed deletion guide to getting started page

* adding redirect for Lint appeasement

* fixing broken heading link

---------

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: flyinghermit <sshah@goteleport.com>
Co-authored-by: marie.mcallister <marie.mcallister@goteleport.com>
2025-03-19 20:50:10 +00:00
Hugo Shaka 5e73eaf342 Add autoupdate version and config support to TF provider (#53007)
This commit adds two new singular resources to the Terraform provider:
teleport_version and telpeort-config.
Both got added using the resource 153 pattern (new protoc-X.yaml file)
and it went pretty seamless.

The only specific is that I had to add a provider feature to
automatically set singular resource names as we don't run
CheckAndSetDefaults() locally anymore. This got merged in a separate PR.
2025-03-19 17:55:33 +00:00
Gus Luxton 8881e4dca0 docs: Add Rocky Linux 8+ as supported on the installation page (#53124) 2025-03-19 14:03:48 +00:00
Steven Martin 8d16ca0315 docs: correct x86_64 ref (#53183) 2025-03-19 13:32:36 +00:00
Paul GottschlingandBen Arent f2d62d4208 Reorganize the feature matrix (#52641)
* Reorganize the feature matrix

This change organizes the feature matrix according to the latest product
categorization scheme, and moves the feature matrix into its own guide
to make it more discoverable. While there is opportunity to rework the
rows within the feature matrix, this change minimizes the scope of the
first iteration by reorganizing the existing rows while leaving them for
the most part unchanged.

In the new feature matrix page, each Teleport product has its own
H2-level section. Product descriptions come from official Marketing
language, focusing on concrete statements about what each product
comprises and how it works and leaving out statements of value (which
are not typically found in documentation). This change does not include
sections for categories with no rows in the current table.

* Respond to zmb3 feedback

Add minor wording tweaks.

* Align cells across feature matrix tables

Make it easier for a user to follow a single column across multiple
tables of the feature matrix. Since the style sets cells to 25% width,
which assumes a table that is four cells wide, use a `style` tag so the
style only applies to the tables in the `teleport-editions.mdx` guide.

Closes gravitational/docs-website#134

* Update the MWI section of the feature matrix

Indicate that it is available for Community Edition users.

* Edit index.mdx

Apply changes made to identical language in teleport-editions.mdx.

* Respond to eglenn-teleport feedback

- Move the Community Edition column to the final place, rather than the
  first, since we now want to de-emphasize Community Edition and elevate
  the commercial offering.
- Edit the text to de-emphemphasize "editions", moving the description
  of editions to the end of the page and linking to this from the
  heading of relevant feature matrix columns.
- Remove section intro paragraphs, since the same information is
  on the home page of the docs.

* Add a Teleport Identity Security section

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

* Rename MWI features

---------

Co-authored-by: Ben Arent <ben@goteleport.com>
2025-03-18 17:52:05 +00:00
Paul Gottschling 3156fa9e3c Fix 18 Vale warnings related to Var components (#52810)
`Var` components with a particular `name` should have multiple instances
in a given page.
2025-03-18 16:27:50 +00:00
marieandZac Bergquist ec58d4f585 docs: add jwt options to application-acces full spec (#52901)
* docs: add[D jwt options to application-acces full spec

* Update docs/pages/reference/agent-services/application-access.mdx

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

* Update docs/pages/reference/agent-services/application-access.mdx

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

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2025-03-18 14:34:24 +00:00
Paul Gottschling 12107f1b77 Fix minor details syntax issue (#53042)
When converting one `Details` component into semantic HTML tags,
`Details` attributes were left by mistake a `summary` tag. This change
fixes the issue.
2025-03-18 13:13:48 +00:00
Paul Gottschling 3c1e68feda Move version support table to Upcoming Releases (#53046)
Ports #53003 to `master`

This change helps guarantee that we'll update the version support table
at the same time as the upcoming release table to keep our support
windows up to date. Since we otherwise do not update the two tables at
the same time, the supported version table has become out of date.

This change also updates support windows based on the plan to release
v18 in May, 2025, with the assumption that we release a major version
every 4 months.

This change also moves the compatibility description from FAQ to
Upcoming Releases so we keep this info in one place, and links to
Upcoming Releases from the relevant section of the FAQ.

Since the docs engine automatically copies the Upcoming Releases page
from the default version to all four versions of the docs, this change
does not edit the Upcoming Releases page for this version.

This change removes an item from the docs test plan re: editing the
supported versions table, since we'll be doing this continuously rather
than when we release a new major version.
2025-03-18 13:08:27 +00:00
Nic Klaassen e027dcc5ac docs: instructions for signature_algorithm_suite with hsm and FIPS (#53097) 2025-03-17 23:59:15 +00:00
Zac Bergquist 60c5a1361e Support context path for Kubernetes app discovery (#52897) 2025-03-17 21:47:48 +00:00
Dave Sudia 286cee20a0 update TPR copy to remove bots (#53018)
Signed-off-by: Dave Sudia <david.sudia@goteleport.com>
2025-03-17 15:10:48 +00:00
Hugo Shaka 0a6f286cd2 Document catch-all agent group and when autoupdate changes take effect (#53033) 2025-03-14 09:23:11 +00:00
Paul Gottschling 6023797386 Use the Docusaurus format for Details (#53009)
See gravitational/docs-website#91

Docusaurus uses semantic HTML tags instead of a custom Details
component. Replace instances of our Details component with the
`<details>` and `<summary>` tags so we do not need to perform a
conversion when building the docs website.
2025-03-13 17:32:59 +00:00
Evan Freed ba097e3362 bump cloud docs (#53022)
Signed-off-by: Evan Freed <evan.freed@goteleport.com>
2025-03-13 14:09:57 +00:00
Zac Bergquist 87c1fb3e30 Update event handler docs (#53021)
Documents #53006
2025-03-13 05:46:16 +00:00
Paul Gottschling 3ba805f5d9 Remove two-dimensional and dropdown-only docs Tabs (#52395)
Closes gravitational/docs-website#70

`Tabs` components that use a dropdown menu do not render on the
Docusaurus site. Since there are not many of these in the docs content,
it makes sense to change them to standard `Tabs` components instead of
porting the legacy `Tabs` behavior to the new Docusaurus site.

- Change long picker partials to use a standard `Tabs` component instead
  of a dropdown menu. While this is not ideal, it standardizes the
  `Tabs` component in the docs to only use attributes that the docs
  engine can process. All `TabItems` render as expected.
- Remove an unused partial that uses two-dimensional `Tabs`
  (`docs/pages/includes/install-linux-self-hosted.mdx`).
- In some guides, collapse two-dimensional `Tabs` components to only
  require one dimension.
- In `install-linux-enterprise.mdx`, use the one-line installation
  script to simplify the instructions and avoid using `Tabs` entirely.
2025-03-12 18:59:17 +00:00
Paul Gottschling f60a87c123 Add missing redirects (#52977)
These correct 404s resulting from some video links on the corporate
site.
2025-03-12 12:09:14 +00:00
Paul Gottschling 05ddbac104 Remove unused partials (#52983)
Used this command:

```
$ find docs/pages/includes -type f | xargs \
 -I{} bash -c 'grep -qR {} docs/pages || rm {}' \;
```
2025-03-12 12:08:45 +00:00