Skip to content

Commit

Permalink
fix(nx-dev): standardize nx cloud naming (nrwl#21059)
Browse files Browse the repository at this point in the history
  • Loading branch information
meeroslav authored Jan 10, 2024
1 parent 6307a83 commit 20dcc97
Show file tree
Hide file tree
Showing 20 changed files with 64 additions and 64 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ The scope must be one of the following:
- nest - anything Nest specific
- nextjs - anything Next specific
- node - anything Node specific
- nx-cloud - anything NxCloud specific
- nx-cloud - anything Nx Cloud specific
- nx-plugin - anything Nx Plugin specific
- nx-dev - anything related to docs infrastructure
- react - anything React specific
Expand Down
28 changes: 14 additions & 14 deletions docs/nx-cloud/private/ami-setup.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Setting up a dedicated NxCloud VM
# Setting up a dedicated Nx Cloud VM

## AWS EC2

Expand All @@ -14,24 +14,24 @@
- Allow SSH from your current IP
6. Leave the storage options as they are
7. "Launch instance"
8. Wait 10 minutes, then navigate to your instance's IP in the browser. You should see the NxCloud dashboard!
8. Wait 10 minutes, then navigate to your instance's IP in the browser. You should see the Nx Cloud dashboard!

![NxCloud landing page](/nx-cloud/private/images/nx-cloud-landing.png)
![Nx Cloud landing page](/nx-cloud/private/images/nx-cloud-landing.png)

### Your NxCloud URL
### Your Nx Cloud URL

1. At this point, your instance will have a public IP accessible from the browser.
- You can consider this IP the URL of NxCloud, and proceed with the below steps and all will work fine!
- You can consider this IP the URL of Nx Cloud, and proceed with the below steps and all will work fine!
2. You might want, however, to add a Load Balancer in front of the instance, with an explicit domain (e.g. https://my-nxcloud.my-org.com).
- This is strongly recommended because you will be able to upgrade/restart/re-configure your NxCloud EC2 instance while keeping the NxCloud URL static.
- This is strongly recommended because you will be able to upgrade/restart/re-configure your Nx Cloud EC2 instance while keeping the Nx Cloud URL static.
- Create an [application load balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-application-load-balancer.html)
- You will need to create a certificate for your domain to assign to the LB
- And you will need to target your EC2 instance from the LB
- You should now have a permanent domain pointing to your NxCloud instance
- You should now have a permanent domain pointing to your Nx Cloud instance

Once you have your NxCloud URL proceed to the below steps!
Once you have your Nx Cloud URL proceed to the below steps!

### Configuring your NxCloud instance
### Configuring your Nx Cloud instance

1. Create a new `myconfiguration.yaml` file with the below contents

Expand Down Expand Up @@ -66,9 +66,9 @@ Once you log-in, you will see an organisation has been created for you.
- It should look something like this: https://your-url.com/orgs/649f240f7fb955000c1fd10b/workspaces
3. We will then give you a License Key which you can apply on your org's billing page

### Connecting to your NxCloud instance
### Connecting to your instance

In your Nx workspace, you can enable NxCloud by running:
In your Nx workspace, you can enable Nx Cloud by running:

```bash
NX_CLOUD_API="https://nx-cloud.on.my-domain.ca" npx nx connect
Expand All @@ -94,7 +94,7 @@ You can optionally enable authentication using your preferred SSO provider:
```yaml
# This is all you need to get the baseline of your nx-cloud instance configured!

# only use this if you'd like to use any of the newer NxCloud version from here: https://nx.dev/ci/reference/release-notes#docker-containers
# only use this if you'd like to use any of the newer Nx Cloud version from here: https://nx.dev/ci/reference/release-notes#docker-containers
# global.imageTag: ''

# Set the external URL your instance is running on
Expand Down Expand Up @@ -152,10 +152,10 @@ secret:

### Upgrades

We send out emails with every new NxCloud release to all our Enterprise customers:
We send out emails with every new Nx Cloud release to all our Enterprise customers:

1. You can view your current version at the `/version` route: https://your-nx-cloud-url.com/version
2. [And these are the latest NxCloud releases](https://nx.dev/ci/reference/release-notes#docker-containers)
2. [And these are the latest Nx Cloud releases](https://nx.dev/ci/reference/release-notes#docker-containers)

To upgrade to a newer version, add the below line to your `myconfiguration.yml` file:

Expand Down
4 changes: 2 additions & 2 deletions docs/nx-cloud/private/auth-saml-managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ You'll be entering it in the instructions below.
![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)

Expand Down
14 changes: 7 additions & 7 deletions docs/nx-cloud/private/auth-saml.md
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
Expand Down Expand Up @@ -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)

Expand All @@ -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>`

Expand All @@ -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)
Expand All @@ -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)

Expand Down Expand Up @@ -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:

Expand Down
12 changes: 6 additions & 6 deletions docs/nx-cloud/private/nx-enterprise-on-prem.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Running Nx Cloud Enterprise

We offer multiple ways of running NxCloud for our Enterprise customers. The below options are listed in recommended order, from easiest to most complex in terms of set-up and maintenance for your team. Please carefully consider your organization's requirements and level of infrastructure expertise before deciding on a deployment option.
We offer multiple ways of running Nx Cloud for our Enterprise customers. The below options are listed in recommended order, from easiest to most complex in terms of set-up and maintenance for your team. Please carefully consider your organization's requirements and level of infrastructure expertise before deciding on a deployment option.

{% call-to-action title="Get in Touch" icon="nxcloud" description="Get the package that best fits your needs" url="https://nx.app/enterprise?utm_source=nx.dev" /%}

## Managed Setup

### Multi-tenant

The quickest and easiest way to start using NxCloud is by utilizing our pre-existing secure, multi-tenant managed clusters:
The quickest and easiest way to start using Nx Cloud is by utilizing our pre-existing secure, multi-tenant managed clusters:

- [https://nx.app/](https://nx.app/)
- [https://eu.nx.app/](https://eu.nx.app/) if you have special restrictions and your data needs to be hosted in Europe.
Expand All @@ -25,7 +25,7 @@ npx nx connect

### Single-tenant instance

If you have very specific requirements, then we can also offer to host NxCloud for you in an isolated/single-tenant cluster.
If you have very specific requirements, then we can also offer to host Nx Cloud for you in an isolated/single-tenant cluster.

We'll be able to discuss specific requirements such as:

Expand All @@ -36,17 +36,17 @@ We'll be able to discuss specific requirements such as:
- Storage replication / redundancy

This would be a "best of both worlds" option, as it would free you up from managing the instance yourself, but you will get to define specific parameters of how it should it run.
Your data and the NxCloud will run in complete isolation and will only serve your company. There will be no external API calls to any services outside of the cluster we set-up for you.
Your data and the Nx Cloud will run in complete isolation and will only serve your company. There will be no external API calls to any services outside of the cluster we set-up for you.

Once you let us know you'd like this option, depending on the agreed requirements, it might take a few days to get it set up.

## On-prem, managed by your organization

### Self-contained VM

If you would like to host NxCloud yourself, within your organization's infrastructure, the easiest way to set it up is as a self-contained VM.
If you would like to host Nx Cloud yourself, within your organization's infrastructure, the easiest way to set it up is as a self-contained VM.

Refer to our ["Self-contained VM" guide](/ci/recipes/on-premise/ami-setup) for instructions on running NxCloud on Amazon EC2.
Refer to our ["Self-contained VM" guide](/ci/recipes/on-premise/ami-setup) for instructions on running Nx Cloud on Amazon EC2.

### Multi-node setup with Kubernetes

Expand Down
8 changes: 4 additions & 4 deletions docs/nx-cloud/recipes/google-auth.md
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)
Loading

0 comments on commit 20dcc97

Please sign in to comment.