Skip to content

Commit 3c9cbf6

Browse files
authored
Merge pull request #302111 from tfitzmac/0701edit5
copy edit
2 parents b15f50e + f13077c commit 3c9cbf6

File tree

6 files changed

+113
-109
lines changed

6 files changed

+113
-109
lines changed
Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
---
22
title: How to connect to a Login Node through Bastion
3-
description: How to securily connect using SSH to a Login Node through Bastion
3+
description: How to securely connect using SSH to a Sign-In Node through Bastion
44
author: xpillons
5-
ms.date: 05/27/2025
5+
ms.date: 07/01/2025
66
ms.author: padmalathas
77
---
88

9-
# How to connect to a Login Node through Bastion
10-
There's no SSH route open from your local environment to Virtual Machines running in an Azure CycleCloud Workspace for Slurm by default for security reasons. However, an Azure Bastion can be deployed and used to SSH through to your Virtual Machines. Below are the instructions on how to do based on this documentation: [Connect to a VM using Bastion](/azure/bastion/connect-vm-native-client-linux).
9+
# How to connect to an authentication node through Bastion
1110

12-
## Step 1 – Identify the SSH private key locally
13-
Locate the private SSH key file associated with the public key provided during the deployment. If it isn't accessible locally, then download it.
11+
For security reasons, there's no SSH route open from your local environment to virtual machines running in an Azure CycleCloud Workspace for Slurm. However, you can deploy an Azure Bastion and use it to SSH to your virtual machines. The following instructions explain how to set up the connection. For more information, see [Connect to a VM using Bastion](/azure/bastion/connect-vm-native-client-linux).
1412

15-
## Step 2Retrieve the Resource ID of the Login Node
16-
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`.
13+
## Step 1Find the SSH private key on your computer
14+
Find the private SSH key file that matches the public key you provide during deployment. If you can't find the key on your computer, download it.
1715

18-
:::image type="content" source="../../images/ccws/login-node-resource-id.png" alt-text="Login Node properties":::
16+
## Step 2 – Get the resource ID of the authentication node
17+
In the CycleCloud UI, select the authentication node you want to connect to and double-click that line to open the detail view for the node. Select the **VM** tab to display the resource details, and copy the `ResourceId`.
18+
19+
:::image type="content" source="../../images/ccws/login-node-resource-id.png" alt-text="Screenshot of authentication node properties.":::
1920

2021
## Step 3 – Create a connect script
21-
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.
22+
Create an authentication script using the following template. Paste the authentication node `resourceID` from the previous step, and specify the resource group and the private SSH key file to use.
2223

2324
```bash
2425
#!/bin/bash
@@ -28,7 +29,8 @@ resourceGroup=$(echo $resourceId | cut -d'/' -f5)
2829
az network bastion ssh --name bastion --resource-group $resourceGroup --target-resource-id $resourceId --auth-type ssh-key --username hpcadmin --ssh-key hpcadmin_id_rsa
2930
```
3031

31-
> Note: The github repository https://github.com/Azure/cyclecloud-slurm-workspace.git contains the utility script `./util/ssh_thru_bastion.sh` to help connecting.
32+
> [!NOTE]
33+
> The GitHub repository https://github.com/Azure/cyclecloud-slurm-workspace.git contains the utility script `./util/ssh_thru_bastion.sh` to help with connecting.
3234
3335
## Step 4 - Connect
34-
Run the script created/updated above to SSH on the login node.
36+
Run the preceding script to SSH to the authentication node.

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: How to connect to the CycleCloud Portal through Bastion
33
description: How to securely connect to the CycleCloud Portal using Bastion
44
author: xpillons
5-
ms.date: 05/27/2025
5+
ms.date: 07/01/2025
66
ms.author: padmalathas
77
---
88

99
# How to connect to the CycleCloud Portal through Bastion
1010
You can deploy an Azure Bastion to establish an SSH tunnel to your Azure CycleCloud virtual machine when the HTTPS route is unavailable in your local environment. For detailed instructions, see [Connect to a VM - tunnel command](/azure/bastion/connect-vm-native-client-linux#tunnel).
1111

12-
## Step 1 – Retrieve the Resource ID of the CycleCloud VM
13-
To retrieve the resource ID of the `ccw-cyclecloud-vm` virtual machine, navigate to the Azure portal. From the virtual machine view, select **Settings**, then **Properties**, and you'll find the **ResourceID**.
12+
## Step 1 – Retrieve the resource ID of the CycleCloud VM
13+
To retrieve the resource ID of the `ccw-cyclecloud-vm` virtual machine, go to the Azure portal. From the virtual machine view, select **Settings**, then **Properties**, and you find the **ResourceID**.
1414

1515
## Step 2 – Create a connect script
16-
Create a bash script using the template below. Paste the CycleCloud `resourceID` retrieved above.
16+
Create a bash script using the following template. Paste the CycleCloud `resourceID` that you got earlier.
1717

1818
```bash
1919
#!/bin/bash
@@ -24,12 +24,13 @@ resourceGroup=$(echo $resourceId | cut -d'/' -f5)
2424
az network bastion tunnel --name bastion --resource-group $resourceGroup --target-resource-id $resourceId --resource-port 443 --port 8443
2525
```
2626

27-
> Note: The github repository https://github.com/Azure/cyclecloud-slurm-workspace.git contains the utility script _./util/tunnel_thru_bastion.sh_ to help connecting.
27+
> [!NOTE]
28+
> The GitHub repository https://github.com/Azure/cyclecloud-slurm-workspace.git contains the utility script _./util/tunnel_thru_bastion.sh_ to help connecting.
2829
2930

3031
## Step 3 - Create the tunnel
31-
Run the script created/updated above to start the SSH tunnel.
32+
Run the script you created or updated to start the SSH tunnel.
3233

3334
## Step 4 - Connect to CycleCloud
3435

35-
Browse to `https://localhost:8443` and connect to CycleCloud.
36+
Go to `https://localhost:8443` and connect to CycleCloud.

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

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,47 @@
22
title: How to deploy a CycleCloud Workspace for Slurm environment using the CLI
33
description: How to deploy a CycleCloud Workspace for Slurm environment using the Azure CLI and the Azure portal UI Sandbox
44
author: xpillons
5-
ms.date: 05/27/2025
5+
ms.date: 07/01/2025
66
ms.author: padmalathas
77
---
88

99
# How to deploy a CycleCloud Workspace for Slurm environment using the CLI
1010

11-
Prerequisites: Users need to install the Azure CLI and Git and then sign into or set their Azure subscription.
11+
Prerequisites: Install the Azure CLI and Git, and then sign in or set your Azure subscription.
1212
> [!IMPORTANT]
13-
> Execute the following command from a Linux shell where Azure CLI is installed and authenticated with the Azure account designated for deployment. Please note that Azure Cloud Shell isn't supported for this scenario.
13+
> Run the following command from a Linux shell where Azure CLI is installed and authenticated with the Azure account designated for deployment. Azure Cloud Shell isn't supported for this scenario.
1414
15-
- Clone the Azure CycleCloud Workspace for Slurm on the latest stable release
15+
1. Clone the Azure CycleCloud Workspace for Slurm on the latest stable release
1616

17-
```bash
18-
git clone --depth 1 https://github.com/azure/cyclecloud-slurm-workspace.git
19-
```
17+
```bash
18+
git clone --depth 1 https://github.com/azure/cyclecloud-slurm-workspace.git
19+
```
2020

21-
- Copy the content of the UI definition file `./uidefinitions/createUiDefinition.json`
21+
1. Copy the content of the UI definition file `./uidefinitions/createUiDefinition.json`
2222

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

27-
- Paste the content of the UI Definition file into the multiline text box in the right,
28-
- Click `Preview >>` in the bottom-left corner to bring up a UI experience.
29-
- Proceed through each page of the UI flow to ensure that necessary values populate in the output payload described in the next step,
30-
- Proceed with the UI flow to the `Review + create` page and then click the link labeled `View outputs payload` to the right of the `Create` button to generate a pane with JSON-formatted text in its body on the right-hand side of the browser window,
31-
- Copy the JSON-formatted text into a local JSON file,
32-
- Save it as `parameters.json` and make note of the path to it. This is what we call the Parameters File for the deployment,
33-
- Open the shell of choice and navigate to the folder/directory that contains the `cyclecloud-slurm-workspace` repository cloned above,
34-
- Accept the terms of the Cycle image plan:
35-
36-
```bash
37-
az vm image terms accept --urn azurecyclecloud:azure-cyclecloud:cyclecloud8-gen2:latest
38-
```
39-
- Run the following deployment command in shell. Substitutions should be made for fields with square brackets (be sure to delete brackets). The instructions below assume that the current directory is as described in the previous step,
40-
41-
```bash
42-
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]
43-
```
44-
45-
- 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.
27+
1. Paste the content of the UI Definition file into the multiline text box on the right.
28+
1. Select `Preview >>` in the bottom-left corner to bring up a UI experience.
29+
1. Go through each page of the UI flow to make sure that necessary values appear in the output payload described in the next step.
30+
1. Go through the UI flow to the `Review + create` page and then select the link labeled `View outputs payload` to the right of the `Create` button to generate a pane with JSON-formatted text in its body on the right-hand side of the browser window.
31+
1. Copy the JSON-formatted text into a local JSON file.
32+
1. Save it as `parameters.json` and note the path to it. This file is the Parameters File for the deployment.
33+
1. Open the shell of your choice and go to the folder or directory that contains the `cyclecloud-slurm-workspace` repository you cloned earlier.
34+
1. Accept the terms of the Cycle image plan:
35+
36+
```bash
37+
az vm image terms accept --urn azurecyclecloud:azure-cyclecloud:cyclecloud8-gen2:latest
38+
```
39+
1. Run the following deployment command in a shell. Substitute values for fields in square brackets (be sure to delete the brackets). The current directory is as described in the previous step.
40+
41+
```bash
42+
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]
43+
```
44+
45+
1. Wait until the shell indicates that the deployment was successful. You can also track the progress of the deployment in the Azure portal. Go to the resource group shown in the UI, select **Deployments** from the Settings menu, and check the status of the deployment name that begins with "pid-" at the bottom of the displayed list.
4646

4747
## Resources
4848

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22
title: Add users for Open OnDemand
33
description: How to add users for Open OnDemand
44
author: xpillons
5-
ms.date: 05/27/2025
5+
ms.date: 07/01/2025
66
ms.author: padmalathas
77
---
88

99
# Add 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.
11-
1. Browse the CycleCloud web portal and select the top right gear icon to open the menu. Select the **Users** option.
12-
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)
13-
1. Select at least the role **Global Node User** for regular users and **Global Node Admin** for administrators (sudo access)
14-
1. Save
15-
1. Add other users as needed
16-
1. Wait for the users to be created on clusters. It may take a few minutes.
10+
After users authenticate with Microsoft Entra ID, Open OnDemand maps each user to a local user account that CycleCloud manages. CycleCloud creates the local user account with the same name as the Microsoft Entra ID user. The following steps describe how to add cluster users for Open OnDemand.
1711

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.
12+
1. Browse the CycleCloud web portal and select the gear icon in the upper right corner to open the menu. Select the **Users** option.
13+
1. Select **Add** to add a new user. For more information about user management in CycleCloud, see [User Management](../../concepts/user-management.md).
14+
1. Select at least the **Global Node User** role for regular users and the **Global Node Admin** role for administrators (sudo access).
15+
1. Select **Save**.
16+
1. Add other users as needed.
17+
1. Wait for the users to be created on clusters. This process might take a few minutes.
18+
19+
Users can now sign in to Open OnDemand with their Microsoft Entra ID credentials. A consent message might appear when users try to sign in for the first time. Users should give consent to be redirected to the Open OnDemand dashboard.

0 commit comments

Comments
 (0)