You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: See a reference for cluster-init objects to be used with Azure CycleCloud. A cluster-init object defines the CycleCloud project specifications to run on a node.
4
4
author: adriankjohnson
5
-
ms.date: 05/31/2024
5
+
ms.date: 06/29/2025
6
6
ms.author: adjohnso
7
7
ms.custom: compute-evergreen
8
8
---
9
9
10
10
# Cluster-Init
11
11
12
-
Cluster-init objects are subordinate in rank to `node` and `nodearray`. The cluster-init object defines the [CycleCloud project](~/articles/cyclecloud/how-to/projects.md) specs to run on a node.
12
+
Cluster-init objects are subordinate to `node` and `nodearray` objects. The cluster-init object defines the [CycleCloud project](~/articles/cyclecloud/how-to/projects.md) specs to run on a node.
13
13
14
-
Adding a `[[[cluster-init]]]` section to a node will include a project spec. Cluster-init definition can also be written in short-hand notation:
14
+
When you add a `[[[cluster-init]]]` section to a node, you include a project spec. You can also use shorthand notation to define cluster-init:
15
15
16
16
```ini
17
17
[cluster my-cluster]
@@ -35,18 +35,17 @@ Adding a `[[[cluster-init]]]` section to a node will include a project spec. Clu
35
35
36
36
```
37
37
38
-
Attribute values that begin with `$`are referencing parameters.
38
+
Attribute values that start with `$`reference parameters.
39
39
40
-
The order of the Project specs is respected as provided in the Cluster Template File. In this case `my-proj:default` will run first as it
41
-
comes from the node defaults, followed by `myproject:x.y.x`, and finally `my-proj:my-spec`.
40
+
The CycleCloud project specs run in the order you list them in the Cluster Template File. In this example, `my-proj:default` runs first because it comes from the node defaults. Next, `myproject:x.y.x` runs, and finally, `my-proj:my-spec` runs.
42
41
43
-
## Attribute Reference
42
+
## Attribute reference
44
43
45
44
Attribute | Type | Definition
46
45
------ | ----- | ----------
47
-
Project | String | Name of CycleCloud project.
48
-
Version | String | Version of CycleCloud project spec.
49
-
Spec | String | Name of CycleCloud project spec.
50
-
Locker | String | Name of locker from which to download project spec.
46
+
Project | String | Name of the CycleCloud project.
47
+
Version | String | Version of the CycleCloud project specification.
48
+
Spec | String | Name of the CycleCloud project specification.
49
+
Locker | String | Name of the locker to download the project specification from.
51
50
52
-
For projects contained in the CycleCloud project, Locker should be set to `cyclecloud`.
51
+
For projects in the CycleCloud project, set the `Locker` attribute to `cyclecloud`.
Copy file name to clipboardExpand all lines: articles/cyclecloud/cluster-references/cluster-reference.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,18 @@
2
2
title: Cluster Reference Docs
3
3
description: CycleCloud template reference for the Cluster section
4
4
author: adriankjohnson
5
-
ms.date: 05/31/2024
5
+
ms.date: 06/29/2025
6
6
ms.author: adjohnso
7
7
ms.custom: compute-evergreen
8
8
---
9
9
10
-
# Cluster Section
10
+
# Cluster section
11
11
12
-
A cluster template file must have at least one `[cluster]` section with an inline name attribute. This is the only required section of the file.
12
+
A cluster template file must have at least one `[cluster]` section with an inline name attribute. This section is the only required section of the file.
13
13
14
14
## Examples
15
15
16
-
Conventional cluster template files have a single cluster declaration.
16
+
Conventional cluster template files have a single cluster declaration.
17
17
18
18
```ini
19
19
[cluster my-cluster]
@@ -27,23 +27,23 @@ Conventional cluster template files have a single cluster declaration.
27
27
Credentials = $Credentials
28
28
```
29
29
30
-
## Attribute Reference
30
+
## Attribute reference
31
31
32
32
Attribute | Type | Definition
33
33
------ | ----- | ----------
34
-
Abstract | Boolean | Whether cluster definition is purely for child reference.
35
-
Autoscale | Boolean | Enable auto-start and stop on nodearrays
36
-
Category | String | Which category to display the cluster icon
37
-
CategoryOrder | Integer | Install to a directory other than /opt/cycle_server
38
-
FormLayout | String | "SelectionPanel" for a multi-panel display or "List" for a flat list of parameters. Defaults to "List" if not set.
39
-
IconUrl | URL | link to representative icon for cluster displayed in UI
40
-
MaxCount | Integer | To ensure that the cluster never exceeds 10 nodes you would specify a value of 10. Note that MaxCount and MaxCoreCount can be used together, in which case the lower effective constraint will take effect.
41
-
MaxCoreCount | Integer | To ensure that the cluster never exceeds 100 cores you would specify a value of 100. Note that MaxCount and MaxCoreCount can be used together, in which case the lower effective constraint will take effect.
34
+
Abstract | Boolean | Whether the cluster definition is purely for child reference.
35
+
Autoscale | Boolean | Enable auto-start and stop on node arrays.
36
+
Category | String | Which category to display the cluster icon.
37
+
CategoryOrder | Integer | Install to a directory other than `/opt/cycle_server`.
38
+
FormLayout | String | `"SelectionPanel"` for a multi-panel display or `"List"` for a flat list of parameters. Defaults to `"List"` if not set.
39
+
IconUrl | URL | Link to representative icon for cluster displayed in UI.
40
+
MaxCount | Integer | To ensure that the cluster never exceeds 10 nodes, specify a value of 10. You can use `MaxCount` and `MaxCoreCount`together. The lower effective constraint takes effect.
41
+
MaxCoreCount | Integer | To ensure that the cluster never exceeds 100 cores, enter 100. You can use MaxCount and MaxCoreCount together. The lower effective constraint takes effect.
42
42
ParentName | String | Assume properties of abstract parent cluster in the same cluster template file unless local override.
43
43
44
44
> [!NOTE]
45
45
> None of the cluster attributes are required.
46
46
47
-
## Subordinate Objects
47
+
## Subordinate objects
48
48
49
49
The cluster object has either `[[node]]` or `[[nodearray]]` as subordinate objects.
Copy file name to clipboardExpand all lines: articles/cyclecloud/cluster-references/cluster-template-reference.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,23 @@
2
2
title: Cluster Template Reference Overview
3
3
description: View reference information on cluster templates in Azure CycleCloud. See cluster template file hierarchy, object attributes, parameters, and template objects.
4
4
author: mvrequa
5
-
ms.date: 06/03/2024
5
+
ms.date: 06/29/2025
6
6
ms.author: mirequa
7
7
ms.topic: conceptual
8
8
ms.service: azure-cyclecloud
9
9
ms.custom: compute-evergreen
10
10
---
11
11
12
-
# CycleCloud Cluster Template File
12
+
# CycleCloud cluster template file
13
13
14
-
CycleCloud clusters are defined in declarative and hierarchical text files called templates. A number of example CycleCloud cluster templates are available for [download](~/articles/cyclecloud/download-cluster-templates.md)
14
+
You define CycleCloud clusters in declarative and hierarchical text files called templates. You can [download](~/articles/cyclecloud/download-cluster-templates.md) several example CycleCloud cluster templates.
15
15
16
16
> [!NOTE]
17
-
> The CycleCloud cluster template file is case insensitive throughout.
17
+
> The CycleCloud cluster template file is case insensitive.
18
18
19
-
## CycleCloud Cluster Template File Hierarchy
19
+
## CycleCloud cluster template file hierarchy
20
20
21
-
The cluster template file is organized into a hierarchical structure. Each section defines a primary object and the object's name appears in the section header (eg. `[cluster my-cluster]`). The number of square brackets represents the rank, with fewer brackets indicating higher rank. The top of the hierarchy, and the only required object in the Cluster Template file is the `[cluster]` object. The specific order of the sections is not important.
21
+
The cluster template file uses a hierarchical structure. Each section defines a primary object and includes the object's name in the section header (for example, `[cluster my-cluster]`). The number of square brackets shows the rank, with fewer brackets indicating higher rank. The top of the hierarchy, and the only required object in the cluster template file, is the `[cluster]` object. The specific order of the sections doesn't matter.
22
22
23
23
```template
24
24
[cluster]
@@ -35,15 +35,15 @@ The cluster template file is organized into a hierarchical structure. Each secti
35
35
[[[parameter]]]
36
36
```
37
37
38
-
A `[cluster]`may contain a `[[node]]`, which may contain a `[[[volume]]]`.
38
+
A `[cluster]`can contain a `[[node]]`, which can contain a `[[[volume]]]`.
39
39
40
40
A `[[[volume]]]` must be within a `[[node]]`, which must be within a `[cluster]`.
41
41
42
42
Many objects correspond to Azure resources. For example, `[[node]]` corresponds to Azure VM, `[[[volume]]]` corresponds to Azure Disk, and `[[[network-interface]]]` corresponds to Network Interface.
43
43
44
44
## Object Attributes
45
45
46
-
Each object may possess attributes which govern the object's behavior:
46
+
Each object can have attributes that control its behavior:
47
47
48
48
```ini
49
49
[[node my-node]]
@@ -53,7 +53,7 @@ Attribute2 = Value2
53
53
54
54
## Parameters
55
55
56
-
[Cluster Parameters](./parameter-reference.md) are variables set at cluster creation time. They can be used in the definition of any attribute.
56
+
[Cluster Parameters](./parameter-reference.md) are variables you set when you create a cluster. Use these parameters in the definition of any attribute.
57
57
58
58
```ini
59
59
[cluster MyCluster]
@@ -63,24 +63,23 @@ Attribute2 = Value2
63
63
DefaultValue = 200
64
64
```
65
65
66
-
The `$`is a special character to denote a parameter value by name.
66
+
The `$` character lets you specify a parameter value by name.
67
67
68
-
Parameters have properties both to define the type and to control how they are represented in the cluster UI selectors. Parameters are defined
69
-
at the time of cluster creation so they can either be set via command line parameter flag `-p parameter-file.json`, or by using the cluster UI.
68
+
Parameters have properties that define their type and control how the cluster UI selectors represent them. You define parameters when you create the cluster. You can set them by using the command line parameter flag `-p parameter-file.json` or the cluster UI.
70
69
71
70
### Special Parsing
72
71
73
-
The [template parser](./special-parsing.md)is capable of handling certain logic and special definitions and process functions of parameter values:
72
+
The [template parser](./special-parsing.md)can handle certain logic, special definitions, and process functions of parameter values:
0 commit comments