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

OneLogin How-to #1838

Merged
merged 15 commits into from
Dec 22, 2023
Merged

OneLogin How-to #1838

merged 15 commits into from
Dec 22, 2023

Conversation

karl-cardenas-coding
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding commented Nov 22, 2023

Describe the Change

This PR carries over the work created by @Sheldonwl in #1392

Review Changes

💻 Preview URL

🎫 DOC-487

@karl-cardenas-coding karl-cardenas-coding added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-1 Backport change to version 4.1 labels Nov 22, 2023
@karl-cardenas-coding karl-cardenas-coding requested a review from a team as a code owner November 22, 2023 20:58
Copy link

netlify bot commented Nov 22, 2023

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 3ee4d0f
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/6585af7bfd52fe0008c3ead6
😎 Deploy Preview https://deploy-preview-1838--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@karl-cardenas-coding
Copy link
Contributor Author

@Sheldonwl I created a new branch that carried over your changes into the new docs framework. Otherwise, it's an ugly git entanglement to solve.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 45.7%, saving 3.61 MB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_app-role.png 56.22 KB 35.08 KB -37.6% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_callbackurl.png 885.80 KB 547.79 KB -38.2% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_clientid-clientsecret.png 207.04 KB 125.12 KB -39.6% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_group-field.png 844.41 KB 502.34 KB -40.5% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_group-sec-policy.png 403.46 KB 168.96 KB -58.1% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_login-redirect-uris.png 467.43 KB 201.58 KB -56.9% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_login-screen.png 574.33 KB 322.91 KB -43.8% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_logout-uri.png 72.64 KB 42.87 KB -41.0% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_logout.png 97.17 KB 66.90 KB -31.2% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_mapping-role-group.png 820.95 KB 370.82 KB -54.8% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_new-team.png 47.64 KB 29.32 KB -38.5% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_oidc-app-name.png 335.41 KB 148.58 KB -55.7% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_oidc-full-palette.png 709.89 KB 400.14 KB -43.6% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_roles-full.png 576.59 KB 425.26 KB -26.2% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_search-oidc.png 37.54 KB 24.14 KB -35.7% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_team-member.png 139.65 KB 78.56 KB -43.7% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_tenant-admin-role.png 186.99 KB 113.94 KB -39.1% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_uri-config.png 830.60 KB 425.82 KB -48.7% View diff
static/assets/docs/images/oidc-onelogin-images/user-management_saml-sso_palette_sso_with_onelogin_user-auth-group.png 796.05 KB 361.98 KB -54.5% View diff

507 images did not require optimisation.

Copy link
Contributor

@ritawatson ritawatson left a comment

Choose a reason for hiding this comment

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

A generally good PR - our team thanks you for helping provide documentation! Screenshots are helpful and good use of a tip.

Some overall suggestions:

  • Our internal style doesn't use menu cascade (-->) for menu or UI element flows.
  • Some steps include several substeps that should be broken out as separate steps.
  • Each section should start with a brief intro and a new set of steps (starting with 1.). "Create Role, Security Policy and Group", "Enable OIDC in Palette", and "Create Teams in Palette". Some of these sections may need a bit of information that can be borrowed from the first step (such as step 18). Other times, you might just say, "Use the following steps to ..."


18. In order for Palette to map the groups configured in OneLogin, you need to create a team in Palette. The team name needs to match the value that is returned for the groups configured in OneLogin. In this example, you will create an **Administrators** team in Palette. This team name also matches with the Administrators value that is assigned to each member of the Administrators group in OneLogin.

In Palette, navigate to left **Main Menu**, select **Tenant Settings** and click on **Users & Teams**. Next, select **Teams**, and click on **Create team**. You only need to fill in the team name. Don't manually add members, as OneLogin will manage the users. In OneLogin, users who are part of the mapped group, administrators, will be automatically added to the team. Click **Confirm** to continue.
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
In Palette, navigate to left **Main Menu**, select **Tenant Settings** and click on **Users & Teams**. Next, select **Teams**, and click on **Create team**. You only need to fill in the team name. Don't manually add members, as OneLogin will manage the users. In OneLogin, users who are part of the mapped group, administrators, will be automatically added to the team. Click **Confirm** to continue.
1. From the left **Main Menu** in Palette, click on **Users & Teams**.
2. Select the **Teams** tab, and click on the **Create team** button.
3. Provide *only* the team name and ignore the **Members** field, as OneLogin will manage the users. In OneLogin, users who are part of the mapped "Administrators" group will be automatically added to the team. Click **Confirm** to continue.

Copy link
Contributor

@ritawatson ritawatson left a comment

Choose a reason for hiding this comment

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

Some formatting and wording suggestions need to be addressed. Otherwise, a good PR. Thanks for taking time to help our doc team out Sheldon.

Copy link
Contributor

@ritawatson ritawatson left a comment

Choose a reason for hiding this comment

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

Some minor comments to address. Otherwise, LGTM.

@karl-cardenas-coding karl-cardenas-coding merged commit 20b4bf2 into master Dec 22, 2023
10 checks passed
@karl-cardenas-coding karl-cardenas-coding deleted the onelogin-v2 branch December 22, 2023 15:59
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Dec 22, 2023
* docs: touched up OneLogin how-to

* Optimised images with calibre/image-actions

* docs: vale feedeback

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* docs: feedback

* docs: updated per feedback

* docs: rebase

* chore: vale feedback

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* docs: feedback changes

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
(cherry picked from commit 20b4bf2)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0 Backport failed because of merge conflicts
version-3-4 Backport failed because of merge conflicts
version-4-1

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 1838

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

karl-cardenas-coding added a commit that referenced this pull request Dec 22, 2023
* docs: touched up OneLogin how-to

* Optimised images with calibre/image-actions

* docs: vale feedeback

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* docs: feedback

* docs: updated per feedback

* docs: rebase

* chore: vale feedback

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* docs: feedback changes

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
karl-cardenas-coding added a commit that referenced this pull request Dec 22, 2023
* docs: touched up OneLogin how-to

* Optimised images with calibre/image-actions

* docs: vale feedeback

* Apply suggestions from code review



* docs: feedback

* docs: updated per feedback

* docs: rebase

* chore: vale feedback

* Apply suggestions from code review



* docs: feedback changes

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
karl-cardenas-coding added a commit that referenced this pull request Dec 22, 2023
* docs: touched up OneLogin how-to

* Optimised images with calibre/image-actions

* docs: vale feedeback

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* docs: feedback

* docs: updated per feedback

* docs: rebase

* chore: vale feedback

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* docs: feedback changes

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
(cherry picked from commit 20b4bf2)

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants