Skip to content

Commit 9de5b02

Browse files
authored
Q2 sso content relocation (#754)
* Move SSO to administration bucket Moved SSO topics to administration bucket and update nav and home content yamls * Update x-refs in SSO topics Updated in-topic x-refs * Update paths_to_check.txt Fixed path to overview topic * Update paths_to_check.txt Reverted single sigin-on entries to original ones * Fix x-ref links Fixed broken links * Updates * Update saml.md
1 parent 2885dc9 commit 9de5b02

28 files changed

+181
-197
lines changed

_data/home-content.yml

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -261,20 +261,10 @@
261261
- title: Manage Git PATs
262262
localurl: /docs/administration/user-self-management/manage-pats/
263263
- title: Codefresh IP addresses
264-
localurl: /docs/administration/platform-ip-addresses/
265-
266-
- title: Single Sign-On
267-
icon: images/home-icons/administration.svg
268-
url: ''
269-
links:
270-
- title: Federated Single Sign-On (SSO) overview
271-
localurl: /docs/single-sign-on/single-sign-on/
272-
- title: Setting up OIDC Federated SSO
273-
localurl: /docs/single-sign-on/oidc/
274-
- title: Setting up SAML2 Federated SSO
275-
localurl: /docs/single-sign-on/saml/
276-
- title: LDAP Single Sign-On (SSO)
277-
localurl: /docs/single-sign-on/ldap/
264+
localurl: /docs/administration/platform-ip-addresses/
265+
- title: Single Sign-On
266+
localurl: /docs/administration/single-sign-on/
267+
278268

279269
- title: Reference
280270
icon: images/home-icons/guides.png

_data/nav.yml

Lines changed: 35 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -550,50 +550,46 @@
550550
url: "/pipeline-execution-context"
551551
- title: Auditing actions in Codefresh
552552
url: "/audit"
553+
- title: Single Sign-On
554+
sub-pages:
555+
- title: Common configuration
556+
url: "/team-sync"
557+
- title: OpenID Connect
558+
url: "/oidc"
559+
sub-pages:
560+
- title: Auth0
561+
url: "/oidc-auth0"
562+
- title: Azure
563+
url: "/oidc-azure"
564+
- title: Google
565+
url: "/oidc-google"
566+
- title: Keycloak
567+
url: "/oidc-keycloak"
568+
- title: Okta
569+
url: "/oidc-okta"
570+
- title: OneLogin
571+
url: "/oidc-onelogin"
572+
- title: SAML
573+
url: "/saml"
574+
sub-pages:
575+
- title: JumpCloud
576+
url: "/saml-jumpcloud"
577+
- title: Okta
578+
url: "/saml-okta"
579+
- title: OneLogin
580+
url: "/saml-onelogin"
581+
- title: PingID SSO
582+
url: "/saml-pingid"
583+
- title: LDAP
584+
url: "/ldap"
585+
- title: Codefresh IP addresses
586+
url: "/platform-ip-addresses"
553587
- title: User self-management
554588
sub-pages:
555589
- title: Managing personal settings
556590
url: "/user-settings"
557591
- title: Managing Git PATs
558-
url: "/manage-pats"
559-
- title: Codefresh IP addresses
560-
url: "/platform-ip-addresses"
561-
562-
- title: Single Sign-On
563-
url: /single-sign-on
564-
pages:
565-
- title: Single sign-on overview
566-
url: /single-sign-on
567-
- title: Common configuration
568-
url: /team-sync
569-
- title: OpenID Connect
570-
url: /oidc
571-
sub-pages:
572-
- title: Auth0
573-
url: /oidc-auth0
574-
- title: Azure
575-
url: /oidc-azure
576-
- title: Google
577-
url: /oidc-google
578-
- title: Keycloak
579-
url: /oidc-keycloak
580-
- title: Okta
581-
url: /oidc-okta
582-
- title: OneLogin
583-
url: /oidc-onelogin
584-
- title: SAML
585-
url: /saml
586-
sub-pages:
587-
- title: JumpCloud
588-
url: /saml-jumpcloud
589-
- title: Okta
590-
url: /saml-okta
591-
- title: OneLogin
592-
url: /saml-onelogin
593-
- title: PingID SSO
594-
url: /saml-pingid
595-
- title: LDAP
596-
url: /ldap
592+
url: "/manage-pats"
597593

598594
- title: Reference
599595
url: "/reference"

_docs/administration/account-user-management/access-control.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The table below lists the functionality available for the `Admin` and `User` rol
6060
|[Cloud storage settings]({{site.baseurl}}/docs/testing/test-reports/#connecting-your-storage-account) | `Admin`|
6161
|[Shared configuration]({{site.baseurl}}/docs/pipelines/configuration/shared-configuration/) | `Admin`|
6262
|[API token generation]({{site.baseurl}}/docs/integrations/codefresh-api/#authentication-instructions) | `Admin`|
63-
|[SSO Settings]({{site.baseurl}}/docs/single-sign-on/single-sign-on/) | `Admin`|
63+
|[SSO Settings]({{site.baseurl}}/docs/administration/single-sign-on/) | `Admin`|
6464
|[Runtime environment selection]({{site.baseurl}}/docs/pipelines/pipelines/#pipeline-settings) | `Admin`|
6565
|[Slack settings]({{site.baseurl}}/docs/integrations/notifications/slack-integration/) | `Admin`|
6666
|[Audit logs]({{site.baseurl}}/docs/administration/audit-logs/) | `Admin`|

_docs/administration/account-user-management/add-users.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Adding a user to an account requires assigning a role to define access to accoun
2525
on clusters, docker registries, git integrations, shared configurations etc.
2626
* **Administrator**: With this role, users have full access to accounts, and can change all settings, so make sure that they are trusted colleagues.
2727
For guidelines on access control, see [Access control]({{site.baseurl}}/docs/administration/account-user-management/access-control/).
28-
* **SSO**: By default, SSO is not enabled for users. If required, explicitly select the SSO provider. For an overview of SSO, see [Single Sign on]({{site.baseurl}}/docs/single-sign-on/single-sign-on/).
28+
* **SSO**: By default, SSO is not enabled for users. If required, explicitly select the SSO provider. For an overview of SSO, see [Single Sign on]({{site.baseurl}}/docs/administration/single-sign-on/).
2929

3030

3131
### Add a user to a Codefresh account
@@ -118,5 +118,5 @@ As an administrator, you can optionally define session timeouts to automatically
118118

119119
## Related articles
120120
[Access control]({{site.baseurl}}/docs/administration/account-user-management/access-control/)
121-
[Single Sign on]({{site.baseurl}}/docs/single-sign-on/single-sign-on/)
121+
[Single Sign on]({{site.baseurl}}/docs/administration/single-sign-on/)
122122
[Setting up OAuth authentication for Git providers]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup)

_docs/single-sign-on/single-sign-on.md renamed to _docs/administration/single-sign-on.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,5 @@ Using federated SSO significantly simplifies cross-domain user management as fol
4545

4646

4747
## Related articles
48-
[Setting Up SAML2 Federated Single Sign-On (SSO)]({{site.baseurl}}/docs/single-sign-on/saml)
49-
[Setting Up OpenID Connect Federated Single Sign-On]({{site.baseurl}}/docs/single-sign-on/oidc)
48+
[Setting Up SAML2 Federated Single Sign-On (SSO)]({{site.baseurl}}/docs/administration/single-sign-on/saml)
49+
[Setting Up OpenID Connect Federated Single Sign-On]({{site.baseurl}}/docs/administration/single-sign-on/oidc)

_docs/single-sign-on/ldap.md renamed to _docs/administration/single-sign-on/ldap.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: " "
44
group: single-sign-on
55
redirect_from:
66
- /docs/enterprise/single-sign-on/sso-ldap/
7+
- /docs/single-sign-on/ldap/
78
toc: true
89
---
910

@@ -66,6 +67,6 @@ Synchronize teams in Codefresh with LDAP using the Codefresh CLI.
6667

6768

6869
## Related articles
69-
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/single-sign-on/single-sign-on/)
70-
[Setting up OIDC Federated SSO]({{site.baseurl}}/docs/single-sign-on/oidc)
71-
[Setting up SAML2 Federated SSO]({{site.baseurl}}/docs/single-sign-on/saml)
70+
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/administration/single-sign-on/)
71+
[Setting up OIDC Federated SSO]({{site.baseurl}}/docs/administration/single-sign-on/oidc)
72+
[Setting up SAML2 Federated SSO]({{site.baseurl}}/docs/administration/single-sign-on/saml)

_docs/single-sign-on/oidc.md renamed to _docs/administration/single-sign-on/oidc.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: "Setting up OIDC Federated SSO"
33
description: "OpenID Connect (OIDC) Single Sign-On (SSO) setup"
4-
group: single-sign-on
4+
redirect_from:
5+
- /docs/single-sign-on/oidc/
56
toc: true
67
---
78

@@ -26,12 +27,12 @@ Here's what you need to do to configure SSO via OIDC in Codefresh:
2627
1. Configure SSO settings for the IdP:
2728
This generally includes defining settings both in Codefresh and in the IdP.
2829
Codefresh supports OIDC SSO for the following:
29-
* [Auth0]({{site.baseurl}}/docs/single-sign-on/oidc/oidc-auth0/)
30-
* [Azure]({{site.baseurl}}/docs/single-sign-on/oidc/oidc-azure/)
31-
* [Google]({{site.baseurl}}/docs/single-sign-on/oidc/oidc-google/)
32-
* [Keycloak]({{site.baseurl}}/docs/single-sign-on/oidc/oidc-keycloak/)
33-
* [Okta]({{site.baseurl}}/docs/single-sign-on/oidc/oidc-okta/)
34-
* [OneLogin]({{site.baseurl}}/docs/single-sign-on/oidc/oidc-onelogin/)
30+
* [Auth0]({{site.baseurl}}/docs/administration/single-sign-on/oidc/oidc-auth0/)
31+
* [Azure]({{site.baseurl}}/docs/administration/single-sign-on/oidc/oidc-azure/)
32+
* [Google]({{site.baseurl}}/docs/administration/single-sign-on/oidc/oidc-google/)
33+
* [Keycloak]({{site.baseurl}}/docs/administration/single-sign-on/oidc/oidc-keycloak/)
34+
* [Okta]({{site.baseurl}}/docs/administration/single-sign-on/oidc/oidc-okta/)
35+
* [OneLogin]({{site.baseurl}}/docs/administration/single-sign-on/oidc/oidc-onelogin/)
3536

3637
1. Test integration with the IdP:
3738

@@ -54,14 +55,14 @@ Here's what you need to do to configure SSO via OIDC in Codefresh:
5455
%}
5556

