Update SSO guides to take into account new commands: `tctl sso test`, `tctl sso configure`. by Tener · Pull Request #12941 · gravitational/teleport

Tener · 2022-05-26T14:10:14Z

Planned scope of this PR:

Parent: #9270

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

…scope

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

… to github-sso

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

Edit the SSO introduction: - Add examples of all connectors so users don't need to find them in the examples directory - Add subheadings to the "Configuring SSO" section for clarity - Minor grammar/style edits Specific SSO guides: - Use the commercial-prereqs-tabs partial in Prerequisites sections, since this partial already exists, rather than ent-user-prereqs.mdx. This partial is more specific about requiring a running Teleport cluster, and links to the Getting Started guide for the Enterprise edition. - Minor tweaks to the scoped information shown in the samlauthentication.mdx and oidcauthentication.mdx partials - Restored the original wording of edition-prereqs-tabs.mdx, which is more specific about how to get started with a running Teleport cluster on different editions, and includes instructions for tsh.

ptgott

I've left a partial review. I need to continue reviewing at the top of the new "Step 3/5. Test the connector" section.

ptgott · 2022-05-31T20:25:56Z

Go


-The values of `client_id`, `client_secret`, and `redirect_url` come from the
-GitHub OAuth App you created earlier.
+The values of `client_id`, `client_secret` come from the GitHub OAuth App you created earlier. `redirect_url` is automatically configured by [`tctl sso configure github`](../reference/cli.mdx#tctl-sso-configure-github) based on the settings of Teleport cluster. 


Suggested change

The values of `client_id`, `client_secret` come from the GitHub OAuth App you created earlier. `redirect_url` is automatically configured by [`tctl sso configure github`](../reference/cli.mdx#tctl-sso-configure-github) based on the settings of Teleport cluster.

The values of `client_id` and `client_secret` come from the GitHub OAuth App you created earlier. `redirect_url` was automatically configured based on the settings of your Teleport cluster when you ran `tctl sso configure github`.

To connect the tctl command to the earlier step in this section. Also, I think we can remove the inline link to avoid breaking the reader's focus (https://goteleport.com/docs/contributing/documentation/style-guide/#expectations-1).

@ptgott

Thank you for the improved phrasing.

I'm not sure if including the link constitutes the breaking of reader focus: we are not forcing them to follow the link, but rather making an option to do so if they are interested. This is similar to inline-link style in Wikipedia, for example:

== Architecture ==

Teleport is written in Go programming language, and runs on UNIX-compatible operating systems, including Linux, macOS, and several BSD/OS variants. Teleport consists of two executables: tsh (command line client) and teleport (server daemon).

Let me know what you think, though.

Tener · 2022-06-01T12:50:54Z

@ptgott thank you for the review. I discovered there is another SSO docs PR in flight, which is about to land soon: #12407. I'll need to merge my changes with those before they are review-worthy...

Tener · 2022-06-02T12:13:24Z

@ptgott I have rebased this PR on top of another, so this is tagged as "Outdated" #12941 (comment), but this is definitely still relevant. Hoping to hear your thoughts on this.

ptgott · 2022-06-03T15:34:14Z

@Tener Thanks for working on this! Let me know when all guides have been added, and I'll carve out time to give this PR a complete review.

ptgott · 2022-06-10T19:37:14Z

@Tener Also, would it be feasible to split this into multiple PRs, either one per guide or one per ≈250-500 lines of changes? This will make it a lot easier for me to review. We can also can get completed guides merged while others are waiting to be finished.

Tener · 2022-06-13T09:47:40Z

@Tener Also, would it be feasible to split this into multiple PRs, either one per guide or one per ≈250-500 lines of changes? This will make it a lot easier for me to review. We can also can get completed guides merged while others are waiting to be finished.

No problem, I can split it. I'm waiting for #12407 to be merged before I continue the work on this one.

Tener · 2022-07-08T13:47:22Z

Closing in favor of more granular PRs.

github-actions Bot requested review from ptgott, r0mant, xinding33 and zmb3 May 26, 2022 14:10

github-actions Bot added the documentation label May 26, 2022

Tener force-pushed the tener/tctl-sso-docs branch from 377dee1 to 221b96a Compare May 26, 2022 14:13

stevenGravy and others added 24 commits May 26, 2022 15:01

Consistent prerequisites and Teleport cloud

3739247

Modified to make cloud example

e5bee26

spelling mistake

09327f2

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

missing period

036284e

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

verbiage

71066ca

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

verbiage

5169ea5

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

verbiage

3dd5109

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

cloud and self-host default auth example

88f4512

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

Modified pre-req to show required enterprise or cloud installed with …

18ece4a

…scope

verbiage

6c578d0

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

Updated github to match other ssos. tctl desktop connection

b81d599

Makes consistent across github and ent ssos

1c9db65

lint fixes

49849f0

verbiage update

f7c8213

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

verbiage update for adfs prereq

4e48846

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

okta prereq verbiage updated

0a2f895

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

remove spaces

672a8ed

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

verbiage change

ba548c7

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

Corrected OIDc prereq and fixed bullet in include

89f42df

Removed specific github content from editition-prereqs-tabs and moved…

249999d

… to github-sso

verbiage change

02175e6

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

Addressed review items

dcfdd35

Combined tctl instructions

a536603

ptgott reviewed May 31, 2022

View reviewed changes

Merge branch 'master' into stevenGravy/docs/prereqs

d024217

stevenGravy and others added 16 commits June 1, 2022 08:58

remove extra line

740ff49

Remove extra line

19ba95b

CLI reference for tctl sso test, tctl sso configure.

6ff9dfe

Update GitHub SSO guide.

df39313

Comment out command output.

ce97db4

Adjust SSO troubleshooting, OIDC includes, minor fixes.

6995963

Okta SSO guide changes, including adding tctl sso command usage.

bdcc8f9

Lint fixes in Okta guide.

48e1471

Azure, ADFS guides.

351612f

Uniform titles for SSO guides.

104728b

Reflect increased Teleport product scope.

a74a3bf

Cosmetic changes to Okta guide.

7077a3e

Extend tctl sso test exapmles.

ec6cccf

Add a notice about required permissions.

83738ec

Gitlab guide changes.

8244e9c

Changes from review.

f295584

Tener force-pushed the tener/tctl-sso-docs branch from f410f8b to f295584 Compare June 2, 2022 12:10

Tener changed the title ~~Update docs for tctl sso test, tctl sso configure.~~ Update SSO guides to take into account new commands: tctl sso test, tctl sso configure. Jun 3, 2022

Tener mentioned this pull request Jun 3, 2022

CLI ref for tctl sso commands. #13148

Merged

Tener closed this Jul 8, 2022

Tener mentioned this pull request Jul 8, 2022

tctl sso: update general SSO docs and GitHub guide. #14227

Closed

Tener deleted the tener/tctl-sso-docs branch July 22, 2022 08:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update SSO guides to take into account new commands: `tctl sso test`, `tctl sso configure`.#12941

Update SSO guides to take into account new commands: `tctl sso test`, `tctl sso configure`.#12941
Tener wants to merge 42 commits into
masterfrom
tener/tctl-sso-docs

Tener commented May 26, 2022 •

edited

Loading

Uh oh!

ptgott left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ptgott May 31, 2022

Uh oh!

Tener Jun 2, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Tener commented Jun 1, 2022 •

edited

Loading

Uh oh!

Tener commented Jun 2, 2022 •

edited

Loading

Uh oh!

ptgott commented Jun 3, 2022

Uh oh!

ptgott commented Jun 10, 2022

Uh oh!

Tener commented Jun 13, 2022

Uh oh!

Tener commented Jul 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	The values of `client_id`, `client_secret` come from the GitHub OAuth App you created earlier. `redirect_url` is automatically configured by [`tctl sso configure github`](../reference/cli.mdx#tctl-sso-configure-github) based on the settings of Teleport cluster.
	The values of `client_id` and `client_secret` come from the GitHub OAuth App you created earlier. `redirect_url` was automatically configured based on the settings of your Teleport cluster when you ran `tctl sso configure github`.

Conversation

Tener commented May 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ptgott left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ptgott May 31, 2022

Choose a reason for hiding this comment

Uh oh!

Tener Jun 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Tener commented Jun 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Tener commented Jun 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ptgott commented Jun 3, 2022

Uh oh!

ptgott commented Jun 10, 2022

Uh oh!

Tener commented Jun 13, 2022

Uh oh!

Tener commented Jul 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Tener commented May 26, 2022 •

edited

Loading

Tener Jun 2, 2022 •

edited

Loading

Tener commented Jun 1, 2022 •

edited

Loading

Tener commented Jun 2, 2022 •

edited

Loading