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 automatic team provisioning instructions #27413

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

urseberry
Copy link
Contributor

What does this PR do? What is the motivation?

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

@github-actions github-actions bot added the Images Images are added/removed with this PR label Feb 3, 2025
Copy link
Contributor

@heavi5ide heavi5ide left a comment

Choose a reason for hiding this comment

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

Thanks Ursula! Let me know when you want me to take another look :)

content/en/account_management/scim/_index.md Outdated Show resolved Hide resolved
content/en/account_management/scim/okta.md Outdated Show resolved Hide resolved
content/en/account_management/scim/okta.md Outdated Show resolved Hide resolved
content/en/account_management/scim/okta.md Outdated Show resolved Hide resolved
content/en/account_management/scim/okta.md Outdated Show resolved Hide resolved
content/en/account_management/teams/manage.md Outdated Show resolved Hide resolved
content/en/account_management/teams/manage.md Outdated Show resolved Hide resolved
1. In the **Match result & push action** column, ensure **Create group** is selected
1. Click **Save**.

To verify that the operation completed successfully, navigate to the [Teams list][7]. Search for a Datadog team matching the Okta group you configured. Verify that the team exists in Datadog and is managed externally.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To verify that the operation completed successfully, navigate to the [Teams list][7]. Search for a Datadog team matching the Okta group you configured. Verify that the team exists in Datadog and is managed externally.
To verify that the operation completed successfully, navigate to the [Teams list][7]. Search for a Datadog team matching the Okta group you configured. Verify that the team exists in Datadog and is managed externally. Note that it may take a minute or two for the team to show up in Datadog.

@urseberry urseberry added the under_review Sent to someone outside of the docs team for review. label Feb 7, 2025
@urseberry urseberry marked this pull request as ready for review February 7, 2025 20:52
@urseberry urseberry requested a review from a team as a code owner February 7, 2025 20:52
1. Click the **Push Groups** button. The pushed groups interface opens.
1. Select the Okta group you want to unlink from its Datadog Team.
1. In the **Match result & push action** column, select **Unlink Pushed Group**. A dialog box appears.
1. Select **Delete the group in the target app (recommended)**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Okta asked us to call out in our documentation that this option will not actually delete the team within Datadog. This is a potential point of confusion because the user is told to select "Delete the group in the target app" but within Datadog what we actually do is just remove the managed relationship and remove all members of the Team. This is because the Team in Datadog may be associated with other data and assets within Datadog, so we are conservative and do not actually delete it, to avoid doing something destructive to the data/configuration of the org's Datadog setup (for instance, breaking notifications that were using the Team as a routing destination that is forwarding notifications to a Slack channel).

I'm not sure of the best way to call this out here; in a way, the docs here are already clear on that, because you say above that

This procedure enables you to manage team membership in Datadog instead of Okta and removes the team members from the Datadog Team.

I think maybe just an extra clarification on this line could be helpful. Something like:

Suggested change
1. Select **Delete the group in the target app (recommended)**.
1. Select **Delete the group in the target app (recommended)**. (Note that despite the naming of this option in Okta, this will _not_ delete the team in Datadog)

Maybe there's a better/more clear option that you can think of 🤷

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a better suggestion: follow the same format as the "no match found" note from line 92, and put a separate note after the list of numbered steps like:

Note: Okta labels this option "Delete the group in the target app" but this will not actually delete the team in Datadog. All members will be removed from the team and it will no longer show as managed.

Copy link
Contributor

@heavi5ide heavi5ide left a comment

Choose a reason for hiding this comment

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

Thanks Ursula!

1. In the **Match result & push action** column, ensure **Create group** is selected.
1. Click **Save**.

**Note:** Okta may display a **No match found** message, because it only returns managed groups. You can ignore this message and proceed with creating the group to establish synchronization.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Note:** Okta may display a **No match found** message, because it only returns managed groups. You can ignore this message and proceed with creating the group to establish synchronization.
**Note:** Okta will display a **No match found** message. You can ignore this message and proceed with creating the group to establish synchronization.

1. Click the **Push Groups** button. The pushed groups interface opens.
1. Select the Okta group you want to unlink from its Datadog Team.
1. In the **Match result & push action** column, select **Unlink Pushed Group**. A dialog box appears.
1. Select **Delete the group in the target app (recommended)**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a better suggestion: follow the same format as the "no match found" note from line 92, and put a separate note after the list of numbered steps like:

Note: Okta labels this option "Delete the group in the target app" but this will not actually delete the team in Datadog. All members will be removed from the team and it will no longer show as managed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Images Images are added/removed with this PR under_review Sent to someone outside of the docs team for review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants