|
2 | 2 | title: How to deploy a CycleCloud Workspace for Slurm environment using the CLI
|
3 | 3 | description: How to deploy a CycleCloud Workspace for Slurm environment using the Azure CLI and the Azure portal UI Sandbox
|
4 | 4 | author: xpillons
|
5 |
| -ms.date: 05/27/2025 |
| 5 | +ms.date: 07/01/2025 |
6 | 6 | ms.author: padmalathas
|
7 | 7 | ---
|
8 | 8 |
|
9 | 9 | # How to deploy a CycleCloud Workspace for Slurm environment using the CLI
|
10 | 10 |
|
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. |
12 | 12 | > [!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. |
14 | 14 |
|
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 |
16 | 16 |
|
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 | + ``` |
20 | 20 |
|
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` |
22 | 22 |
|
23 |
| -- Browse to the UI Definition Sandbox: |
| 23 | +1. Browse to the UI Definition Sandbox: |
24 | 24 | - For Azure Public Cloud [Azure Public portal](https://portal.azure.com/#view/Microsoft_Azure_CreateUIDef/SandboxBlade)
|
25 | 25 | - For Azure US Gov [Azure US Gov portal](https://portal.azure.us/#view/Microsoft_Azure_CreateUIDef/SandboxBlade)
|
26 | 26 |
|
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. |
46 | 46 |
|
47 | 47 | ## Resources
|
48 | 48 |
|
|
0 commit comments