5657
{:start="3"}
57-
1. (Optional) [Set a default SSO provider for account]({{site.baseurl}}/docs/single-sign-on/team-sync/#set-a-default-sso-provider-for-account)
58+
1. (Optional) [Set a default SSO provider for account]({{site.baseurl}}/docs/administration/single-sign-on/team-sync/#set-a-default-sso-provider-for-account)
5859
You can select an IdP as the default SSO provider for a Codefresh account. This means that all the new users added to that account will automatically use the selected IdP for signin.
59-
1. (Optional) [Select SSO method for individual users]({{site.baseurl}}/docs/single-sign-on/team-sync/#select-sso-method-for-individual-users)
60+
1. (Optional) [Select SSO method for individual users]({{site.baseurl}}/docs/administration/single-sign-on/team-sync/#select-sso-method-for-individual-users)
6061
You can also select if needed, a different SSO provider for specific users.
6162

6263
> Codefresh has an internal cache for SSO configuration, and it can take up to five minutes for your changes to take effect.
6364
6465
## Related articles
65-
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/single-sign-on/single-sign-on/)
66-
[Setting up SAML2 Federated SSO]({{site.baseurl}}/docs/single-sign-on/saml)
66+
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/administration/single-sign-on/)
67+
[Setting up SAML2 Federated SSO]({{site.baseurl}}/docs/administration/single-sign-on/saml)
6768

_docs/single-sign-on/oidc/oidc-auth0.md renamed to _docs/administration/single-sign-on/oidc/oidc-auth0.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
---
22
title: "Auth0 SSO via OIDC"
33
description: "Set up Auth0 SSO for OIDC"
4-
group: single-sign-on
5-
sub_group: oidc
64
redirect_from:
75
- /docs/enterprise/sso-auth0/
86
- /docs/enterprise/single-sign-on/sso-auth0/
97
- /docs/administration/single-sign-on/sso-auth0/
8+
- /docs/single-sign-on/oidc/oidc-auth0/
109
toc: true
1110
---
1211

1312
Set up SSO for Auth0 using OIDC.
14-
For a general overview on OIDC, see [Setting up OIDC Federated SSO]({{site.baseurl}}/docs/single-sign-on/oidc).
13+
For a general overview on OIDC, see [Setting up OIDC Federated SSO]({{site.baseurl}}/docs/administration/single-sign-on/oidc).
1514

1615
Set up OIDC SSO for Auth0 in Codefresh by:
1716
1. Creating an Auth0 application in Auth0
@@ -109,8 +108,8 @@ max-width="50%"
109108
You have completed SSO setup for Auth0 in Codefresh.
110109

111110
## Related articles
112-
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/single-sign-on/single-sign-on/)
113-
[Common configuration for SSO providers]({{site.baseurl}}/docs/single-sign-on/team-sync)
111+
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/administration/single-sign-on/)
112+
[Common configuration for SSO providers]({{site.baseurl}}/docs/administration/single-sign-on/team-sync)
114113

