Skip to content

Commit 1ec9eea

Browse files
committed
update based on review after first signedoff
1 parent f200682 commit 1ec9eea

19 files changed

+79
-77
lines changed
Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Configure Open OnDemand with CycleCloud
2+
title: Configure Open Demand with CycleCloud
33
description: How to configure Open OnDemand with CycleCloud
44
author: xpillons
55
ms.date: 04/30/2025
@@ -9,20 +9,22 @@ ms.author: padmalathas
99
# Configure Open OnDemand with CycleCloud
1010
Open OnDemand is a web-based interface that provides a user-friendly way to interact with the Slurm cluster deployed by Azure CycleCloud. Open OnDemand is automatically installed and configured when deploying Azure CycleCloud Workspace for Slurm, but there remain few steps that must be manually executed.
1111

12-
## Update settings for Entra ID authentication
13-
The Open OnDemand front end uses Open ID Connect (OIDC) for authentication. The OIDC provider is an Entra ID application that was registered specifically for this purpose (see [How to register an Entra ID application for Open OnDemand Authentication](./register-entra-id-app.md)). The following steps describe how to update the settings for Entra ID authentication.
12+
## Update settings for Microsoft Entra ID authentication
13+
The Open OnDemand front end uses Open ID Connect (OIDC) for authentication. The OIDC provider is an Microsoft Entra ID application that was registered specifically for this purpose (see [How to register an Microsoft Entra ID application for Open OnDemand Authentication](./register-entra-id-app.md)). The following steps describe how to update the settings for Entra ID authentication.
1414

1515
Browse to the CycleCloud web portal, select the OpenOnDemand cluster, and click on the Edit button. This opens the cluster template definition.
1616
1. Select Advanced settings,
1717
1. Leave FQDN empty,
1818
1. Set the Client ID to that of the registered application ID created in previous steps,
1919
1. Set the user domain to the enterprise domain,
2020
1. Tenant ID should be set to that of the tenant in which the application registration exists,
21-
1. The managed identity should be manually set to the one named `/ccwOpenOnDemandManagedIdentity` **Note**: this value will initially fail to appear due to a UI bug, so this needs to be set again when editing the template.
21+
1. The managed identity should be manually set to the one named `/ccwOpenOnDemandManagedIdentity`
22+
> [!NOTE]
23+
> This value will initially fail to appear due to a UI bug, so this needs to be set again when editing the template.
2224
2325
Press `Save` and then `Start Cluster` and wait for the Open OnDemand virtual machine to be ready.
2426

25-
![Screenshot of Open OnDemand cluster configuration](../../images/ccws/ood-advanced-settings.png)
27+
::image type="content" source="../../images/ccws/open-ondemand-advanced-settings.png" alt-text="Screenshot of Open OnDemand cluster configuration.":::
2628

2729
## Resources
28-
* [Add users for Open OnDemand](./ood-add-users.md)
30+
* [Add users for Open OnDemand](./open-ondemand-add-users.md)

articles/cyclecloud/how-to/ccws/connect-to-login-node-with-bastion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Locate the private SSH key file associated with the public key provided during t
1515
## Step 2 – Retrieve the Resource ID of the Login Node
1616
From the CycleCloud UI, select the Login node to which you want to connect and double click on that line to open the detail view of the node. Select the VM tab to display the resource details below and copy the `ResourceId`.
1717

18-
![Login Node properties](../../images/ccws/login-node-resource-id.png)
18+
::image type="content" source="../../images/ccws/login-node-resource-id.png" alt-text="Login Node properties":::
1919

2020
## Step 3 – Create a connect script
2121
Create a login script using the template below. Paste the login node `resourceID` retrieved above and specify the resource group and the private SSH key file to use.

articles/cyclecloud/how-to/ccws/deploy-with-cli.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: How to deploy a CycleCloud Workspace for Slurm environment using the CLI
3-
description: How to deploy a CycleCloud Workspace for Slurm environment using the Azure CLI and the Azure Portal UI Sandbox
3+
description: How to deploy a CycleCloud Workspace for Slurm environment using the Azure CLI and the Azure portal UI Sandbox
44
author: xpillons
55
ms.date: 04/30/2025
66
ms.author: xpillons
@@ -19,8 +19,8 @@ git clone --depth 1 https://github.com/azure/cyclecloud-slurm-workspace.git
1919
- Copy the content of the UI definition file `./uidefinitions/createUiDefinition.json`
2020

2121
- Browse to the UI Definition Sandbox:
22-
- For Azure Public Cloud [Azure Public Portal](https://portal.azure.com/#view/Microsoft_Azure_CreateUIDef/SandboxBlade)
23-
- For Azure US Gov [Azure US Gov Portal](https://portal.azure.us/#view/Microsoft_Azure_CreateUIDef/SandboxBlade)
22+
- For Azure Public Cloud [Azure Public portal](https://portal.azure.com/#view/Microsoft_Azure_CreateUIDef/SandboxBlade)
23+
- For Azure US Gov [Azure US Gov portal](https://portal.azure.us/#view/Microsoft_Azure_CreateUIDef/SandboxBlade)
2424

2525
- Paste the content of the UI Definition file into the multiline text box in the right,
2626
- Click `Preview >>` in the bottom-left corner to bring up a UI experience.
@@ -40,11 +40,11 @@ az vm image terms accept --urn azurecyclecloud:azure-cyclecloud:cyclecloud8-gen2
4040
az deployment sub create --template-file ./cyclecloud-slurm-workspace/bicep/mainTemplate.bicep --parameters parameters.json --location [ANY AZURE LOCATION E.G. eastus] --name [OPTIONAL BUT HELPFUL, DELETE IF UNUSED]
4141
```
4242

43-
- Wait until the shell indicates that the deployment was successful. One can also track the progress of the deployment in the Azure Portal by navigating to the resource group indicated in the UI, selecting `Deployments` from the Settings dropdown menu on the left-hand side menu, and checking the Status of the Deployment Name that begins with “pid-” at the bottom of the displayed list.
43+
- Wait until the shell indicates that the deployment was successful. One can also track the progress of the deployment in the Azure portal by navigating to the resource group indicated in the UI, selecting `Deployments` from the Settings dropdown menu on the left-hand side menu, and checking the Status of the Deployment Name that begins with “pid-” at the bottom of the displayed list.
4444

4545
## Resources
4646

47-
* [Configure Open OnDemand with CycleCloud](./configure-ood.md)
48-
* [Add users for Open OnDemand](./ood-add-users.md)
49-
* [How to connect to the CycleCloud Portal through Bastion](/azure/cyclecloud/how-to/ccws/connect-to-portal-with-bastion)
47+
* [Configure Open OnDemand with CycleCloud](./configure-open-ondemand.md)
48+
* [Add users for Open OnDemand](./open-ondemand-add-users.md)
49+
* [How to connect to the CycleCloud portal through Bastion](/azure/cyclecloud/how-to/ccws/connect-to-portal-with-bastion)
5050
* [How to connect to a Login Node through Bastion](/azure/cyclecloud/how-to/ccws/connect-to-login-node-with-bastion)

articles/cyclecloud/how-to/ccws/ood-add-users.md renamed to articles/cyclecloud/how-to/ccws/open-ondemand-add-users.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ ms.author: padmalathas
77
---
88

99
# Add users for Open OnDemand
10-
Once authenticated with Entra ID, Open OnDemand maps the user to a local user account managed by CycleCloud created with the same name as the Entra ID user. The following steps describe how to add cluster users for Open OnDemand.
10+
Once authenticated with Microsoft Entra ID, Open OnDemand maps the user to a local user account managed by CycleCloud created with the same name as the Microsoft Entra ID user. The following steps describe how to add cluster users for Open OnDemand.
1111
1. Browse the CycleCloud web portal and select the top right gear icon to open the menu. Select the **Users** option.
1212
1. Click on the **Add** button to add a new user. For more details on user management in CycleCloud, see instructions: [User Management](../../concepts/user-management.md)
1313
1. Select at least the role **Global Node User** for regular users and **Global Node Admin** for administrators (sudo access)
1414
1. Save
1515
1. Add other users as needed
1616
1. Wait for the users to be created on clusters. It may take a few minutes.
1717

18-
Users can now log in to Open OnDemand using their Entra ID credentials. A consent message may appear upon an initial login attempt: users should affirm consent to be redirected to the Open OnDemand dashboard.
18+
Users can now log in to Open OnDemand using their Microsoft Entra ID credentials. A consent message may appear upon an initial login attempt: users should affirm consent to be redirected to the Open OnDemand dashboard.

articles/cyclecloud/how-to/ccws/register-entra-id-app.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: Register an Entra ID application for Open OnDemand Authentication
3-
description: How to register an Entra ID application for Open OnDemand Authentication
2+
title: Register a Microsoft Entra ID application for Open OnDemand authentication
3+
description: How to register a Microsoft Entra ID application for Open OnDemand authentication
44
author: xpillons
55
ms.date: 04/30/2025
66
ms.author: padmalathas
77
---
88

9-
# Register an Entra ID application for Open OnDemand Authentication
10-
The Open OnDemand front end use Open ID Connect (OIDC) for authentication. The OIDC provider is an Entra ID application that you need to register which uses Federated credentials with a User-Assigned Managed Identity to avoid storing secrets in the Open OnDemand configuration. The following steps describe how to register an Entra ID application for Open OnDemand authentication.
9+
# Register a Microsoft Entra ID application for Open OnDemand authentication
10+
The Open OnDemand front end use Open ID Connect (OIDC) for authentication. The OIDC provider is a Microsoft Entra ID application that you need to register which uses Federated credentials with a User-Assigned Managed Identity to avoid storing secrets in the Open OnDemand configuration. The following steps describe how to register a Microsoft Entra ID application for Open OnDemand authentication.
1111

12-
## Entra ID Application Registration right after a successful deployment
13-
After the deployment is finished, it is necessary to execute the following commands from a Linux shell with Azure CLI installed to register and configure the Entra ID application for authentication. The account logged into the CLI must have the appropriate permissions to register an application and its active subscription must be the one used for the deployment if it is not already set.
12+
## Microsoft Entra ID application registration right after a successful deployment
13+
After the deployment is finished, it is necessary to execute the following commands from a Linux shell with Azure CLI installed to register and configure the Microsoft Entra ID application for authentication. The account logged into the CLI must have the appropriate permissions to register an application and its active subscription must be the one used for the deployment if it is not already set.
1414

1515
> [!NOTE]
1616
> Make sure you have `jq` utility installed on your system.
@@ -23,16 +23,16 @@ az deployment group create -g $resource_group --template-uri https://raw.githubu
2323
Once executed, check that the application is indeed registered and copy its client ID.
2424
Ensure the redirect URI in Authentication is correct, federated credentials are set, `upn` is an optional claim in Token configuration, and API permissions are present.
2525

26-
## Update an existing Entra ID Application after a successful deployment
27-
Update the redirect URI with either the private IP or the FQDN of the Open OnDemand virtual machine if an Entra ID application is already registered.
26+
## Update an existing Microsoft Entra ID application after a successful deployment
27+
Update the redirect URI with either the private IP or the FQDN of the Open OnDemand virtual machine if a Microsoft Entra ID application is already registered.
2828

2929
Verify that both the `ccw` and `OpenOnDemand` clusters are started. Although there may be some temporary errors, both clusters should be ready within a few minutes.
3030
Complete the configuration of the registered application by adding a new redirect URI, 'https://\<ip\>/oidc', in the Authentication settings of the application as illustrated below.
3131

32-
![Screenshot of Entra ID redirect URI update](../../images/ccws/entraid-redirect-uri.png)
32+
::image type="content" source="../../images/ccws/entraid-redirect-uri.png" alt-text="Screenshot of Microsoft Entra ID redirect URI update.":::
3333

34-
## Register an Entra ID application before a deployment
35-
It is possible to register an Entra ID application before the deployment of a full environment and configure it afterwards.
34+
## Register a Microsoft Entra ID application before a deployment
35+
It is possible to register a Microsoft Entra ID application before the deployment of a full environment and configure it afterwards.
3636

3737
Create an app.json parameter file containing:
3838
- **appName** : the name of the application to be registered,
@@ -53,7 +53,7 @@ Create an app.json parameter file containing:
5353
}
5454
```
5555

56-
Execute the below commands to create a resource group and a user-assigned managed identity and to register the Entra ID application.
56+
Execute the below commands to create a resource group and a user-assigned managed identity and to register the Microsoft Entra ID application.
5757
```bash
5858
resource_group=<the_resource_group_you_deployed_in>
5959
location=<location>
@@ -63,5 +63,5 @@ az deployment group create -g $resource_group --template-uri https://raw.githubu
6363
```
6464

6565
## Resources
66-
* [Configure Open OnDemand with CycleCloud](./configure-ood.md)
67-
* [Add users for Open OnDemand](./ood-add-users.md)
66+
* [Configure Open OnDemand with CycleCloud](./configure-open-ondemand.md)
67+
* [Add users for Open OnDemand](./open-ondemand-add-users.md)
146 KB
Loading
-95 Bytes
Loading

0 commit comments

Comments
 (0)