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

feat: Dev Portal SAML SSO #8118

Merged
merged 14 commits into from
Dec 12, 2024
Merged

feat: Dev Portal SAML SSO #8118

merged 14 commits into from
Dec 12, 2024

Conversation

cloudjumpercat
Copy link
Contributor

@cloudjumpercat cloudjumpercat commented Nov 4, 2024

Description

SAML SSO is being added to Dev Portal. This PR adds instructions for it and creates SSO includes so that org SSO and Dev Portal SSO content can be shared.

This PR also fixes some outdated Okta SSO language, see DOCU-4120 for more information.

DOCU-4135

Testing instructions

Preview links:

Checklist

@cloudjumpercat cloudjumpercat added the review:sme Request for SME review, external to the docs team. label Nov 4, 2024
Copy link

netlify bot commented Nov 4, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 1b9ba19
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/67478aeea66b610008688b16
😎 Deploy Preview https://deploy-preview-8118--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 93 (🟢 up 3 from production)
Accessibility: 92 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 99 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@cloudjumpercat
Copy link
Contributor Author

I'm still working on testing team mappings and Dev Portal SAML, but the draft docs are now ready for tech review!

  • Dev Portal Generic SSO how to and Konnect Generic SSO how to
    • In the PR, the content for these pages now lives primarily in an include since the content for both generic SSO pages is so similar. As you look over these docs, I'd appreciate any feedback if I missed anything or need to fix any instructions that relates to one (ex. Konnect org) but not the other (ex. Dev Portal) that I missed on accident.
  • Konnect Okta SSO how to and Dev Portal Okta SSO how to
    • Same comment here about how we're now using an include for the content because the two sets of instructions are very similar. This just makes it easier to keep the content consistent since the updates to one will show up in the other.
  • SSO attribute mapping reference
    • This content already existed, I just moved it to it's own page. I still have an open question about what the Konnect values are and where in Konnect those values map to

* **Single Sign-On URL**: `https://global.api.konghq.com/v2/authenticate/login_path/saml/acs`
* **Audience URI (SP Entity ID)**: `https://cloud.konghq.com/sp/SP_ID`

1. Optional: In the **Attribute Statements**, add the following three attributes:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This doesn't mention why a user would want to configure this and I'm not sure what the answer to that is.


1. [Add users to the Okta application](https://help.okta.com/en-us/content/topics/users-groups-profiles/usgp-assign-apps.htm).

1. [Generate a signing certificate](https://help.okta.com/en-us/content/topics/apps/manage-signing-certificates.htm) to use in {{site.konnect_short_name}}.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's no place to put the cert in konnect, so I just need to generate it and activate it?

app/_includes/md/konnect/generic-sso.md Show resolved Hide resolved
app/_includes/md/konnect/generic-sso.md Show resolved Hide resolved
app/_includes/md/konnect/generic-sso.md Show resolved Hide resolved
app/_includes/md/konnect/generic-sso.md Show resolved Hide resolved
* [Configure generic SSO for a Konnect Org](/konnect/org-management/sso/)
* [IdP SSO attribute mapping reference](/konnect/reference/sso)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add this section for Dev Portal "Configure Okta" page as well: https://docs.konghq.com/konnect/org-management/okta-idp/#add-a-user-to-your-application?

Copy link
Contributor Author

@cloudjumpercat cloudjumpercat Nov 8, 2024

Choose a reason for hiding this comment

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

Adding users to the application is one of the steps in this section (it's step 3 for OIDC and step 4 for SAML). That step is a link to the Okta doc because if we write out the steps ourselves like we did in the current Org Okta SSO doc, they quickly become out-dated. And I tested the flow with the Okta doc and thought it was accurate and helpful.

So, it is annoying as a user to have to go to yet another link for more instructions, but the instructions are more likely to be accurate this way if we use Okta's.

Signed-off-by: Diana <[email protected]>
* **Sign-in redirect URIs**: `https://cloud.konghq.com/login` (This is a placeholder value that you'll replace later)
* **Sign-out redirect URIs**: `https://cloud.konghq.com/login` (This is a placeholder value that you'll replace later)
{% endif %}
{% if include.desc == "Dev Portal" %}
Copy link
Contributor Author

@cloudjumpercat cloudjumpercat Nov 19, 2024

Choose a reason for hiding this comment

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

For reviewers: This if include.desc bit isn't working in the output. It's showing the Konnect Org placeholders on both the Dev Portal pages and Konnect Org pages. Any idea what I'm doing wrong? I didn't get any errors in the Terminal when I ran this locally.

Copy link
Contributor

@lmilan lmilan left a comment

Choose a reason for hiding this comment

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

I just left one question, otherwise it looks good to me!

app/_data/docs_nav_konnect.yml Outdated Show resolved Hide resolved
@Guaris Guaris marked this pull request as ready for review December 10, 2024 19:11
@Guaris Guaris requested a review from a team as a code owner December 10, 2024 19:11
@smritikjaggi smritikjaggi merged commit 0e27d33 into main Dec 12, 2024
23 checks passed
@smritikjaggi smritikjaggi deleted the feat/dev-portal-saml branch December 12, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:sme Request for SME review, external to the docs team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants