Skip to content

Commit 1ee3475

Browse files
tfitzmactfitzmac
committed
copy edit
1 parent 949242a commit 1ee3475

File tree

6 files changed

+167
-177
lines changed

6 files changed

+167
-177
lines changed

‎articles/cyclecloud/includes/cloud-shell-try-it.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Azure Cloud Shell is a free, interactive shell that you can use to run the steps in this article. Common Azure tools are preinstalled and configured in Cloud Shell for you to use with your account. Just select the **Copy** button to copy the code, paste it in Cloud Shell, and then press Enter to run it. There are a few ways to open Cloud Shell:
55

6-
| Click the green "Try It" button in the upper right corner of a code block. | ![Cloud Shell in this article](~/articles/cyclecloud/images/cli-try-it.png) |
6+
| Select the green **Try It** button in the upper-right corner of a code block. | ![Cloud Shell in this article](~/articles/cyclecloud/images/cli-try-it.png) |
77
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
88
| Open Cloud Shell in your browser. | [![Launch Cloud Shell](https://shell.azure.com/images/launchcloudshell.png "Launch Cloud Shell")](https://shell.azure.com/bash) |
99
| Select the **Cloud Shell** button on the menu in the upper-right corner of the [Azure portal](https://portal.azure.com). | ![Cloud Shell in the portal](~/articles/cyclecloud/images/cloud-shell-menu.png) |

‎articles/cyclecloud/includes/scheduler-integration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ CycleCloud supports a standard set of autostop attributes across schedulers:
22

33
| Attribute | Description |
44
| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
5-
| cyclecloud.cluster.autoscale.stop_enabled | Is autostop enabled on this node? [true/false] |
6-
| cyclecloud.cluster.autoscale.idle_time_after_jobs | The amount of time (in seconds) for a node to sit idle after completing jobs before it is scaled down. |
7-
| cyclecloud.cluster.autoscale.idle_time_before_jobs | The amount of time (in seconds) for a node to sit idle before completing jobs before it is scaled down. |
5+
| cyclecloud.cluster.autoscale.stop_enabled | Enables autostop on this node. [true/false] |
6+
| cyclecloud.cluster.autoscale.idle_time_after_jobs | The amount of time (in seconds) for a node to sit idle after completing jobs before it autostops. |
7+
| cyclecloud.cluster.autoscale.idle_time_before_jobs | The amount of time (in seconds) for a node to sit idle before completing jobs before it autostops. |

‎articles/cyclecloud/includes/version-7/api-operations.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ GET /clusters/{cluster}/nodes
1212
|Type|Name|Description|Schema|
1313
|---|---|---|---|
1414
|**Path**|**cluster** <br>*required*|The cluster to query|string|
15-
|**Query**|**operation** <br>*optional*|If given, returns only the nodes for this operation id, and includes the operation attribute on the body|string|
16-
|**Query**|**request_id** <br>*optional*|If given, returns only the nodes for the operation identified by this request id,<br> and includes the operation attribute on the body|string|
15+
|**Query**|**operation** <br>*optional*|If given, returns only the nodes for this operation ID, and includes the operation attribute on the body|string|
16+
|**Query**|**request_id** <br>*optional*|If given, returns only the nodes for the operation identified by this request ID,<br> and includes the operation attribute on the body|string|
1717

1818

1919
### Responses
@@ -25,8 +25,6 @@ GET /clusters/{cluster}/nodes
2525
|**404**|Not found|No Content|
2626

2727

28-
29-
3028
### Example HTTP request
3129

3230
#### Request path
@@ -57,15 +55,15 @@ POST /clusters/{cluster}/nodes/create
5755

5856

5957
### Description
60-
This operation adds new nodes from a nodearray to a cluster. It accepts multiple node definitions in a single call. It returns the URL to the operation that can be used to track the status of the operation.
58+
This operation adds new nodes from a node array to a cluster. It accepts multiple node definitions in a single call. It returns the URL to the operation that you can use to track the status of the operation.
6159

6260

6361
### Parameters
6462

6563
|Type|Name|Description|Schema|
6664
|---|---|---|---|
6765
|**Path**|**cluster** <br>*required*|The cluster to add nodes to|string|
68-
|**Body**|**nodes** <br>*required*|Sets of nodes to be created|[NodeCreationRequest](#nodecreationrequest)|
66+
|**Body**|**nodes** <br>*required*|Sets of nodes to create|[NodeCreationRequest](#nodecreationrequest)|
6967

7068

7169
### Responses
@@ -114,14 +112,14 @@ POST /clusters/{cluster}/nodes/deallocate
114112

115113

116114
### Description
117-
This operation deallocates nodes in a cluster. The nodes can be identified in several ways, including node name, node id, or by filter.
115+
This operation deallocates nodes in a cluster. You can identify the nodes by using several methods, including node name, node ID, or a filter.
118116

119117

120118
### Parameters
121119

122120
|Type|Name|Description|Schema|
123121
|---|---|---|---|
124-
|**Path**|**cluster** <br>*required*|The cluster to deallocate nodes in|string|
122+
|**Path**|**cluster** <br>*required*|The cluster where you want to deallocate nodes|string|
125123
|**Body**|**action** <br>*required*|Description of which nodes to deallocate|[NodeManagementRequest](#nodemanagementrequest)|
126124

127125

@@ -175,14 +173,14 @@ POST /clusters/{cluster}/nodes/remove
175173

176174

177175
### Description
178-
This operation removes nodes in a cluster. The nodes can be identified in several ways, including node name, node id, or by filter. Note that by default nodes are removed when terminated (unless the node has Fixed set to true), in which case this call is no different than terminate.
176+
This operation removes nodes in a cluster. You can identify the nodes in several ways, including node name, node ID, or by using a filter. By default, nodes are removed when terminated unless the node has the **Fixed** property set to true. In that case, this call acts the same as terminate.
179177

180178

181179
### Parameters
182180

183181
|Type|Name|Description|Schema|
184182
|---|---|---|---|
185-
|**Path**|**cluster** <br>*required*|The cluster to remove nodes in|string|
183+
|**Path**|**cluster** <br>*required*|The cluster where you want to remove nodes|string|
186184
|**Body**|**action** <br>*required*|Description of which nodes to remove|[NodeManagementRequest](#nodemanagementrequest)|
187185

188186

@@ -236,15 +234,15 @@ POST /clusters/{cluster}/nodes/shutdown
236234

237235

238236
### Description
239-
This operation terminates or deallocates nodes in a cluster, depending on whether the ShutdownPolicy attribute on each node is Terminate (the default) or Deallocate, respectively.
237+
This operation terminates or deallocates nodes in a cluster. The operation uses the `ShutdownPolicy` attribute on each node to determine the action. If the attribute is set to `Terminate` (the default), the operation terminates the node. If the attribute is set to `Deallocate`, the operation deallocates the node.
240238

241239

242240
### Parameters
243241

244242
|Type|Name|Description|Schema|
245243
|---|---|---|---|
246-
|**Path**|**cluster** <br>*required*|The cluster to shutdown nodes in|string|
247-
|**Body**|**action** <br>*required*|Description of which nodes to shutdown|[NodeManagementRequest](#nodemanagementrequest)|
244+
|**Path**|**cluster** <br>*required*|The cluster where you want to shut down nodes|string|
245+
|**Body**|**action** <br>*required*|Description of which nodes to shut down|[NodeManagementRequest](#nodemanagementrequest)|
248246

249247

250248
### Responses
@@ -297,7 +295,7 @@ POST /clusters/{cluster}/nodes/start
297295

298296

299297
### Description
300-
This operation starts nodes in a cluster. The nodes can be identified in several ways, including node name, node id, or by filter.
298+
This operation starts nodes in a cluster. You can identify the nodes by node name, node ID, or by using a filter.
301299

302300

303301
### Parameters
@@ -358,14 +356,14 @@ POST /clusters/{cluster}/nodes/terminate
358356

359357

360358
### Description
361-
This operation terminates nodes in a cluster. The nodes can be identified in several ways, including node name, node id, or by filter.
359+
This operation terminates nodes in a cluster. You can identify the nodes in several ways, including node name, node ID, or by using a filter.
362360

363361

364362
### Parameters
365363

366364
|Type|Name|Description|Schema|
367365
|---|---|---|---|
368-
|**Path**|**cluster** <br>*required*|The cluster to terminate nodes in|string|
366+
|**Path**|**cluster** <br>*required*|The cluster where you want to terminate nodes|string|
369367
|**Body**|**action** <br>*required*|Description of which nodes to terminate|[NodeManagementRequest](#nodemanagementrequest)|
370368

371369

@@ -419,17 +417,17 @@ POST /clusters/{cluster}/scale/{nodearray}
419417

420418

421419
### Description
422-
This operation adds nodes as needed to a nodearray to hit a total count. The request is processed one time, and does not re-add nodes later to maintain the given number. This scales by either total cores or total nodes, but not both. It returns the URL to the operation that can be used to track the status of the operation.
420+
This operation adds nodes as needed to a node array to reach a total count. The cluster processes the request one time. It doesn't re-add nodes later to maintain the number. You can scale the cluster by either total cores or total nodes, but not both. The operation returns the URL that you can use to track the status of the operation.
423421

424422

425423
### Parameters
426424

427425
|Type|Name|Description|Schema|
428426
|---|---|---|---|
429427
|**Path**|**cluster** <br>*required*|The cluster to add nodes to|string|
430-
|**Path**|**nodearray** <br>*required*|The nodearray to add nodes to|string|
431-
|**Query**|**totalCoreCount** <br>*optional*|The total number of cores to have in this nodearray, including nodes already created|integer|
432-
|**Query**|**totalNodeCount** <br>*optional*|The total number of machines to have in this nodearray, including nodes already created|integer|
428+
|**Path**|**nodearray** <br>*required*|The node array to add nodes to|string|
429+
|**Query**|**totalCoreCount** <br>*optional*|The total number of cores in this node array, including nodes you already created|integer|
430+
|**Query**|**totalNodeCount** <br>*optional*|The total number of machines in this node array, including nodes you already created|integer|
433431

434432

435433
### Responses
@@ -469,15 +467,15 @@ GET /clusters/{cluster}/status
469467

470468

471469
### Description
472-
This operation contains information for the nodes and nodearrays in a given cluster. For each nodearray, it returns the status of each "bucket" of allocation that can be used, such as how many nodes are in the bucket, how many more can be added, etc. Each bucket is a set of possible VMs of a given hardware profile, that can be created in a given location, under a given customer account, etc. The valid buckets for a nodearray are determined by the user's cluster definition, but the limits are determined in part by the cloud provider.
470+
This operation returns information for the nodes and node arrays in a cluster. For each node array, it returns the status of each "bucket" of allocation that you can use. The status shows how many nodes are in the bucket, how many more nodes you can add, and other details. Each bucket is a set of possible VMs with a specific hardware profile. You can create these VMs in a specific location under a customer account. The user's cluster definition determines the valid buckets for a node array. The cloud provider determines the limits for these buckets.
473471

474472

475473
### Parameters
476474

477475
|Type|Name|Description|Schema|
478476
|---|---|---|---|
479477
|**Path**|**cluster** <br>*required*|The cluster to query|string|
480-
|**Query**|**nodes** <br>*optional*|If true, nodes and node references are returned in the response|boolean|
478+
|**Query**|**nodes** <br>*optional*|If true, the response includes nodes and node references|boolean|
481479

482480

483481
### Responses
@@ -523,7 +521,7 @@ GET /operations/
523521

524522
|Type|Name|Description|Schema|
525523
|---|---|---|---|
526-
|**Query**|**request_id** <br>*optional*|The request ID for the operation. If this is given, the list will only have 0 or 1 element in it.|string|
524+
|**Query**|**request_id** <br>*optional*|The request ID for the operation. If you provide this ID, the list has zero or one element.|string|
527525

528526

529527
### Responses
@@ -557,7 +555,7 @@ GET /operations/
557555

558556

559557
<a name="operations_getstatus"></a>
560-
## Gets operation status by id
558+
## Gets operation status by ID
561559
```
562560
GET /operations/{id}
563561
```

0 commit comments

Comments
 (0)