Commit Graph
46 Commits
Author SHA1 Message Date
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
a7f016a8d8 Updated docs for the improved Google OIDC connector (#9907)
* Updated docs for the improved Google OIDC connector

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Zac Bergquist <zmb3@users.noreply.github.com>

* Use "code" blocks for copyable commands

* whitespace

* Consistency with punctuation and avoid splitting paragraphs with images.

* Updated error message matching the current code

* Bump minimum version for OIDCConnector v3 to 8.1.2

* More fixes

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Zac Bergquist <zmb3@users.noreply.github.com>
2022-01-26 10:45:22 +00:00
Steven Martin e8a76f4c81 Correct terraform guide example (#8630) 2021-10-20 15:50:49 -07:00
Steven Martin 0a00f04665 Updated slack plugin instructions to allow for Teleport Cloud (#8540) 2021-10-14 08:33:10 -07:00
Steven Martin 0b2f39d86c Gives inline info for Google Service account for SSO (#6728) 2021-05-12 09:52:18 -07:00
Alexander KlizhentasandBen Arent 06b7dc5fd2 Teleport Slackbot for latest slackbot (#6522)
Co-authored-by: Ben Arent <ben@goteleport.com>
2021-04-20 19:08:05 -07:00
Ben Arent a04b377663 Update Google Workspace and Okta Docs (#6267)
* Update GSuite and Okta Docs
* s/suite/workspace
* Remove use of admin to use editor
2021-04-05 15:45:08 -07:00
Andreas Lutro 23b80356b5 correct typo in onelogin connector config example (#5372) 2021-01-21 13:15:45 -04:00
Ben Arent 51f3076973 [examples] Fixing extra s/admins/admin (#4683) 2020-11-03 08:34:38 -08:00
Ben ArentandGus Luxton 6e784c9413 [docs] Feature content for Teleport 4.4 (#4488)
Co-authored-by: Gus Luxton <gus@gravitational.com>
2020-10-19 08:28:36 -07:00
Steven Martin c0a99aa837 Correct SAML web callback (#4158) 2020-08-04 08:44:32 -04:00
Travis Swientek c538fb2e73 Workflow Documentation Fixes (#4111)
* Fixes documentation typo for Slack workflow.
* Improve the example workflow Slack toml comments.
* Remove --pid-file from workflow systemd units.
* PR feedback. teleport-slackbot -> teleport-slack
2020-07-24 10:17:59 -05:00
Ben Arent da216db761 Updated Teleport Jira Server Approval Plugin Docs & Updated Plugin TOML (#3879) 2020-06-25 10:11:38 -07:00
Ben Arent ff4d3ed43a Update SSO Docs via Testing Feedback (#3898) 2020-06-25 10:04:41 -07:00
3976a99771 Teleport 4.3 Docs (#3423)
* Base fork for 4.3 docs

* [docs] external email identities and Kube Users (#3628)

* Base fork for 4.3 docs

* [docs] external email identities and Kube Users (#3628)

* Remove trailing whitespace from docs files

Some editors will do this automatically on save. This causes a lot of
diffs when editing the docs in such an editor.
Clean them up once now and we'll try to keep it tidy going forward.

* Add make rules for docs whitespace and milv

docs-test-whitespace: checks for trailing whitespace in all .md files
  under docs/.
docs-fix-whitespace: removes trailing whitespace in all .md files under
  docs/.
docs-test-links: runs milv in all docs/ subdirectories that have
  milv.config.yaml.
docs-test: runs whitespace and links tests, used during `make docs`

* Document the new `--use-local-ssh-agent` flag for tsh

The flag is used to bypass the local SSH agent even when it's running.
Specifically, this helps with agents that don't support certs.

The flag was added in #3721

* Remove pam_script.so docs from SSH PAM page

With #3725 we now populate teleport-specific env vars in a way that's
accessible to `pam_exec.so`. There's no longer any reason to install
pam_script.so separately and duplicate our docs.

Updates #3692

* Using the correct --insecure-no-tls flag

* Run docs-fix-whitespace make rule in a busybox container


* Fixes #3414

Co-authored-by: Andrew Lytvynov <andrew@gravitational.com>
Co-authored-by: Gus Luxton <gus@gravitational.com>
Co-authored-by: Steven Martin <steven@gravitational.com>
Co-authored-by: Gus Luxton <webvictim@gmail.com>
2020-06-17 17:09:41 -07:00
Ben Arent 7290720845 Fix for #3420 - Docs for OIDC for set prompt option. (#3589)
* Fix for #3420
* sets current prompt
2020-04-22 17:16:56 -07:00
Ben Arent 723ea0cd12 Error in Github.yaml (#3523) 2020-04-07 09:21:20 -07:00
Ben Arent 59a652522f Fix formatting issues on Trusted Cluster and GSuite 2020-03-30 17:21:50 -07:00
aelkugia 748691ff19 Adding sample k8s-groups role to .../examples/resources 2020-02-28 18:31:45 -08:00
Ben Arent 930be29dd2 Updated Auth Connectors Examples and Documentation.
* Update all connector YAML configs
* User <cluster-url> as standard
* Leverage markdown_include.include
* Include screenshots for Buttons based on Display.
2020-02-26 14:57:25 -08:00
Russell Jones c4b3089247 Update saml-connector.yaml 2018-04-19 18:09:30 -07:00
Ev Kontsevoy af302a7d53 PR edits 2017-09-14 11:58:08 -07:00
Ev Kontsevoy 1231e75b25 Documentation edits
Some users noticed that 'display' field is not well-documented for the
connectors.

I also noticed that some defaults are not sensible (like "google" as the
provider)
2017-09-14 11:35:38 -07:00
Ev Kontsevoy 2f7200b112 Another typo! 2017-09-13 18:41:44 -07:00
Ev Kontsevoy 23bd85a27e Typo 2017-09-13 18:41:11 -07:00
Ev Kontsevoy 5d866f2305 Added RBAC version of 'trusted cluster' resource to examples 2017-09-13 18:38:40 -07:00
Ev Kontsevoy 47c1791437 Updated comments inside the examples 2017-09-13 18:13:08 -07:00
Ev Kontsevoy efde3681a0 Updated 'examples/resources' with more comments 2017-09-12 18:06:08 -07:00
Ev Kontsevoy 82cb0ce01d Updated resource examples 2017-09-12 10:36:32 -07:00
Ev Kontsevoy 3533903c0e Lots of documentation edits.
Minor code changes too (only comments)
2017-09-11 20:27:42 -07:00