115114

116115

_docs/single-sign-on/oidc/oidc-azure.md renamed to _docs/administration/single-sign-on/oidc/oidc-azure.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
---
22
title: "Azure SSO via OIDC"
33
description: "Set up Azure SSO for OIDC"
4-
group: single-sign-on
5-
sub_group: oidc
64
redirect_from:
75
- /docs/enterprise/single-sign-on/sso-azure/
6+
- /docs/single-sign-on/oidc/oidc-azure/
87
toc: true
98
---
109

1110
Set up SSO for Azure using OIDC.
12-
For a general overview on OIDC, see [Setting up OIDC Federated SSO]({{site.baseurl}}/docs/single-sign-on/oidc).
11+
For a general overview on OIDC, see [Setting up OIDC Federated SSO]({{site.baseurl}}/docs/administration/single-sign-on/oidc).
1312

1413
Set up OIDC SSO for Azure in Codefresh by:
1514
1. Registering the Codefresh application in Azure
@@ -244,5 +243,5 @@ You have now completed the SSO setup for Azure using OIDC.
244243

245244

246245
## Related articles
247-
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/single-sign-on/single-sign-on/)
248-
[Common configuration for SSO providers]({{site.baseurl}}/docs/single-sign-on/team-sync)
246+
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/administration/single-sign-on/)
247+
[Common configuration for SSO providers]({{site.baseurl}}/docs/administration/single-sign-on/team-sync)

