Skip to content

Commit 986bac1

Browse files
authored
Merge pull request #302005 from tfitzmac/0629edit1
copy edit
2 parents 43c815e + b0e021f commit 986bac1

10 files changed

+270
-284
lines changed

articles/cyclecloud/cluster-references/cluster-init-reference.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
title: Azure CycleCloud Cluster-Init Parameter Reference
33
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.
44
author: adriankjohnson
5-
ms.date: 05/31/2024
5+
ms.date: 06/29/2025
66
ms.author: adjohnso
77
ms.custom: compute-evergreen
88
---
99

1010
# Cluster-Init
1111

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.
1313

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:
1515

1616
``` ini
1717
[cluster my-cluster]
@@ -35,18 +35,17 @@ Adding a `[[[cluster-init]]]` section to a node will include a project spec. Clu
3535

3636
```
3737

38-
Attribute values that begin with `$` are referencing parameters.
38+
Attribute values that start with `$` reference parameters.
3939

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.
4241

43-
## Attribute Reference
42+
## Attribute reference
4443

4544
Attribute | Type | Definition
4645
------ | ----- | ----------
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.
5150

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`.

articles/cyclecloud/cluster-references/cluster-reference.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: Cluster Reference Docs
33
description: CycleCloud template reference for the Cluster section
44
author: adriankjohnson
5-
ms.date: 05/31/2024
5+
ms.date: 06/29/2025
66
ms.author: adjohnso
77
ms.custom: compute-evergreen
88
---
99

10-
# Cluster Section
10+
# Cluster section
1111

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.
1313

1414
## Examples
1515

16-
Conventional cluster template files have a single cluster declaration.
16+
Conventional cluster template files have a single cluster declaration.
1717

1818
``` ini
1919
[cluster my-cluster]
@@ -27,23 +27,23 @@ Conventional cluster template files have a single cluster declaration.
2727
Credentials = $Credentials
2828
```
2929

30-
## Attribute Reference
30+
## Attribute reference
3131

3232
Attribute | Type | Definition
3333
------ | ----- | ----------
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.
4242
ParentName | String | Assume properties of abstract parent cluster in the same cluster template file unless local override.
4343

4444
> [!NOTE]
4545
> None of the cluster attributes are required.
4646
47-
## Subordinate Objects
47+
## Subordinate objects
4848

4949
The cluster object has either `[[node]]` or `[[nodearray]]` as subordinate objects.

articles/cyclecloud/cluster-references/cluster-template-reference.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22
title: Cluster Template Reference Overview
33
description: View reference information on cluster templates in Azure CycleCloud. See cluster template file hierarchy, object attributes, parameters, and template objects.
44
author: mvrequa
5-
ms.date: 06/03/2024
5+
ms.date: 06/29/2025
66
ms.author: mirequa
77
ms.topic: conceptual
88
ms.service: azure-cyclecloud
99
ms.custom: compute-evergreen
1010
---
1111

12-
# CycleCloud Cluster Template File
12+
# CycleCloud cluster template file
1313

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.
1515

1616
> [!NOTE]
17-
> The CycleCloud cluster template file is case insensitive throughout.
17+
> The CycleCloud cluster template file is case insensitive.
1818
19-
## CycleCloud Cluster Template File Hierarchy
19+
## CycleCloud cluster template file hierarchy
2020

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.
2222

2323
``` template
2424
[cluster]
@@ -35,15 +35,15 @@ The cluster template file is organized into a hierarchical structure. Each secti
3535
[[[parameter]]]
3636
```
3737

38-
A `[cluster]` may contain a `[[node]]`, which may contain a `[[[volume]]]`.
38+
A `[cluster]` can contain a `[[node]]`, which can contain a `[[[volume]]]`.
3939

4040
A `[[[volume]]]` must be within a `[[node]]`, which must be within a `[cluster]`.
4141

4242
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.
4343

4444
## Object Attributes
4545

46-
Each object may possess attributes which govern the object's behavior:
46+
Each object can have attributes that control its behavior:
4747

4848
``` ini
4949
[[node my-node]]
@@ -53,7 +53,7 @@ Attribute2 = Value2
5353

5454
## Parameters
5555

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.
5757

5858
``` ini
5959
[cluster MyCluster]
@@ -63,24 +63,23 @@ Attribute2 = Value2
6363
DefaultValue = 200
6464
```
6565

66-
The `$` is a special character to denote a parameter value by name.
66+
The `$` character lets you specify a parameter value by name.
6767

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.
7069

7170
### Special Parsing
7271

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:
7473

7574
``` ini
7675
Attribute1 = ${ifThenElse(AccessSubnet !== undefined, AccessSubnet, ComputeSubnet)}
7776
```
7877

79-
The special parser is activated with the `${}` syntax.
78+
The `${}` syntax activates the special parser.
8079

81-
## Template Objects
80+
## Template objects
8281

83-
These are the currently supported template objects:
82+
The following template objects are currently supported:
8483

8584
* [**cluster**](./cluster-reference.md)
8685
* [**node, nodearray**](./node-nodearray-reference.md)

0 commit comments

Comments
 (0)