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

[automate-2530] document supported LDAP/SAML configurations #2636

Merged
merged 3 commits into from
Jan 16, 2020

Conversation

bcmdarroch
Copy link
Contributor

🔩 Description: What code changed, and why?

We want to document a list of our most commonly used IdP configurations for reference.

I've also added some internal documentation on some known issues.

👟 How to Build and Test the Change

cd components/automate-chef-io
make serve

✅ Checklist

Brenna Hewer-Darroch added 2 commits January 14, 2020 16:48
Signed-off-by: Brenna Hewer-Darroch <[email protected]>
@susanev susanev added the documentation Anything related to the Automate docs. label Jan 15, 2020
dev-docs/auth.md Outdated

If you want to use google as an IdP (Identity Provider) or our internal test LDAP server, there are a few variables you can set.
OKTA with SAML and AD with LDAP have anecdotally been reported to be the most common configurations among our users.
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
OKTA with SAML and AD with LDAP have anecdotally been reported to be the most common configurations among our users.
OKTA with SAML and AD with LDAP are the most common configurations among our users.


- Microsoft Active Directory (MSAD)

### Configurations with Known Issues
Copy link
Contributor

Choose a reason for hiding this comment

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

lets move this section to somewhere in the repo instead of in the docs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

these are dev docs so they're not part of the docs we deploy to customers. but i could move it to the authn README if that seems a little more out of the way

Copy link
Contributor

Choose a reason for hiding this comment

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

oh lol sorry, ignore me.

@susanev susanev added the auth-team anything that needs to be on the auth team board label Jan 15, 2020
dev-docs/auth.md Outdated

- Azure AD with SAML: we cannot support SAML with Azure AD because Automate cannot consume SAML IdP metadata, which Azure relies on to rotate keys.
- Appleconnect with SAML: invalid signature error.
- in general, dex does not support idP initiated SSO
Copy link
Contributor

@susanev susanev Jan 15, 2020

Choose a reason for hiding this comment

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

lets link to the pr in progress for this
dexidp/dex#1514

@@ -42,6 +42,14 @@ Local, MSAD, and LDAP users will have their Chef Automate sessions refreshed whi
browsing session of the Chef Automate UI or until they sign out directly.
{{< /info >}}

## Supported Identity Management Systems

- OKTA

Choose a reason for hiding this comment

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

I'm guessing these are in order of prevalence but I expected them to be alphabetized 🤷‍♀

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ya alphabetized would look better

Copy link
Contributor

@lancewf lancewf left a comment

Choose a reason for hiding this comment

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

Thank you for documenting this. Looks good to me.

@bcmdarroch bcmdarroch marked this pull request as ready for review January 15, 2020 17:37
@bcmdarroch bcmdarroch requested a review from a team as a code owner January 15, 2020 17:37
Signed-off-by: Brenna Hewer-Darroch <[email protected]>

If you want to use google as an IdP (Identity Provider) or our internal test LDAP server, there are a few variables you can set.
OKTA with SAML and AD with LDAP are the most common configurations among our users.
Copy link
Contributor

Choose a reason for hiding this comment

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

AD with LDAP are the most common configurations among our users. This is a bit misleading since most people using AD are using the AD specific configuration instead of LDAP. I understand what this is saying but the world configurations might be a bit overloaded here.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh just also realized this was a dev doc. That's an ignorable nit in that case.

@bcmdarroch bcmdarroch merged commit 7be5470 into master Jan 16, 2020
@chef-expeditor chef-expeditor bot deleted the bhd/2530/ldap-saml-support branch January 16, 2020 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auth-team anything that needs to be on the auth team board documentation Anything related to the Automate docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants