@cryptotaxi247 / netdata-1 / commits / fbd3e485e

add generic sso authenciation page and SP-initiated SSO on Okta (#17494)

* add generic sso authenciation page and SP-initiated SSO on Okta * Rename docs/cloud/manage/sso-authentication.md to docs/netdata-cloud/sso-authentication.md * Update metadata.yaml * add category overview page and rename sso file to its title * alter script to send auth integrations to desired folder * alter script to send auth integrations to desired folder * add content on the authentication & authorization main page --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>

Hugo Valente committed Apr 23, 2024 at 13:26 UTC fbd3e485ee7079ba756e688453bf375230783540
5 files changed +57 -2
docs/category-overview-pages/authentication-and-authorization.md new
+11
@@ -0,0 +1,11 @@
1 +# Authentication & Authorization
2 +
3 +This section contains documentation about the way Netdata allows users to Authenticate with Netdata Cloud and how
4 +they can manage the Authorization flows controlling what their teammates can access and do on Netdaata Cloud.
5 +
6 +For more details on these topics please check:
7 +* [Sign in to Netdata](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.md)
8 +* [Enterprise SSO Authentication](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md)
9 +* [Organize Your Infrastructure and Invite your Team](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md)
10 +* [Netdata's Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md)
11 +
docs/netdata-cloud/enterprise-sso-authentication.md new
+36
@@ -0,0 +1,36 @@
1 +# Enterprise SSO Authentication
2 +
3 +Netdata provides you with means to streamline and control how your team connects and authenticates to Netdata Cloud. We provide
4 + diferent Single Sign-On (SSO) integrations that allow you to connect with the tool that your organization is using to manage your
5 + user accounts.
6 +
7 + > ❗ This feature focus is on the Authentication flow, it doesn't support the Authorization with managing Users and Roles.
8 +
9 +
10 +## How to set it up?
11 +
12 +If you want to setup your Netdata Space to allow user Authentication through an Enterprise SSO tool you need to:
13 +* Confirm the integration to the tool you want is available ([Authentication integations](tbd))
14 +* Have a Netdata Cloud account
15 +* Have Access to the Space as an administrator
16 +* Your Space needs to be on the Business plan or higher
17 +
18 +Once you ensure the above prerequisites you need to:
19 +1. Click on the Space settings cog (located above your profile icon)
20 +2. Click on the Authentication tab
21 +3. Select the card for the integration you are looking for, click on Configure
22 +4. Fill the required attributes need to establish the integration with the tool
23 +
24 +
25 +## How to authenticate to Netdata?
26 +
27 +### From Netdata Sign-up page
28 +
29 +If you're starting your flow from Netdata sign-in page you need to:
30 +1. Click on the link `Sign-in with an Enterprise Signle Sign-On (SSO)`
31 +2. Enter your email address
32 +3. Go to your mailbox and check the `Sign In to Nedata` email that you have received
33 +4. Click on the **Sign In** button
34 +
35 +Note: If you're not authenticated on the Enterprise SSO tool you'll be prompted to authenticate there
36 +first before being allowed to proceed to Netdata Cloud.
integrations/cloud-authentication/integrations/okta_sso.md
+5 -1
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-authentication/metadata.yaml"
4 sidebar_label: "Okta SSO"
5 learn_status: "Published"
6 -learn_rel_path: "Authentication"
6 +learn_rel_path: "Netdata Cloud/Authentication & Authorization/Cloud Authentication & Authorization Integrations"
7 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE AUTHENTICATION'S metadata.yaml FILE"
8 endmeta-->
9
@@ -44,4 +44,8 @@ Steps needed to be done on Okta Admin Portal:
44 - **Client ID** you can get it from **General** tab on application you configured on Okta
45 - **Client Secret** you can get it from **General** tab on application you configured on Okta
46
47 +### SP-initiated SSO
48 +
49 +If you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md).
50 +
51
integrations/cloud-authentication/metadata.yaml
+4
@@ -39,3 +39,7 @@
39 - **Issuer URL** you can get it from your profile icon on top, e.g. `https://company-name.okta.com`
40 - **Client ID** you can get it from **General** tab on application you configured on Okta
41 - **Client Secret** you can get it from **General** tab on application you configured on Okta
42 +
43 + ### SP-initiated SSO
44 +
45 + If you start your authentication flow from Netdata sign-in page please check [these steps](https://github.com/netdata/netdata/blob/master/docs/netdata-cloud/enterprise-sso-authentication.md).
integrations/gen_docs_integrations.py
+1 -1
@@ -265,7 +265,7 @@ endmeta-->
265 meta_yaml: "{meta_yaml}"
266 sidebar_label: "{sidebar_label}"
267 learn_status: "Published"
268 -learn_rel_path: "{learn_rel_path.replace("authentication", "Authentication")}"
268 +learn_rel_path: "{learn_rel_path.replace("authentication", "Netdata Cloud/Authentication & Authorization/Cloud Authentication & Authorization Integrations")}"
269 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE AUTHENTICATION'S metadata.yaml FILE"
270 endmeta-->
271