forked from nrwl/nx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(nx-dev): standardize nx cloud naming (nrwl#21059)
- Loading branch information
Showing
20 changed files
with
64 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# SAML Auth | ||
|
||
SAML support for NxCloud is an addon for Nx Enterprise contracts and requires an unlock key. Please [get in touch](mailto:[email protected]) | ||
SAML support for Nx Cloud is an addon for Nx Enterprise contracts and requires an unlock key. Please [get in touch](mailto:[email protected]) | ||
if you are interested. | ||
|
||
### Jump To | ||
|
@@ -55,7 +55,7 @@ if you are interested. | |
|
||
1. **“Namespace”** needs to be blank | ||
2. **“Name:”** needs to be “email” | ||
3. See screenshot below. This is an important step, because NxCloud will expect the “email” property on each profile that logs in. | ||
3. See screenshot below. This is an important step, because Nx Cloud will expect the “email” property on each profile that logs in. | ||
|
||
![Step 11](/nx-cloud/private/images/saml/azure_11.png) | ||
|
||
|
@@ -70,7 +70,7 @@ if you are interested. | |
|
||
![Step 13](/nx-cloud/private/images/saml/azure_13.png) | ||
|
||
14. Then add these two env vars to your NxCloud cluster secrets (see [Helm config](#helm-config) below): | ||
14. Then add these two env vars to your Nx Cloud cluster secrets (see [Helm config](#helm-config) below): | ||
1. `SAML_CERT=<your-cert-string-from-above>` | ||
2. `SAML_ENTRY_POINT=<your-login-url-from-above>` | ||
|
||
|
@@ -88,7 +88,7 @@ if you are interested. | |
|
||
3. On the Next page, configure it as below: | ||
|
||
1. The Single Sign On URL needs to point to your NxCloud instance URL and ends with `/auth/saml/callback` | ||
1. The Single Sign On URL needs to point to your Nx Cloud instance URL and ends with `/auth/saml/callback` | ||
2. The Audience should be `nx-private-cloud` | ||
|
||
![Okta 4](/nx-cloud/private/images/saml/okta_4.png) | ||
|
@@ -98,9 +98,9 @@ if you are interested. | |
![Okta 5](/nx-cloud/private/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 NxCloud WebApp: | ||
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 NxCloud web app with their own workspace. Users will still need to be invited manually through the web app to your main workspace. | ||
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/private/images/saml/okta_6.png) | ||
|
||
|
@@ -136,7 +136,7 @@ if you are interested. | |
|
||
## Helm config | ||
|
||
If you are using [Helm to deploy NxCloud](https://github.com/nrwl/nx-cloud-helm) you | ||
If you are using [Helm to deploy Nx Cloud](https://github.com/nrwl/nx-cloud-helm) you | ||
will need to configure the below two values, as well as make the `SAML_CERT` and `SAML_ENTRY_POINT` | ||
env vars as secrets: | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
# Connecting Nx Cloud to your existing Google identity provider | ||
|
||
If your organization uses [Google Identity](https://cloud.google.com/identity) or [Google Workspaces](https://workspace.google.com/intl/en_uk/) to manage employee accounts and permissions, your NxCloud workspace members can re-use the same accounts to sign-in to NxCloud and view runs, cache stats etc. Besides being more convenient for the employee, as they don't have to sign-in again, it also has a security benefit: if an employee leaves the company and their Google account is disabled, they won't be able to sign-in to NxCloud anymore. | ||
If your organization uses [Google Identity](https://cloud.google.com/identity) or [Google Workspaces](https://workspace.google.com/intl/en_uk/) to manage employee accounts and permissions, your Nx Cloud workspace members can re-use the same accounts to sign-in to Nx Cloud and view runs, cache stats etc. Besides being more convenient for the employee, as they don't have to sign-in again, it also has a security benefit: if an employee leaves the company and their Google account is disabled, they won't be able to sign-in to Nx Cloud anymore. | ||
|
||
By default, when you invite a member by email, they can create a separate NxCloud account using their work e-mail address. **If their primary email address gets disabled, they will still be able to sign-in with their NxCloud account, unless you explicitly revoke their membership from the Members page.** | ||
By default, when you invite a member by email, they can create a separate Nx Cloud account using their work e-mail address. **If their primary email address gets disabled, they will still be able to sign-in with their Nx Cloud account, unless you explicitly revoke their membership from the Members page.** | ||
|
||
If you'd like them to sign-in with Google directly, which ensures they automatically lose access to their NxCloud account if their email gets disabled, you need to enable this option when inviting them: "_Require Social OAuth Sign-In_". They will then only be able to accept the invite if they sign-in with Google directly. | ||
If you'd like them to sign-in with Google directly, which ensures they automatically lose access to their Nx Cloud account if their email gets disabled, you need to enable this option when inviting them: "_Require Social OAuth Sign-In_". They will then only be able to accept the invite if they sign-in with Google directly. | ||
|
||
![Require Google OAuth Sign-In toggle](/nx-cloud/recipes/require-google-signin.webp) | ||
|
||
## SAML integration | ||
|
||
NxCloud does not currently provide direct integration with SAML identity providers. You can, however, connect your existing SAML provider to Google, and then use the method above to invite employees: | ||
Nx Cloud does not currently provide direct integration with SAML identity providers. You can, however, connect your existing SAML provider to Google, and then use the method above to invite employees: | ||
|
||
- [Azure AD](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/google-apps-tutorial) | ||
- [Okta](https://www.okta.com/integrations/google-workspace/#overview) |
Oops, something went wrong.