_docs/single-sign-on/oidc/oidc-google.md renamed to _docs/administration/single-sign-on/oidc/oidc-google.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
---
22
title: "Google SSO via OIDC"
33
description: "Set up Google SSO for OIDC"
4-
group: single-sign-on
5-
sub_group: oidc
64
redirect_from:
75
- /docs/enterprise/sso-google/
86
- /docs/enterprise/single-sign-on/sso-google/
97
- /docs/administration/single-sign-on/sso-google/
10-
8+
- /docs/single-sign-on/oidc/oidc-google/
119
toc: true
1210
---
1311

1412
Set up SSO for Google using OIDC.
15-
For a general overview on OIDC, see [Setting up OIDC Federated SSO]({{site.baseurl}}/docs/single-sign-on/oidc).
13+
For a general overview on OIDC, see [Setting up OIDC Federated SSO]({{site.baseurl}}/docs/administration/single-sign-on/oidc).
1614

1715
Set up OIDC SSO for Google in Codefresh by:
1816
1. Creating the client secret in Google
@@ -30,6 +28,10 @@ Set up OIDC SSO for Google in Codefresh by:
3028
* From the **Application type** drop-down, select **Web application**.
3129
* Enter a **Name** for your integration (user-defined).
3230
* For **Authorized JavaScript origins**, **URIs**, enter, `https://g.codefresh.io`.
31+
* Select **Create**.
32+
* From the OAUth client created dialog, note down **Your Client ID** and **Your Client Secret**.
33+
You will need the Client ID and secret to configure SSO for Google in Codefresh.
34+
3335

3436
{% include image.html
3537
lightbox="true"
@@ -40,8 +42,7 @@ Set up OIDC SSO for Google in Codefresh by:
4042
max-width="70%"
4143
%}
4244

43-
* Select **Create**.
44-
* From the OAUth client created dialog, note down **Your Client ID** and **Your Client Secret**.
45+
4546

4647
{% include image.html
4748
lightbox="true"
@@ -52,16 +53,15 @@ Set up OIDC SSO for Google in Codefresh by:
5253
max-width="70%"
5354
%}
5455

55-
You will need the Client ID and secret to configure SSO for Google in Codefresh.
56-
5756
{:start="5"}
5857
1. Continue with [Step 2: Configure team synchronization settings in Google](#step-2-configure-team-synchronization-settings-in-google).
5958

6059
## Step 2: Configure team synchronization settings in Google
6160
When you configure SSO settings for Google OIDC in Codefresh, you can sync teams through a:
62-
* Service account
61+
* Service account
6362
OR
64-
* Custom schema
63+
* Custom schema
64+
6565
For both sync methods, you must configure settings in Google.
6666

6767
### Create service account in Google Console to synchronize teams
@@ -78,7 +78,7 @@ To synchronize users and teams through a service account, create a service accou
7878
url="/images/sso/google/serviceAccount2.png"
7979
alt="Creating a service account in Google"
8080
caption="Creating a service account in Google"
81-
max-width="30%"
81+
max-width="60%"
8282
%}
8383

8484
{:start=2"}
@@ -95,7 +95,7 @@ To synchronize users and teams through a service account, create a service accou
9595
url="/images/sso/google/serviceAccount3.png"
9696
alt="Creating a JSON key"
9797
caption="Creating a JSON key"
98-
max-width="30%"
98+
max-width="60%"
9999
%}
100100

101101
{:start="4"}
@@ -146,7 +146,7 @@ file="/images/sso/google/map-attributes.png"
146146
url="/images/sso/google/map-attributes.png"
147147
alt="Attribute Mappings screen in GSuite"
148148
caption="Attribute Mappings screen in GSuite"
149-
max-width="40%"
149+
max-width="60%"
150150
%}
151151

152152
{:start="5"}
@@ -158,7 +158,7 @@ file="/images/sso/google/google-gusite-user-info.png"
158158
url="/images/sso/google/google-gusite-user-info.png"
159159
alt="User Information screen in GSuite"
160160
caption="User Information screen in GSuite"
161-
max-width="40%"
161+
max-width="60%"
162162
%}
163163

164164
{:start="6"}
@@ -187,7 +187,7 @@ max-width="40%"
187187
url="/images/sso/google/sso-codefresh-settings.png"
188188
alt="SSO settings for Google in Codefresh"
189189
caption="SSO settings for Google in Codefresh"
190-
max-width="30%"
190+
max-width="60%"
191191
%}
192192

193193
{:start="4"}
@@ -228,7 +228,7 @@ max-width="40%"
228228
url="/images/sso/google/googleSSO3.png"
229229
alt="Redirect URI"
230230
caption="Redirect URI"
231-
max-width="30%"
231+
max-width="60%"
232232
%}
233233

234234
You have now completed SSO setup for Google via OIDC.
@@ -245,6 +245,6 @@ Now test the SSO with a test user in a different browser or private/incognito br
245245
1. In a different browser or private/incognito browser window use the Corporate option to log in.
246246

247247
## Related articles
248-
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/single-sign-on/single-sign-on/)
249-
[Setting up OIDC Federated SSO]({{site.baseurl}}/docs/single-sign-on/oidc)
250-
[Common configuration for SSO providers]({{site.baseurl}}/docs/single-sign-on/team-sync)
248+
[Federated Single Sign-On (SSO) overview]({{site.baseurl}}/docs/administration/single-sign-on/)
249+
[Setting up OIDC Federated SSO]({{site.baseurl}}/docs/administration/single-sign-on/oidc)
250+
[Common configuration for SSO providers]({{site.baseurl}}/docs/administration/single-sign-on/team-sync)

0 commit comments

Comments
 (0)