From ff505a7983655e30be22faaa7ee3d66ee88b6b75 Mon Sep 17 00:00:00 2001 From: Rares Matei Date: Tue, 23 Jul 2024 10:43:17 +0100 Subject: [PATCH] docs(nx-cloud): remove managed saml docs (#26969) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Current Behavior ## Expected Behavior ## Related Issue(s) Fixes # --------- Co-authored-by: Miroslav Jonaš --- docs/generated/manifests/ci.json | 44 ------------ docs/generated/manifests/menus.json | 32 --------- docs/map.json | 5 -- .../on-premise/auth-saml-managed.md | 67 ------------------- .../enterprise/on-premise/auth-saml.md | 2 +- docs/shared/reference/sitemap.md | 1 - nx-dev/nx-dev/redirect-rules.js | 6 +- 7 files changed, 5 insertions(+), 152 deletions(-) delete mode 100644 docs/nx-cloud/enterprise/on-premise/auth-saml-managed.md diff --git a/docs/generated/manifests/ci.json b/docs/generated/manifests/ci.json index d8fd882788a42..4dd4fd14bf52a 100644 --- a/docs/generated/manifests/ci.json +++ b/docs/generated/manifests/ci.json @@ -721,17 +721,6 @@ "path": "/ci/recipes/enterprise/on-premise/auth-saml", "tags": [] }, - { - "id": "auth-saml-managed", - "name": "Authenticate via SAML on Managed Version", - "description": "", - "mediaImage": "", - "file": "nx-cloud/enterprise/on-premise/auth-saml-managed", - "itemList": [], - "isExternal": false, - "path": "/ci/recipes/enterprise/on-premise/auth-saml-managed", - "tags": [] - }, { "id": "advanced-config", "name": "Advanced Configuration", @@ -1305,17 +1294,6 @@ "path": "/ci/recipes/enterprise/on-premise/auth-saml", "tags": [] }, - { - "id": "auth-saml-managed", - "name": "Authenticate via SAML on Managed Version", - "description": "", - "mediaImage": "", - "file": "nx-cloud/enterprise/on-premise/auth-saml-managed", - "itemList": [], - "isExternal": false, - "path": "/ci/recipes/enterprise/on-premise/auth-saml-managed", - "tags": [] - }, { "id": "advanced-config", "name": "Advanced Configuration", @@ -1521,17 +1499,6 @@ "path": "/ci/recipes/enterprise/on-premise/auth-saml", "tags": [] }, - { - "id": "auth-saml-managed", - "name": "Authenticate via SAML on Managed Version", - "description": "", - "mediaImage": "", - "file": "nx-cloud/enterprise/on-premise/auth-saml-managed", - "itemList": [], - "isExternal": false, - "path": "/ci/recipes/enterprise/on-premise/auth-saml-managed", - "tags": [] - }, { "id": "advanced-config", "name": "Advanced Configuration", @@ -1647,17 +1614,6 @@ "path": "/ci/recipes/enterprise/on-premise/auth-saml", "tags": [] }, - "/ci/recipes/enterprise/on-premise/auth-saml-managed": { - "id": "auth-saml-managed", - "name": "Authenticate via SAML on Managed Version", - "description": "", - "mediaImage": "", - "file": "nx-cloud/enterprise/on-premise/auth-saml-managed", - "itemList": [], - "isExternal": false, - "path": "/ci/recipes/enterprise/on-premise/auth-saml-managed", - "tags": [] - }, "/ci/recipes/enterprise/on-premise/advanced-config": { "id": "advanced-config", "name": "Advanced Configuration", diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index 78f471f7e3c4f..b3c1ffac95c02 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -5677,14 +5677,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Authenticate via SAML on Managed Version", - "path": "/ci/recipes/enterprise/on-premise/auth-saml-managed", - "id": "auth-saml-managed", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Advanced Configuration", "path": "/ci/recipes/enterprise/on-premise/advanced-config", @@ -6103,14 +6095,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Authenticate via SAML on Managed Version", - "path": "/ci/recipes/enterprise/on-premise/auth-saml-managed", - "id": "auth-saml-managed", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Advanced Configuration", "path": "/ci/recipes/enterprise/on-premise/advanced-config", @@ -6260,14 +6244,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Authenticate via SAML on Managed Version", - "path": "/ci/recipes/enterprise/on-premise/auth-saml-managed", - "id": "auth-saml-managed", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Advanced Configuration", "path": "/ci/recipes/enterprise/on-premise/advanced-config", @@ -6351,14 +6327,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Authenticate via SAML on Managed Version", - "path": "/ci/recipes/enterprise/on-premise/auth-saml-managed", - "id": "auth-saml-managed", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "Advanced Configuration", "path": "/ci/recipes/enterprise/on-premise/advanced-config", diff --git a/docs/map.json b/docs/map.json index 8fbf4ee0fb22e..426027a96bf4c 100644 --- a/docs/map.json +++ b/docs/map.json @@ -1818,11 +1818,6 @@ "id": "auth-saml", "file": "nx-cloud/enterprise/on-premise/auth-saml" }, - { - "name": "Authenticate via SAML on Managed Version", - "id": "auth-saml-managed", - "file": "nx-cloud/enterprise/on-premise/auth-saml-managed" - }, { "name": "Advanced Configuration", "id": "advanced-config", diff --git a/docs/nx-cloud/enterprise/on-premise/auth-saml-managed.md b/docs/nx-cloud/enterprise/on-premise/auth-saml-managed.md deleted file mode 100644 index e6bb33b3b664c..0000000000000 --- a/docs/nx-cloud/enterprise/on-premise/auth-saml-managed.md +++ /dev/null @@ -1,67 +0,0 @@ -# SAML Auth Managed Offering - -## Okta Set-up - -You'll need the `SAML-IDENTIFIER` from us, unique to your org. We'll provide this once we start setting SAML up for you. -You'll be entering it in the instructions below. - -1. Create a new Okta App Integration: - - ![Okta 1](/nx-cloud/enterprise/on-premise/images/saml/okta_1.png) - - ![Okta 2](/nx-cloud/enterprise/on-premise/images/saml/okta_2.png) - -2. Give it a name: - - ![Okta 3](/nx-cloud/enterprise/on-premise/images/saml/okta_3.png) - -3. On the Next page, configure it as below: - - 1. The Single Sign On URL needs to be: - - If using the main-US cluster: `https://auth.nx.app/login/callback?connection=SAML-IDENTIFIER` - 2. The Audience should be `urn:auth0:nrwl:SAML-IDENTIFIER` - - If using the main-US cluster: `urn:auth0:nrwl:SAML-IDENTIFIER` - -{% callout type="note" title="EU Cluster" %} -Contact your developer productivity engineer (DPE) to configure SAML auth in the EU cluster. The EU cluster is only available for enterprise customers. -{% /callout %} - -![Okta 4](/nx-cloud/enterprise/on-premise/images/saml/okta_4_public.png) - -4. Scroll down to attribute statements and configure them as per below: - - ![Okta 5](/nx-cloud/enterprise/on-premise/images/saml/okta_5.png) - -5. Click “Next”, and select the first option on the next screen. -6. Go to the assignments tab and assign the users that can login to the Nx Cloud WebApp: - - 1. **Note:** This just gives them permission to use the Nx Cloud web app with their own workspace. Users will still need to be invited manually through the web app to your main workspace. - - ![Okta 6](/nx-cloud/enterprise/on-premise/images/saml/okta_6.png) - -7. Then in the Sign-On tab scroll down: - - ![Okta 7](/nx-cloud/enterprise/on-premise/images/saml/okta_7.png) - -8. Scroll down and from the list of certificates, download the one with the “Active” status: - - ![Okta 8](/nx-cloud/enterprise/on-premise/images/saml/okta_8.png) - -9. Then view the ldP metadata: - - ![Okta 9](/nx-cloud/enterprise/on-premise/images/saml/okta_9.png) - -10. Then find the row similar to the below, and copy the highlighted URL (see screenshot as well): - - 1. ```html - - ``` - - ![Okta 10](/nx-cloud/enterprise/on-premise/images/saml/okta_10.png) - -11. Send us via email: - - your _public_ certificate downloaded in step 8 - - your URL from step 10 diff --git a/docs/nx-cloud/enterprise/on-premise/auth-saml.md b/docs/nx-cloud/enterprise/on-premise/auth-saml.md index 9b9c8c4954f44..4e1497a870113 100644 --- a/docs/nx-cloud/enterprise/on-premise/auth-saml.md +++ b/docs/nx-cloud/enterprise/on-premise/auth-saml.md @@ -6,7 +6,7 @@ if you are interested. ### Jump To - [Azure AD Config](#azure-active-directory-set-up) -- [Okta Config](#okta-set-up) +- [Okta Config](#okta-setup) ## Azure Active Directory Set-up diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index c9a1940ca28f3..08e99c2712c9b 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -290,7 +290,6 @@ - [Authenticate with BitBucket](/ci/recipes/enterprise/on-premise/auth-bitbucket) - [Authenticate with BitBucket Data Center](/ci/recipes/enterprise/on-premise/auth-bitbucket-data-center) - [Authenticate via SAML](/ci/recipes/enterprise/on-premise/auth-saml) - - [Authenticate via SAML on Managed Version](/ci/recipes/enterprise/on-premise/auth-saml-managed) - [Advanced Configuration](/ci/recipes/enterprise/on-premise/advanced-config) - [Custom GitHub App](/ci/recipes/enterprise/on-premise/custom-github-app) - [Custom Distributed Task Execution](/ci/recipes/enterprise/dte) diff --git a/nx-dev/nx-dev/redirect-rules.js b/nx-dev/nx-dev/redirect-rules.js index c793cf9402560..497afa571b2ee 100644 --- a/nx-dev/nx-dev/redirect-rules.js +++ b/nx-dev/nx-dev/redirect-rules.js @@ -444,7 +444,7 @@ const nxCloudUrls = { '/nx-cloud/private-cloud/auth-saml': '/ci/recipes/enterprise/on-premise/auth-saml', '/nx-cloud/private-cloud/auth-saml-managed': - '/nx-cloud/recipes/enterprise/on-premise/auth-saml-managed', + '/ci/recipes/enterprise/on-premise/auth-saml', '/nx-cloud/private-cloud/advanced-config': '/nx-cloud/recipes/enterprise/on-premise/advanced-config', '/ci/recipes/on-premise': '/ci/recipes/enterprise/on-premise', @@ -461,7 +461,9 @@ const nxCloudUrls = { '/ci/recipes/on-premise/auth-saml': '/ci/recipes/enterprise/on-premise/auth-saml', '/ci/recipes/on-premise/auth-saml-managed': - '/ci/recipes/enterprise/on-premise/auth-saml-managed', + '/ci/recipes/enterprise/on-premise/auth-saml', + '/ci/recipes/enterprise/on-premise/auth-saml-managed': + '/ci/recipes/enterprise/on-premise/auth-saml', '/ci/recipes/on-premise/advanced-config': '/ci/recipes/enterprise/on-premise/advanced-config', '/concepts/dte': '/ci/concepts/parallelization-distribution',