Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Identity Center integration docs #48951

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Add Identity Center integration docs #48951

merged 1 commit into from
Nov 15, 2024

Conversation

r0mant
Copy link
Collaborator

@r0mant r0mant commented Nov 14, 2024

Copy link

🤖 Vercel preview here: https://docs-5ta1llxbv-goteleport.vercel.app/docs/ver/preview

@r0mant r0mant added the no-changelog Indicates that a PR does not require a changelog entry label Nov 14, 2024
Copy link

🤖 Vercel preview here: https://docs-pr55qcnal-goteleport.vercel.app/docs/ver/preview

Copy link

🤖 Vercel preview here: https://docs-9mk3w154e-goteleport.vercel.app/docs/ver/preview

Copy link

🤖 Vercel preview here: https://docs-pwaf3zxfh-goteleport.vercel.app/docs/ver/preview

Copy link

🤖 Vercel preview here: https://docs-1whwii91x-goteleport.vercel.app/docs/ver/preview

Copy link

🤖 Vercel preview here: https://docs-3dv9w5brz-goteleport.vercel.app/docs/ver/preview

@@ -0,0 +1,285 @@
---
Copy link
Contributor

@smallinsky smallinsky Nov 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to pin the mdx file in our config.json ?https://github.com/gravitational/teleport/blob/master/docs/config.json#L2284

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's the redirect configuration. Since this is a new page, there doesn't need to be a redirect. The sidebar is automatically generated for the admin-guides section.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, navigation is generated automatically now.

allows you to organize and manage your users' short- and long-term access to AWS
accounts and their permissions.

With the Identity Center integration you can grant or revoke persistent access
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: following the plugin enrollment UI changes where I updated all the occurrence of "Identity Center" as "AWS IAM Identity Center", that might apply to this docs too.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did use the full name in a few places but using it everywhere throughout the guide I thought would be too verbose so opted for a shorter version mostly. I'm sure readers will understand what Identity Center refers to.

removed from such Access Lists will be added to or removed from corresponding
Identity Center groups.

For short-term access, users can go through Teleport's standard Access Request
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not entirely sure to mention role/resource access request before v17.1. We might support before that but mentioning it right now risks confusion about what is supported and what is not. wdyt?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Role requests should work? Permission set requests I have a note about that says they will be coming later.

sets, for example:

```yaml
kind: role
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've seen sub_kind: aws_identity_center added to the generated role. Is that needed or not? Can you confirm @tcsc @smallinsky

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's required in the user-defined roles.

@ptgott ptgott mentioned this pull request Nov 15, 2024
19 tasks
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: This might be a matter of taste, but I would remove the browser frames from the images so they seem more impersonal. For me, impersonal is more appropriate for docs, while personal is more appropriate for a blog.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the way macOS takes screenshots of full pages but I agree that I should've hid bookmarks bar and maybe pick a more generic cluster name.

I'd rather not re-do 8 screenshots right now - there are some UI tweaks that this integration will be getting over next weeks, we'll update then.

Comment on lines 132 to 143
To avoid access interruptions, we recommend making sure that all existing
Identity Center users have access to your Teleport cluster by e.g. using
the same [IdP](../../access-controls/sso/sso.mdx) as your current Identity Center
external identity source.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in the Prerequisites?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was a similar note under the "How it works" section but I moved it to "Prerequisites". I think it's useful to call attention to it here as well.

Copy link

🤖 Vercel preview here: https://docs-25nxspkab-goteleport.vercel.app/docs/ver/preview

Copy link

🤖 Vercel preview here: https://docs-daku9xw6m-goteleport.vercel.app/docs/ver/preview

@r0mant r0mant added this pull request to the merge queue Nov 15, 2024
Copy link

🤖 Vercel preview here: https://docs-qzqobmxpe-goteleport.vercel.app/docs/ver/preview

Merged via the queue into master with commit 87bf87d Nov 15, 2024
39 of 40 checks passed
@r0mant r0mant deleted the roman/icdocs branch November 15, 2024 19:55
@public-teleport-github-review-bot

@r0mant See the table below for backport results.

Branch Result
branch/v17 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/branch/v17 documentation no-changelog Indicates that a PR does not require a changelog entry size/md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants