Commit Graph
3886 Commits
Author SHA1 Message Date
Bartosz Leper 874d4d0974 Mention the Web role editor in the docs (#50936) 2025-01-14 11:44:33 +00:00
Bernard Kim 3c95e89a2f Operator managed trusted_cluster guide (#50847)
* Operator managed trusted_cluster guide

* Fix lint

* Fix lint

* Fix lint

- Add How it works section
- Capitalize Teleport Agent

* Fix list indentation

* Link Linux demo guide

* Replace invitation token -> join token

* Consolidate tctl, operator, and terraform guide

* Use double quotes in tf file

The latest version of terraform does not support single quotes

* version field is required

* Fix links
2025-01-14 01:15:32 +00:00
Brian Joerger ce30037005 Add SSO MFA docs (#50533)
* Add SSO MFA docs.

* Address comments from zmb3.

* Fix links; minor style fix.

* Address comments.

* Try removing leading / in example links.

* Address Nic's comments.
2025-01-13 20:13:12 +00:00
Bernard Kim 646329da7d operator: Support trusted_cluster resources (#49920)
* Add UpsertTrustedClusterV2 rpc

This supersedes UpsertTrustedCluster rpc. V2 performs resource name
validation.

* Replace confusing UpsertValidationTrustedCluster name

* Use UpsertTrustedClusterV2 in tests

* Address feedback

- Remove unnecessary ping
- Update error messages
- Use skipNameValidation consts
- Validate cluster name before establishing trust
- Do not reveal cluster name in error message
- Use BadParameter instead of CompareFailed

* Use webclient.Find

* Fix test/lint

* Allow label updates

* Fix test

* Update CRDs

1. Run `make manifests`.
2. Run `make -C crdgen update-protos`.
3. Run `make -C crdgen update-snapshot`.

* Implement trusted_cluster CRD

* Update docs

* Support secret lookup

* Update secret lookup docs

* Fix error handling

* Use V2

* Implement CreateTrustedClusterV2 and UpdateTrustedClusterV2

* Address feedback

* Minor fixes

* Use Create/Update instead of Upsert

* Update crdgen

* Update trusted_cluster tests

* Move V2 RPCs to the trust service

* crdgen

* Remove V2 suffix

* 2024 -> 2025

* Use slog
2025-01-13 17:21:09 +00:00
Noah Stride ccc639383a Workload ID: Introduce basic rule condition operators (#50940)
* Pull condition operators into a one of

* Add wrapper structs to support repeated

* Adjust for new protos

* Fix tflint

* Start fixing tests

* Add more test cases

* More test cases

* Fix marshalling of resource

* Fix test in lib/services
2025-01-10 21:15:11 +00:00
Paul Gottschling f63a099ca7 Add Access Monitoring compatibility docs warning (#50571)
Closes #48745

Add a warning to the External Audit Storage page that this feature is
not compatible with Access Monitoring on Teleport Enterprise (Cloud),
complementing the warning on the Access Monitoring page.
2025-01-10 18:01:35 +00:00
Steven Martin 3fc749aea7 docs: update doc verbiage for usage of 'its' (#50897)
* docs: update azure and openssh instrs

* docs: update usage of its
2025-01-09 09:39:47 +00:00
Paul Gottschling 4a2d8916d0 Remove v13 mentions in the docs (#50831)
* Remove v13 mentions in the docs

Our policy is to remove mentions of the version prior to the most recent
deprecated version.

This change includes mentions of v13 in Helm chart values file comments.

* Clarify distroless images in Helm values

Responds to hugoShaka feedback.
2025-01-08 19:37:21 +00:00
Paul Gottschling 6ff45f2a4d Fix Mattermost guide image path (#50707)
Use Markdown relative link syntax, since the `a` element leads to a
broken image link.
2025-01-07 15:46:15 +00:00
Steven MartinandGavin Frazar 6c5b737adf docs: include version in rds helm install (#50756)
* docs: include version in rds helm install

* docs: update verbiage for rds helm install

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

---------

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>
2025-01-07 10:58:21 +00:00
Brian Joerger 3ebf26978c Document second_factors field (#49016)
* Document second_factors; Update test plan.

* Update proto comment; Update terraform docs.

* Clarify second_factors reference.

* Fix docs lint.

* Address comments.

* Address marco's comment.
2025-01-06 19:57:26 +00:00
Gus Luxton c84e2f7118 docs: Update example Machine ID Kubernetes role to version v7 (#50768) 2025-01-06 16:00:24 +00:00
Paul Gottschling 9f2f4c458e Remove dots from operator reference filenames (#50734)
The dots cause issues with our hosting infrastructure, which returns
404s when users make requests for Kubernetes operator reference pages
with no trailing slash.

This change returns a filename from the format function in the CRD/CRD
docs generator so we can return different file names for CRDs and their
docs. It also renames CRD docs pages to include hyphens instead of dots
and underscores, and adds redirects.
2025-01-06 13:19:46 +00:00
Tiago Silva 4d3e7d3ec9 fix: access graph fails to fetch s3 bucket details (#50758)
* fix: access graph fails to fetch s3 bucket details

With SDK V1, AWS get bucket details such as policies, acls, status...
didn't require the specification of the target s3 bucket location. With
the recent changes to support newer versions of the AWS SDK, the get
bucket details started to fail with the following error:

```
BucketRegionError: incorrect region, the bucket is not in 'ap-south-1' region at endpoint '', bucket is in 'eu-central-1' region
status code: 301, request id: QS5C24H12ZV3VNM4, host id: mzVDk4010MPTCFdxyE/XwERX9W35MSge85PG+h5Jvwyvi7MhxdXLaysb2PTZCMY9r1ngBi6Gv6g=, failed to fetch bucket "cyz" acls polic
```

This PR uses `HeadBucket` to retrieve the location of the s3 bucket and
then uses the bucket location client to retrieve the s3 bucket details.

Fixes #50757

* fix tests

* handle review comments
2025-01-06 12:20:52 +00:00
Noah StrideandTim Buckley c37a8e8af5 Support configuring DNS SANs for X509 SVIDs using WorkloadIdentity resource (#50676)
* Extend the protobuf

* Wire up DNS SAN field to issuance code

* Regenerate tfschema

* Add DNS SANs to the audit event

* Add test

* Rename to x509

* Add test/check that validates hostname generated

* Fix TS proto

* Update lib/auth/machineid/workloadidentityv1/decision_test.go

Co-authored-by: Tim Buckley <tim@goteleport.com>

---------

Co-authored-by: Tim Buckley <tim@goteleport.com>
2025-01-06 10:14:39 +00:00
Krzysztof SkrzętnickiandRafał Cieślak 35a04406d1 Update Oracle client docs for Teleport v17.2.0+ (#49994)
* Update Oracle client docs for Teleport v17.2.0+

* remove docs for deprecated extension

* Run images through ImageOptim

* Add `@2x` suffix to high DPI images

---------

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
2025-01-03 16:17:41 +00:00
Steven MartinandPaul Gottschling 7a12f634a9 docs: add ui question on k8s faq (#50470)
* docs: add ui question on k8s faq

* docs: update verbiage for k8s faq entry

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2025-01-03 14:53:39 +00:00
Paul Gottschling ee61cce219 Document event filtering in the event handler (#50689)
Closes #23277

Document the `types`, `skip-event-types`, and `skip-session-types` event
handler configuration fields. The `finish-event-handler-config.mdx`
partial is the most appropriate place for this, since it already
includes instructions for tailoring the user's event handler
configuration.
2025-01-03 14:15:50 +00:00
Logan Davis 5d11de027f [16.4.11] bump cloud docs (#50352) 2024-12-30 23:33:20 +00:00
Zac Bergquist fd03441c32 docs: add caveat about changing an agentless node's hostname (#50587)
Changing the hostname of a node resource will update in the web UI
very quickly, but attempting to connect to the resource using it's
new hostname will fail if the new hostname is not present in the
node's host certificate.

Closes #42315
2024-12-30 17:25:29 +00:00
Paul Gottschling 3aecd4bc4c Fix Vale warnings in three guides (#50357)
- Getting started guide for auto-discovering Kubernetes applications.
- DynamoDB (as an application) guide. This change does not address one
  Vale warning with `tsh aws dymamodb`, which is a false positive.
- Getting started guide for protecting applications.
2024-12-27 15:13:12 +00:00
e6c23cd97f Update docs to mention PostgreSQL access through WebUI (#50363)
* feat(docs): add mention to postgres webui access

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* refactor(docs): code review suggestions

* refactor(docs): expand limitations section

* docs: fix typo

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
2024-12-24 01:26:19 +00:00
Paul Gottschling 32fb6f1d8b Edit docs CI workflows to accommodate Docusaurus (#48388)
* Edit docs CI workflows to accommodate Docusaurus

- Copy the `gravitational/teleport` source into the `content` directory
  of a `gravitational/docs-website` clone and overwrite the `git-update`
  yarn script with a no-op command. With way, we can use the
  `gravitational/teleport` clone across multiple workflow steps (e.g.,
  the prose linting step), and can identify a branch to pull using the
  `actions/checkout` defaults. Name the submodule directory `current` to
  match the expectations of the Docusaurus site.

- Remove the Vercel preview workflow. After the docs engine migration,
  we'll no longer need to deploy a preview to Vercel in order to show
  docs authors what their potential changes look like on a rendered docs
  site.

Also fixes spelling errors caught by a later version of cspell.

* Fix shellcheck issues in doc-tests.yaml script

- Add `exit` commands for failed `cd`s
- Don't read from and write to `package.json` in the same pipeline
- Add double quotes around variables

* Use latest Docusaurus site config schema

* Fix the Prepare docs site configuration step

- Remove unneeded `cd`s
- Use the correct version name in the `config.json` prepared for the
  Docusaurus site
2024-12-23 14:59:34 +00:00
Krzysztof SkrzętnickiandPaul Gottschling 074d584b7a Document disabling default import rule (#50324)
* Document disabling default import rule

* Update docs/pages/enroll-resources/database-access/rbac.mdx

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

* Update docs/pages/enroll-resources/database-access/rbac.mdx

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-12-23 13:03:41 +00:00
Noah Stride 3796023d01 Add support for WorkloadIdentity resource to the Teleport Terraform Provider (#50382)
* First pass at trying to generate terraform provider

* Wire up types

* Fix generation of docs

* Add godoc comments

* Add tests

* Tflint and add example
2024-12-20 18:37:20 +00:00
Paul Gottschling a51b78b4e6 Fix TTL mistake in a partial (#50401)
Closes #47068

The TTL shown in a `tctl auth sign` command does not correspond to the
description of the TTL. Fix the description while making the TTL an
integer divisible by 24.
2024-12-19 14:49:44 +00:00
Steven Martin 48f7e1afe0 docs: remove references to enterprise version of tctl (#50419) 2024-12-19 14:49:04 +00:00
Krzysztof SkrzętnickiandSTeve Huang ba35baa30d Detail DAC and TAG integration from the user perspective (#46069)
* Detail DAC and TAG integration from the user perspective

* Change wording to make linter happy.

* Fix broken links and spacing

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

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Update screenshots. Drop redundant instructions and merge the information into an existing suitable page.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
2024-12-19 08:13:03 +00:00
Erik Tate e67a13e885 replacing documentation references to port_forwarding with ssh_port_forwarding and adding some additional context to the rbac reference (#50361) 2024-12-18 22:58:39 +00:00
Steven Martin 17ffecc5e9 docs: update backup and restore for data dir (#50155)
* docs: update backup and restore for data dir

* docs: update configuration ref

* docs: update teleport config ref
2024-12-17 18:54:33 +00:00
Paul Gottschling 7384627523 Update the version support table (#50345)
Reflect the v17 release date.
2024-12-17 18:01:45 +00:00
Steven Martin 988a531450 docs: update tsh client guide for trusted clusters (#50151)
* docs: update tsh client for trusted clusters

* docs: remove extra space in tsh guide
2024-12-17 14:06:15 +00:00
Steven Martin e962db0e03 docs: update tsh pkg install instructs for v17+ (#50261)
* docs: update tsh pkg install instructs for v17+

* remove tsh pkg for community download link
2024-12-16 20:01:01 +00:00
Noah Stride 62d8125a6e Add note on HOST_PROC environment variable (#50217)
* Add note on `HOST_PROC` environment variable

* Clarify procfs
2024-12-16 12:57:31 +00:00
Rafał Cieślak cfc6821351 Add docs for multi-port TCP access (#50216)
* Add docs for multi-port TCP access

* Remove unknown word from TODO comment
2024-12-16 09:59:34 +00:00
Paul Gottschling 7a9fbdad25 Fix Vale warnings in the Reference section (#50168)
Skip warnings in auto-generated pages, which we can handle in a separate
change.
2024-12-13 21:07:14 +00:00
Steven Martin 2c82b83622 docs: remove var reference that isn't used in terraform provider (#50141) 2024-12-12 18:12:33 +00:00
Noah Stride 49c30832f7 Add workload_identity_labels to RoleCondition (#50071)
* Add WorkloadIdentityLabels field to role

* Wire up access checker

* Add validation for new field

* Update CRDs

* Add to terraform provider

* Mispel some words to keep the republic happy

* Add WorkloadIdentityLabelsExpression

* Update Terraform provider

* Add to operator CRD

* PLS RUN CLA CHECK
2024-12-12 11:46:19 +00:00
Leszek Charkiewicz ca45908982 [16.4.9] bump cloud docs (#49993) 2024-12-12 10:52:42 +00:00
Steven Martin f72a4a4d78 docs: update sso icons (#50107) 2024-12-11 22:57:46 +00:00
Steven Martin 688f97c95c docs: update new integration path for policy (#50012)
* docs: update new integration path for policy

* docs: correct button text reference
2024-12-11 16:27:56 +00:00
STeve (Xin) Huang 80a58fc82c GitHub proxy part 5: OAuth flow to retrieve GitHub identity (#49849)
* GitHub proxy part 5: OAuth flow to retrieve GitHub identity

* review comments round1

* review comments round 2 and update tsh git list

* make -C integrations/operator crd

* make -C integrations/terraform docs

* fix flaky test
2024-12-10 17:31:32 +00:00
milos-teleport 640a6d625e fix: Corrected postStart examples (#50001) 2024-12-10 14:53:04 +00:00
Steven Martin f10b154c73 docs: update integrations image (#49954) 2024-12-10 14:02:19 +00:00
Paul Gottschling e7a16ccf8c Fix Vale warnings in the Access Monitoring guide (#49958) 2024-12-10 13:25:48 +00:00
marieandRafał Cieślak b929674c30 docs: update images for master and v17 (#48824)
* updated images for master and v17

* image and link edits

* image updates

* image updates - arch

* image updates - desktop and k8 diagrams

* updated UI screengrabs post-feedback

* updated UI screengrabs - desktop

* updated UI screengrabs post-feedback

* move image to correct path

* restoring connect-my-computer-setup

* replacing missed images

* replacing missed images

* a few more image changes

* a few more image changes

* image updates - post feedback

* Update docs/pages/admin-guides/access-controls/sso/github-sso.mdx

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>

* empty ref - image was removed

* empty ref - image was removed

---------

Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
2024-12-10 02:00:31 +00:00
Paul Gottschling b975c0e5f5 Correct Vale lint errors in partials (#49798)
One edge case is the `structure.architecture-h2` warning in
`docs/pages/includes/database-access/rds-proxy.mdx`. This is technically
correct, since the "How it works" section is before the "Prerequisites"
section. We can determine whether this is a bug to fix in a separate
change.
2024-12-09 19:50:55 +00:00
Paul Gottschling c117df3097 Fix Vale warnings in the Google Cloud KMS guide (#49911) 2024-12-09 19:12:20 +00:00
Zac Bergquist 373d34bdc2 docs: mention LSA protection (#49729)
The Teleport package that is installed for RDP access as local
Windows users is not signed by Microsoft and therefore will not
load on systems with LSA protection enabled.

Updates gravitational/teleport.e#5615
2024-12-09 18:34:50 +00:00
Alan Parra 8f4e8c94fa Suggest enabling PROXY protocol in DTW troubleshooting (#49791)
* Suggest enabling PROXY protocol in DTW troubleshooting

* Mention audit as a source of information for errors

* Mention solutions for both L7 and L4 LBs

* Link X-Forwarded-For to config references
2024-12-06 18:50:25 +00:00