Commit Graph
691 Commits
Author SHA1 Message Date
Marco Dinis 10fb24adee Docs: fix links to Azure portal (#53789) 2025-04-09 16:37:28 +00:00
Steven Martin e5656d1d09 docs: include signature algorithm suite in auth config (#53752) 2025-04-07 12:40:32 +00:00
Paul Gottschling e1ded6c334 Remove legacy TabsItem usage (#53638)
Deprecating this tag in favor of the Docusaurus-native TabItem.
2025-04-07 12:29:26 +00:00
Steven Martin 172af97a0f docs: update build instructions for access request plugins (#53656)
* docs: update build instructions for access request plugins

* docs: update mattermost build example

* docs: fix missing tabitem

* docs: fix tabitem
2025-04-07 11:24:42 +00:00
Noah StrideandPaul Gottschling f85b38220a Documentation changes for Windows tbot (#53588)
* Update windows install instructions to mention tbot

* Update support table

* Add FAQ entry

* Update docs/pages/installation.mdx

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

* Fix heading ref

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2025-03-31 15:56:58 +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
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 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
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 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
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
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 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
Paul Gottschling e328ea52a1 Remove Icon tags (#52932)
The docs engine strips these, so they are no op. Remove them so we can
remove the docs engine code that strip them. As part of this, remove the
`icons-table.mdx` partial, which no pages include.
2025-03-12 12:07:51 +00:00
Noah StrideandPaul Gottschling 3bbaaccc95 Add Spacelift to join token reference page (#52576)
* Add spacelift to join token reference page

* Fix join_method

* Update docs/pages/reference/join-methods.mdx

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

* simplify

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2025-03-11 16:27:45 +00:00
Paul Gottschling 1c31b5e4a8 Remove Figure tags (#52929)
See gravitational/docs-website#95

The docs engine currently unwraps them, meaning that they are no-op
components. Remove these so we can delete the Figure-unwrapping code.
2025-03-11 12:08:41 +00:00
Taras 64f53e088b [docs] add yaml syntax highlight for login_rule sepc (#52764)
* [docs] add yaml syntax highlight for `login_rule` sepc

* Enable YAML syntax highlight in one more location

* Fix indents for code snippet
2025-03-07 10:54:52 +00:00
marieandZac Bergquist 829532409b docs: new product messaging for marketing launch (#52319)
* initial draft for marketing changes

* product name changes from marketing

* correcting duplications

* final changes post-marketing review

* review changes

* Update docs/pages/admin-guides/infrastructure-as-code/managing-resources/access-list.mdx

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

* revisions

* cleanup and reverting use-cases of 'Zero Trust Access x'

* Trust Access corrections

* removing 2 images already in master

* post-feedback changes

* Update docs/pages/admin-guides/teleport-policy/teleport-policy.mdx

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

* post G2 review feedback

* Lint helm appeasement

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2025-03-07 01:35:13 +00:00
rosstimothy 95c51840d6 Expose configuration to set maximum number of PKCS#11 sessions (#52768)
The PKCS#11 that we use defaults to allowing 1024 concurrent
sessions. If an HSM is configured with a lower limit it results in
broken UX since the PKCS#11 library does not reuse open and available
sessions until it has opened the maximum number of sessions that it
can. While the library behavior is out of our control, we now allow
users the ability to specify what their desired max and propagate it
on to the PKCS#11 library so that it will not open more sessions
than the HSM will allow.

The auth config reference was updated to include `ca_key_params`.
While these config options were somewhat discoverable via individual
HSM guides, they were not mentioned in the auth reference.
2025-03-06 18:02:35 +00:00
Dave Sudia 3886a45a2f remove workload id design partner cta (#52628)
Signed-off-by: Dave Sudia <david.sudia@goteleport.com>
2025-03-04 16:53:58 +00:00
Paul Gottschling 0fbbeff50c Replace Notices with Docusaurus syntax (#52634)
Use Docusaurus syntax for admonitions so the docs engine does not need
to replace these. This is one step toward removing the
`remark-update-tags` plugin. See: gravitational/docs-website#94

Relevant commands are included below to make reproducing this work
easier.

1. Replace all `Notice` tags with `Admonition` tags.

2. Add `type="info"` if an Admonition is missing a type.

   To find instances:

   ```
   find docs/pages -name "*.mdx" -exec awk '
   BEGIN{a=0}
   a==0 && /<Admonition/{ a = 1 }
    a==1 && /type/{t = 1}
    a==1 && />/{ a = 0; if(t == 0) print FILENAME ":" FNR }' {} \;
   ```

3. Replace `type="notice"` with `type="note"`.

   To find instances:

   ```
   find docs/pages -name "*.mdx" -exec awk '
   BEGIN{a=0}
   a==0 && /<Admonition/{ a = 1 }
    a==1 && /type="notice"/{t = 1}
    a==1 && />/{ a = 0; if(t == 1) print FILENAME ":" FNR }' {} \;
   ```
2025-03-04 15:51:27 +00:00
39fc6a7cbb [teleport-update] Agent managed updates documentation (#52024)
* docs wip

* wip 2

* wip 3

* remove roles

* wip

* wip 4

* wip 5

* wip 6

* cli 1

* next

* cli ref

* Autoupdate docs edition:

- ban subjective and marketting words such as "new", "old", "original",
  "next-generation", "previous", and consolidate to Managed Updates v1/v2
- change the installation snippets to document the unified installer
  (except the linux-cloud one).
- change the autoupdate architecture page to reflect the design changes
  between v1 and v2
- make the autoupdate v2 guide not Cloud-specific
- fix configuration examples
- add troublshooting commands

* Fix broken links

* managed updates -> Managed Updates

* fixup! Fix broken links

* finish teleport-update reference, fix typo

* Add unified installer + align names + fix typos

* style feedback

* title fixes

* cleanup

* lint

* Address feedback + fix spell + fix bash command

Signed-off-by: hugoShaka <hugo.hervieux@goteleport.com>

* Simplify install script docs + fix links

Signed-off-by: hugoShaka <hugo.hervieux@goteleport.com>

* try to appease linter

* fixup! try to appease linter

* Apply suggestions from code review

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

* Address final feedback

---------

Signed-off-by: hugoShaka <hugo.hervieux@goteleport.com>
Co-authored-by: hugoShaka <hugo.hervieux@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2025-02-28 20:49:13 +00:00
Pawel Kopiczko 8a805ba695 Docs: Move creating Okta SAML app to include (#52574)
So it can be (re)used in the new Okta enrolment flow page.
2025-02-28 10:03:29 +00:00
Paul Gottschling 41310d2bca Address 67 Vale warnings (#52511)
- Fix "Auth Service" variations.
- Fix some AWS product naming violations.
- Ignore some false positives.
- Fix capitalization warnings.
- Address warnings re: outdated product names.

Some of the warning categories above include auto-generated pages. This
change does not touch the generators in order to simplify things.
2025-02-27 17:15:40 +00:00
Steven Martin ec84048aac docs: update self-hosted config for db (#52407) 2025-02-27 11:44:09 +00:00
Nic Klaassen cb0a69d095 [vnet] docs updates (#52371)
* [vnet] docs edits

* fix typo

* address review comments
2025-02-26 23:31:06 +00:00
Paul Gottschling 79d66809cc Update the Linux Server guide (#52439)
Update the guide for Teleport v17 based on manual testing.

- Ensure that variable names are consistent.
- Update images
- Update link targets
- A couple of minor readability improvements
2025-02-25 14:48:59 +00:00
Steven Martin 80086b3730 docs: include sudo in keyring create insts (#52247) 2025-02-21 16:17:00 +00:00
Paul Gottschling 2276871f23 Fix 34 vale warnings (#52367) 2025-02-21 13:29:57 +00:00
Steven Martin f802b09783 docs: remove tsh pkg download for cloud install (#52223) 2025-02-17 21:30:06 +00:00
Dan Upton fd2edb678c Machine ID: Per-ouput credential_ttl and renewal_interval (#51956)
* Move `CertificateTTL` and `RenewalInterval` into a `CertificateLifetime` struct

These values are always required together, and moving them into a struct will
make it more straightforward to override them per-service/output.

* Support custom `certificate_ttl` and `renewal_interval` on identity output

* Support custom `certificate_ttl` and `renewal_interval` on application output

* Support custom `certificate_ttl` and `renewal_interval` on application tunnel

* Support custom `certificate_ttl` and `renewal_interval` on Kubernetes output

* Support custom `certificate_ttl` and `renewal_interval` on Kubernetes V2 output

* Support custom `certificate_ttl` and `renewal_interval` on database tunnel

* Support custom `certificate_ttl` and `renewal_interval` on SSH host output

* Support custom `certificate_ttl` and `renewal_interval` on SSH multiplexer

* Support custom `certificate_ttl` and `renewal_interval` on SPIFFE SVID output

* Support custom `certificate_ttl` and `renewal_interval` on database output

* Support custom `certificate_ttl` and `renewal_interval` on workload API

* Support custom `certificate_ttl` and `renewal_interval` on workload identity output

* Add `GetCertificateLifetime` to service config interface

* Update the docs

* Add more examples to the standard config

* Rename `CertificateLifetime` to `CredentialLifetime`

So it can be used for non-certificate credentials like JWTs

* Deprecate `certificate_ttl` option and replace it with `credential_ttl`

* Return TTL warnings as errors and let the caller decide what to do with them

* Add `CredentialLifetime` to the "full" service config tests

* Support `credential_ttl` and `renewal_interval` in workload-identity-jwt service

* Silence sloglint

* Replace duplicated helper with `cmp.Or`
2025-02-14 14:42:17 +00:00
Andrew Burke f3a18d09f8 Oracle join method - Add docs (#51936)
This change adds documentation for the Oracle join method
2025-02-10 21:41:27 +00:00
Hugo ShakaandmaximumG d61d6bc46d feat(tbot): K8S Role creation is optional (#51919)
Fixes #51181.

K8S `Role` & `RoleBinding` are created by default. Their creation does not depends on the `ServiceAccount` creation anymore.

Co-authored-by: maximumG <maxime.gerges@backmarket.com>
2025-02-07 00:06:55 +00:00
marie 536dc9d341 docs: updating 'Teleport Enterprise (Managed)' to Cloud (#51532)
* removing teleport managed terms

* adding new term to terraform-provider template

* removing change from tf template
2025-02-06 11:50:18 +00:00
Noah Stride 62c28bb692 tbot Helm Chart: Add ability to configure securityContext (#51817)
* Add ability to configure securityContext of tbot pods

* Newline at end of file
2025-02-05 09:09:57 +00:00
Matt Brock 431b307ca4 Making access graph description & verification steps an include file (#51831) 2025-02-05 01:05:46 +00:00
Steven Martin 3cf208e74c docs: remove sudo tctl users reference in cloud install docs (#51461) 2025-02-03 15:18:52 +00:00
Edoardo Spadolini 724457ad34 Stable UNIX users: docs (#51662)
* Stable user UID addition to the host user creation guide

* tctl stable-unix-users-ls docs

* CAP resource reference

* auth service reference

* Uncomment defaulted field in fileconf

* Clarify conditions for stable uids
2025-01-31 11:43:10 +00:00
STeve (Xin) Huang f44af9b61d [docs] PostgreSQL auto-user provisioning guide minor edits (#48897)
* [docs] PostgreSQL auto-user provisioning guide minor edits

* remove admin option from rds_superuser and add note on admin option for each role
2025-01-30 17:52:43 +00:00
Alan Parra 3de02ce6a0 docs: Instruct WSL device trust users to use tsh.exe (#51551) 2025-01-29 16:35:54 +00:00
Paul Gottschling d0c9920ce8 Edit the Resource Requests guide (#51558)
Closes #29347

The guide currently illustrates how to assign roles to new local users.
This change uses the `add-role-to-user.mdx` partial to include
instructions for Teleport clusters with SSO authentication connectors.
It edits the partial to include a parameter for the name of the user.
2025-01-28 19:29:00 +00:00
Noah Stride 9153ed0751 Workload Identity Resource Documentation (#51017)
* Add CLI reference

* Start fleshing out pages for new docs

* Link out to Terraform provider information

* Start putting together workload-identiyt-api svc reference

* Minor adjustments

* Keep hacking on reference for resource

* Keep hacking on reference

* Add to list of templating supported fields

* Add TOC

* Add rules to the example yaml

* Flesh out workload-identity-api docs page

* Add some todos

* Add skeleton of attributes page

* ADd comments

* Cross page links

* Retitle page

* Link one reference to another

* Add template for selector

* SPAG

* Fix link

* Fix TODO link

* ADd tbot start workload-identity-jwt to cli reference

* Add `workload-identity-x509` to config reference

* Start documenting join attributes

* Finish last batch of join attrs

* Add some short exsplanations/summaries

* Start explaining rules

* Shorter explanation

* Add opener to Workload Identity API and Workload Attestationreference

* SPAG

* Add docs for selector

* Fill out migration guide

* rename/reorg

* Add short note on SPIFFE Workload API

* SPAG

* Fix links
2025-01-27 09:25:00 +00:00
Zac Bergquist c80c3c7e2d docs: update moderated sessions guide (#51218)
Moderated sessions are a bit confusing because we combined an existing
OSS feature (joining sessions), with an Enterprise-only feature
(requiring session join policies).

I've expanded the scope of the moderated sessions guide to make it a
"joining sessions" guide instead, and added some extra details around
RBAC for active sessions.

Updates #51116
2025-01-22 18:48:04 +00:00
Hugo ShakaandTiago Silva 1b76f9743e kube-agent-update: Use the RFD-184 webapi proxy update protocol by default when possible (#50464)
* kube-agent-update: Use the RFD-184 webapi proxy update protocol by default when possible

* Update integrations/kube-agent-updater/cmd/teleport-kube-agent-updater/main.go

Co-authored-by: Tiago Silva <tiago.silva@goteleport.com>

* log update group

---------

Co-authored-by: Tiago Silva <tiago.silva@goteleport.com>
2025-01-17 22:35:10 +00:00
STeve (Xin) HuangandRafał Cieślak 843bf5f82f [docs] GitHub proxy admin guide and tsh reference (#50772)
* [docs] GitHub proxy admin guide and tsh reference

* update diagram

* update enterprise pre-req

* review comment

* Run images through ImageOptim, add 2x suffix to github-new-ca

* update title

---------

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
2025-01-17 14:22:17 +00:00