[entraid] Add docs to setup integration for air gapped clusters #48571
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tigrato
added
no-changelog
tigrato
force-pushed
the
tigrato/add-manual-entra-id-docs
branch
from
697248e to
ba5406e
Compare
|
🤖 Vercel preview here: https://docs-ffwc49nr5-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-l4epnz5jo-goteleport.vercel.app/docs/ver/preview |
tigrato
force-pushed
the
tigrato/add-manual-entra-id-docs
branch
from
ba5406e to
f975508
Compare
tigrato
force-pushed
the
tigrato/add-manual-entra-id-docs
branch
from
f975508 to
80ab0ae
Compare
This PR adds docs for Teleport Entra Id integration for air gapped clusters where internet access to their proxies isn't available. This guide also adds a manual step for users that do not want Teleport to automatically setup Azure Entra ID Applications. Signed-off-by: Tiago Silva <[email protected]>
tigrato
force-pushed
the
tigrato/add-manual-entra-id-docs
branch
from
80ab0ae to
840f849
Compare
github-actions
bot
requested review from
mmcallister,
ptgott,
r0mant,
xinding33 and
zmb3
|
🤖 Vercel preview here: https://docs-ecnm3yfgp-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-l7uoby3l8-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-dseb0rjoa-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-7fja1d0l2-goteleport.vercel.app/docs/ver/preview |
ptgott
reviewed
Nov 7, 2024
There was a problem hiding this comment.
I still need to provide more detailed, line-level comments, but I am starting with a broad note: I think placing three sequences of "Step..." headings inside a Tabs component makes the guide a little intimidating to read.
I would use the "Step n/d" format only for H2 sections, as we usually do in our how-to guides. Then we can make "Configure the Entra ID integration" an H2 with a numbered step (e.g., "Step 3/6 Configure the Entra ID Integration"), and include a separate H3 under "Configure the Entra ID integration" for each operational mode. In each H3, we can organize paragraphs into an ordered list of steps rather than use separate headings within a giant Tabs component, i.e.:
1. Access the Teleport Web UI and...
1. Choose a Teleport user...
1. Fill in another field...I would also turn the "Entra ID integration operational modes" section into a numbered section, i.e., "Step 2/n Choose an operational mode for the integration".
|
@ptgott can you please take a look? |
|
🤖 Vercel preview here: https://docs-ipaaii457-goteleport.vercel.app/docs/ver/preview |
ptgott
approved these changes
Nov 13, 2024
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx
Outdated
Show resolved
Hide resolved
public-teleport-github-review-bot
bot
removed request for
mmcallister,
zmb3 and
xinding33
|
🤖 Vercel preview here: https://docs-5988uhv32-goteleport.vercel.app/docs/ver/preview |
tigrato
force-pushed
the
tigrato/add-manual-entra-id-docs
branch
from
a6075ef to
d0245c5
Compare
|
🤖 Vercel preview here: https://docs-dn1q25bfd-goteleport.vercel.app/docs/ver/preview |
tigrato
force-pushed
the
tigrato/add-manual-entra-id-docs
branch
from
d0245c5 to
8743418
Compare
|
🤖 Vercel preview here: https://docs-4d845b40h-goteleport.vercel.app/docs/ver/preview |
tigrato
added a commit
that referenced
this pull request
Nov 14, 2024
* [entraid] Add docs to setup integration for air gapped clusters This PR adds docs for Teleport Entra Id integration for air gapped clusters where internet access to their proxies isn't available. This guide also adds a manual step for users that do not want Teleport to automatically setup Azure Entra ID Applications. Signed-off-by: Tiago Silva <[email protected]> * fix spell issues * Update docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx Co-authored-by: Roman Tkachenko <[email protected]> * Apply suggestions from code review Co-authored-by: Roman Tkachenko <[email protected]> * handle code review comments Signed-off-by: Tiago Silva <[email protected]> * handle code review comments --------- Signed-off-by: Tiago Silva <[email protected]> Co-authored-by: Roman Tkachenko <[email protected]>
tigrato
added a commit
that referenced
this pull request
Nov 14, 2024
* [entraid] Add docs to setup integration for air gapped clusters This PR adds docs for Teleport Entra Id integration for air gapped clusters where internet access to their proxies isn't available. This guide also adds a manual step for users that do not want Teleport to automatically setup Azure Entra ID Applications. Signed-off-by: Tiago Silva <[email protected]> * fix spell issues * Update docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx Co-authored-by: Roman Tkachenko <[email protected]> * Apply suggestions from code review Co-authored-by: Roman Tkachenko <[email protected]> * handle code review comments Signed-off-by: Tiago Silva <[email protected]> * handle code review comments --------- Signed-off-by: Tiago Silva <[email protected]> Co-authored-by: Roman Tkachenko <[email protected]>
This was referenced Nov 14, 2024
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 15, 2024
…) (#48983) * [entraid] Add docs to setup integration for air gapped clusters This PR adds docs for Teleport Entra Id integration for air gapped clusters where internet access to their proxies isn't available. This guide also adds a manual step for users that do not want Teleport to automatically setup Azure Entra ID Applications. * fix spell issues * Update docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx * Apply suggestions from code review * handle code review comments * handle code review comments --------- Signed-off-by: Tiago Silva <[email protected]> Co-authored-by: Roman Tkachenko <[email protected]>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 15, 2024
…) (#48982) * [entraid] Add docs to setup integration for air gapped clusters This PR adds docs for Teleport Entra Id integration for air gapped clusters where internet access to their proxies isn't available. This guide also adds a manual step for users that do not want Teleport to automatically setup Azure Entra ID Applications. * fix spell issues * Update docs/pages/admin-guides/teleport-policy/integrations/entra-id.mdx * Apply suggestions from code review * handle code review comments * handle code review comments --------- Signed-off-by: Tiago Silva <[email protected]> Co-authored-by: Roman Tkachenko <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds docs for Teleport Entra Id integration for air gapped clusters where internet access to their proxies isn't available. This guide also adds a manual step for users that do not want Teleport to automatically setup Azure Entra ID Applications.