Commit Graph
79 Commits
Author SHA1 Message Date
Marco Dinis 8bc4b5322f Docs: remove mention to Teleport 6 (#51168) 2025-01-17 16:22:34 +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
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
Bartosz Leper 1481cb407b Update the SSO button design and fix autofocus (#44889)
* Update the SSO button designs

- Use correct IDP icons
- Add Okta to the list of guessed providers
- Fix broken autofocus for SSO and passwordless methods
- Update the docs that contained previously incorrect information about the display attribute of the connector resource definition

* Fix the Connect cluster login dialog layout

* Use data-testid instead of class in ResourceIcon

* Remove unnecessary React.Fragment
2024-08-01 12:18:39 +00:00
Andrew LeFevreandAndrew LeFevre bca2943dca add option to allow client redirects from IPs in specified CIDR ranges in SSO client logins (#44556)
Co-authored-by: Andrew LeFevre <Andrew LeFevre>
2024-07-30 21:02:57 +00:00
Marco Dinis 648592d0e2 Generate docs from proto definitions (#44547) 2024-07-23 15:31:53 +00:00
Yassine Bounekhla f6087104bf [Docs] Add SAML Single Logout instructions to docs (#44262)
* add saml slo instructions to docs

* CR
2024-07-19 17:22:15 +00:00
Hugo ShakaandRoman Tkachenko 3afa6b5d1d Document creating SSH servers via IaC (#39726)
* document creating SSH servers via IAC

* add links and index page

* Apply suggestions from code review

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

* address feedback + fix Var XML tags

* test tctl flow and fill tctl command outputs

* fix kubernetes and terraform documentation

* make docs linter happy

---------

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2024-03-28 21:28:02 +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
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
Noah Stride 4a43c5a252 Improve Access Plugins/Audit Exporter docs flows (#36083)
* Fix mattermost identity file path

* Adjust event handler docs

* Update rest of access plugins
2024-01-02 18:32:31 +00:00
Paul Gottschling 9ff60d63b2 Refresh the Jira Access Request plugin guide (#35635)
Closes #14580
Closes #17528

Get the Jira guide to follow the structure of other Access Request
plugin guides, including instructions for Teleport Cloud and Machine ID
users.

Also make some small adjustments for clarity and readability:
- Flesh out the intro to include sarchitectural information.
- Make the prerequisites list more comprehensive.
- Fix the list of columns required in the project board, which is out of
  date.
- Mention the `/status` endpoint of the webhook.
2023-12-19 21:39:53 +00:00
Tiago Silva 3e8832e33a Pin Teleport Terraform Provider to Teleport major version (#32784)
* Pin Teleport Terraform Provider to Teleport major version

The previous constrain `>= (=teleport.version=)` allows Terraform to
pick any version bigger than the specified version. This is a problem
because `>= 12.0.0` can actually select `14.0.0` which breaks our client
guarentees when connecting to Auth server.

This PR forces Terraform to pick any version `>=12.0.0` and `< 13.0.0`.
The pessimist version constrain prevents Terraform provider to use
versions outside of the specified major version.

Signed-off-by: Tiago Silva <tiago.silva@goteleport.com>

* fix spell

---------

Signed-off-by: Tiago Silva <tiago.silva@goteleport.com>
2023-10-03 09:03:24 +00:00
Andrew LeFevre 61bce3e3ec document OIDC connector 'max_age' field (#31800)
* document OIDC connector 'max_age' field

* addressed feedback

* address feedback
2023-09-14 14:53:31 +00:00
Brian Joerger cf6473feb9 Add gRPC error interceptors to API client (#30578)
* Move gRPC error intercetpors to api/utils/grpc/interceptors.

* Use error interceptors in api client and mock server.

* Apply suggestions from CR.

* Unwrap FromGRPC errors in middleware.

* Use gRPC auth service in tests instead of external example service.

* It's gRPC!!!

* Fix unit test.

* Add error interceptor to proxy client.

* Fix merge conflict.
2023-08-24 23:27:06 +00:00
Paul Gottschling 322cb2d026 Include consistent installation info (including Helm) across Access Request plugin docs (#26783)
* Use partial for Access Request plugin install docs

The Access Request plugin installation instructions are _almost_
standard. Make the instructions more consistent and easier to edit by
replacing them with a partial. Use our partial parameter substitution
syntax to supply the name of each plugin.

* Respond to alexfornuto feedback

* Add a missing `sudo`

Partially responds to stevenGravy feedback

* Add consistent Helm details

Ensure all Access Request plugin guides include the same Helm-related
steps. Excluding the Jira plugin because that guide is out of date and
will be addressed in a separate change.

Also removes the "Feedback" section from each Access Request plugin
guide.  These are out of step with the rest of the docs, which don't
include a feedback section, and do not reflect the current location of
the Access Request plugin source.

* Spelling and linter fixes
2023-08-14 16:16:40 +00:00
Alex Fornutoandlsgunn-teleport b5891eda74 Docs: Update OIDC SSO Guide (#29087)
* remove SSH focus, fix formatting

* refresh OIDC guide / example

* Apply suggestions from code review

* modify link for linter

* Apply suggestions from code review

Co-authored-by: lsgunn-teleport <136391445+lsgunn-teleport@users.noreply.github.com>

* make up your mind, linter

---------

Co-authored-by: lsgunn-teleport <136391445+lsgunn-teleport@users.noreply.github.com>
2023-07-21 15:48:47 +00:00
Alex Fornuto 90d4076ffb Docs: Update/Refresh OneLogin SSO guide (#28444)
* update to not be SSH-specific

* hard breaks ~80 chars

* undo changes from d80ab5b...

I had adjusted this section to fit as a prereq bullet point. It makes more sense for this to be a unique section at the bottom of SSO pages, so that the reader only changes the default auth method _after_ completing the setup.

* update onelogin SSO guide

* Respond to @ptgott's feedback
2023-07-06 14:42:36 +00:00
Steven Martin 32a6e6a5d1 remove sentence fragment and link (#28367) 2023-06-29 17:16:25 +00:00
18b84bdc53 Docs: Update Google Workspace SSO Guide (#28117)
* Improved Google SSO Connector Documentation.

- Tweaked gworkspace-connector-inline.yaml to improve tokens.
- Tweaked gworkspace-connector.yaml to improve tokens.
- Improved verbiage around required scopes.
- Improved oAuth client URL so it scopes to cloud.

* Fix typo.

* update google workspace SSO guide

* remove 3080 from examples

* Update to prefer embedded JSON

* Update examples/resources/gworkspace-connector.yaml

Co-authored-by: Krzysztof Skrzętnicki <krzysztof.skrzetnicki@goteleport.com>

* standardize user vars

* formatting

* Apply suggestions from code review

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

* Update docs/pages/access-controls/sso/google-workspace.mdx

---------

Co-authored-by: Travis Swientek <tswientek@goteleport.com>
Co-authored-by: Krzysztof Skrzętnicki <krzysztof.skrzetnicki@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-06-29 15:51:12 +00:00
Noah Stride 33cc58da54 Switch to recommending identity file in terraform guide (#26995) 2023-05-26 20:45:34 +00:00
Steven Martin bebef91be8 docs: make consistent access request plugins helm configuration and instructions (#24654)
* docs: make consistent helm configuration and instructions

* Language updates and identity file fix

* fix identity file refs

* label as Teleport Enterprise Cloud, not Teleport Cloud
2023-04-18 19:26:51 +00:00
Nic Klaassen 03e361b6b3 docs: Login Rules Terraform docs (#23855) 2023-04-17 16:20:35 +00:00
Paul Gottschling 0cde85ebc0 Edit cluster joining info in Access Request docs (#23405)
* Edit cluster joining info in Access Request docs

See #21305

Edit Access Request plugin guides to remove the options to connect to
the Auth Service directly. This simplifies the guides and helps us
standardize the docs around connecting services via the Proxy Service.

Also make the Jira guide more consistent with other Access Request
plugin guides (this is not an attempt to refresh the guide, which is
still out of date, but will help us refresh the guide when the time
comes).

* Fix linter issues

* Respond to PR feedback
2023-03-29 19:28:58 +00:00
Alex FornutoandPaul Gottschling 44d70a1ba7 Docs: Overhaul Okta SAML guide. (#23053)
* use tctl edit in partial

* configure as prereq bullet point

This partial is used exclusively as a prereq item in the guides calling it. This change updates the render to properly embed it as a prerequisite bullet item.

* overhaul Okta SAML guide

* trailing newline

per https://github.com/gravitational/teleport/pull/23053/files\#r1135862340

* respond to copy review

* Apply suggestions from code review

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

* rm outdated header refs

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-24 16:50:35 +00:00
Steven Martin 47d5f236ef Use GitHub camelcase for UI, examples, and Messages (#23369)
* Use GitHub camelcase

* Update example github to camelcase

* Update references to GitHub as camelcase
2023-03-22 22:10:12 +00:00
Steven Martin d281fd7c8e Examples spell fixes and discord example fix (#22606) 2023-03-03 22:45:08 +00:00
b161c1d520 Clarifications in Okta SSO doc (#21777)
Clarify the usage of the `attributes_to_roles` parameter and reorder some
mapping keys for clarity in the example SAML connector resource.

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-17 21:36:14 +00:00
Hugo ShakaandPaul Gottschling a2b5a37f94 Document Discord access plugin (#17593)
* Document Discord access plugin

* Apply suggestions from code review

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

* fixup! Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-11-25 21:43:58 +00:00
Steven Martin d329ff3662 Remove note about unsupported IdP-initiated SAML (#18190) 2022-11-07 20:34:00 +00:00
Steven Martin 098df16c5e correct addr example (#17654) 2022-11-03 13:33:26 +00:00
Alex Fornuto e09671f562 remove apostrophe on non-possesive 'IDs' (#16837) 2022-10-28 19:22:53 +00:00
Hugo ShakaandPaul Gottschling a458b41143 docs: Simplify onelogin sso intructions (#17554)
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-10-21 21:09:35 +00:00
Steven Martin 9fb62b503f correct plugin name reference (#17013)
* correct plugin name

* correct plugin name
2022-10-04 19:37:49 +00:00
Joel d0c4dc251a Add docs for IdP-initiated SSO (#16093) 2022-09-30 16:18:37 +00:00
Reed Loden 823057f9b0 terraform: Fix all tfsec, tflint, and ansible-lint warnings within examples/aws/terraform (#16531) 2022-09-28 22:35:49 +00:00
Bence Kiglics 41474a021d Add documentation for Slack Helm chart (#13726)
It includes an updated guide and the reference of the new Helm chart.
2022-09-26 10:11:17 +00:00
c9fbcc03ad Document MsTeams access plugin (#15941)
Co-authored-by: alexfornuto <alex@fornuto.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-09-22 18:35:06 +00:00
Bence Kiglics c522b38383 Add documentation for MatterMost Helm chart (#13728)
Includes an updated guide and the reference of the new Helm chart.
2022-09-08 11:49:30 +00:00
Bence Kiglics 5e476ed17d Add documentation for PagerDuty Helm chart (#13729) 2022-08-31 15:57:20 +00:00
Paul Gottschling 7204503cca Edit the PagerDuty Access Request plugin guide (#15498)
Fixes #14576

- Add updated instructions, as the behavior and configuration settings
  for the PagerDuty plugin have changed since we first added this guide.
- Ensure the guide can be followed as a set of step-by-step
  instructions. For example, this change tells the user to create two
  PagerDuty services and refers to these services throughout the page.
- Also edits example configs for the PagerDuty and Mattermost plugins.
2022-08-30 16:42:52 +00:00
Bence KiglicsandPaul Gottschling 6e246ab5c9 Add documentation for Jira Helm chart (#13730)
* Add documentation for Jira Helm chart

It includes an updated guide and the reference of the new Helm chart.

* Fixed some minor mistakes in the guides

* Reorganized Helm related examples

* Fixed a few minor mistakes

* Alphabetized jira.* settings

* Renamed Cloud to Executable in Testing

* Extended YAML config example with explanation

* Edit Jira Access Request plugin Helm chart docs

- Edit the configuration instructions so we don't instruct Helm users to
  use the `configure` subcommand. Also use the `Tabs` component's
  dropdown functionality so we can include both self-hosted and Teleport
  Cloud instructions for Helm and VM users.

- Minor style tweaks.

* Add Helm Chart example to Installation section

* Removed confusing (and broken) link
git push

* Fixed wrong default value

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-08-26 12:23:07 +00:00
Steven Martin e9bd3e78c6 Spelling fixes additional (#14823) 2022-07-25 14:41:34 +00:00
Steven Martin 83256ed760 Spelling Fixes (#14815)
* Misspelling fixes
2022-07-23 20:24:45 +00:00
Brian JoergerandPaul Gottschling 5ec15cbbb9 Rework slack docs to reflect latest changes (#10607)
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-05-19 14:43:24 -07:00
Trent Clarke e228fe5f1a Updates terraform docs for provider (#12314)
Updates the Terraform getting started guide to reflect the use of a
custome provider registry:

 * Removes the now-superfluous installation step
 * Updates examples to reflect actual location of terraform provider
2022-05-03 10:18:39 +10:00
Marco André Dinis 6c091215e9 Terraform: improve docs for multiple node labels (#12351)
Relates to #12227
2022-05-02 22:36:02 +00:00
Marco André Dinis 65425313af Update syntax to respect TF minimum version (1.0.0) (#11669)
Most of the changes are related to the strictness of TF v0.12

https://www.terraform.io/language/upgrade-guides/0-12
> Due to the design of the configuration language decoder in
> Terraform v0.11 and earlier, it was in many cases possible to
> interchange the argument syntax (with =) and the block syntax
> (with just braces) when dealing with map arguments vs. nested
> blocks. However, this led to some subtle bugs and limitations,
> so Terraform v0.12 now requires consistent usage of argument
> syntax for arguments and nested block syntax for nested blocks.

This commit validates both examples against Terraform 1

The min terraform version is going to be updated to 1.0.0
https://github.com/gravitational/teleport/pull/11650

Fixes #11652
2022-04-15 10:29:35 +00:00
Paul Gottschling 973cb8aac0 Edit three guides for Cloud users (#11115)
See #10633

Terraform Provider guide

- Add tabbed prerequisites so users only see information relevant to
  their scopes.

- Add the impersonation section as an H3 rather than an Admonition. If
  users are learning how to use our Terraform provider, they likely
  will not have enabled impersonation for the Terraform user, and would
  always need to read the Admonition, so this would work better as an
  H3.

- Add a scoped Notice indicating which address to use for the cluster
  address in the sample Terraform config.

Fluentd plugin guide

- Add tabbed instructions for users of different scopes.

- Move the impersonation Admonition to an H3 so readers can configure
  impersonation without running into an error.

- Misc clarity/style edits.

Certificate Authority Rotation

- Add tabbed prerequisites so users of one scope don't see information
  intended for other scopes.
2022-03-21 22:34:34 +00:00
Paul Gottschling 5f14bc5128 Add plugin setup instructions for cloud users (#9470)
* Add plugin setup instructions for cloud users

- Turn the identity file export and RBAC instructions into
includes, since these instructions are the same for each
plugin.

- Change the tab set re: an impersonation role to a detail box
scoped to cloud users.

- Add separate example config files for cloud and self-hosted
deployments of each plugin.

- Misc. changes for clarity

Fixes #8936

* Respond to PR feedback

Also make minor stylistic tweaks

* Respond to PR feedback with stylistic tweaks
2022-03-03 16:38:19 +00:00