Skip to content

Commit 860f9bc

Browse files
authored
Freshness review pass (#382)
* Freshness Review Pass " to indicate that they are markdown. If you have any specific details or requirements related to your pull request, please provide them and I can assist you further. * Updated the ms.date for freshness review pass * Update node-nodearray-reference.md * Update node-nodearray-reference.md * Freshness Review Pass * Update volume-reference.md * Update api.md * Freshness Review Pass * Freshness Review Pass * Fresh * Freshness Review Pass * Fixing * Fixing the referenced link path * Update node-nodearray-reference.md * Update special-parsing.md * Removed CycleCloud-7 references
1 parent 5ff5813 commit 860f9bc

File tree

8 files changed

+13
-73
lines changed

8 files changed

+13
-73
lines changed

articles/cyclecloud/api.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,18 @@ title: API Reference
33
description: Read the Azure CycleCloud REST API Reference. Review commands for operations and resources, such as getting cluster nodes or getting the status of the cluster.
44
author: adriankjohnson
55
ms.topic: reference
6-
ms.date: 02/08/2018
6+
ms.date: 7/15/2024
77
ms.author: adjohnso
8-
monikerRange: '>= cyclecloud-7'
8+
monikerRange: '>= cyclecloud-8'
99
---
1010
# Operations
1111

12-
::: moniker range="cyclecloud-7"
13-
[!INCLUDE [operations](~/includes/version-7/api_operations.md)]
14-
::: moniker-end
1512
::: moniker range=">= cyclecloud-8"
1613
[!INCLUDE [operations](~/includes/version-8/api_operations.md)]
1714
::: moniker-end
1815

19-
# Resources
16+
## Resources
2017

21-
::: moniker range="cyclecloud-7"
22-
[!INCLUDE [resources](./includes/version-7/api_resources.md)]
23-
::: moniker-end
2418
::: moniker range=">= cyclecloud-8"
2519
[!INCLUDE [resources](./includes/version-8/api_resources.md)]
2620
::: moniker-end

articles/cyclecloud/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure CycleCloud CLI Reference
33
description: CycleCloud CLI reference
44
author: rokeptne
5-
ms.date: 03/27/2023
5+
ms.date: 07/15/2024
66
ms.author: rokeptne
77
---
88

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Cluster Template Reference - Nodes
33
description: Attributes for nodes and nodearrays within cluster templates for use with Azure CycleCloud
44
author: adriankjohnson
5-
ms.date: 03/27/2023
5+
ms.date: 07/15/2024
66
ms.author: adjohnso
77
---
88

@@ -92,15 +92,15 @@ PlacementGroupId | String | If set, this label is used to place this node in a s
9292
KeyPairLocation | Integer | Where CycleCloud will find a SSH keypair on the local filesystem
9393
KeepAlive | Boolean | If true, CycleCloud will prevent the termination of this node
9494
Locker | String | Specify the name of the locker from which to download project specs. See [Use Projects](~/how-to/projects.md)
95-
BootDiagnosticsUri | String | Storage URI for boot diagnostics (example: https://mystorageaccount.blob.core.windows.net), if specified. Storage charges will apply.
95+
BootDiagnosticsUri | String | Storage URI for boot diagnostics (example: https://mystorageaccount.blob.core.windows.net/), if specified. Storage charges will apply.
9696
HybridBenefit | Boolean | If true, enables "Azure Hybrid Benefit" licensing for Windows VMs
9797
EnableTerminateNotification (8.2.0+) | Boolean | If true, enables [Terminate Notification](/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-terminate-notification) to send events on VM deletion to the VM for local handling. This only applies to scaleset VMs.
9898
TerminateNotificationTimeout (8.2.2+) | Relative Time | If terminate-notification is enabled, this controls how long VMs are given to handle the event before being deleted.
9999
ThrottleCapacity (8.2.2+) | Boolean | If true, this nodearray will report 0 capacity to autoscalers for a default of 5 minutes after encountering a capacity issue
100100
ThrottleCapacityTime (8.2.2+) | Relative Time | If `ThrottleCapacity` is enabled, this is how long to report 0 availability after capacity is constrained. Default is "5m".
101101
HybridBenefitLicense (8.3.0+)| String | If `HybridBenefit` is true, this specifies the license to use: `RHEL_BYOS`, `SLES_BYOS`, or `Windows_Server`. Default is `Windows_Server`.
102102
FlexScaleSetId (8.3.0+) | String | If set, this is the fully qualified id of a scaleset in [Flex orchestration mode](../how-to/flex-scalesets.md) that is used for the VM for this node.
103-
EncryptionAtHost (8.4.0+) | Boolean | If true, the virtual machine will have [Encryption At Host](https://learn.microsoft.com/azure/virtual-machines/disk-encryption) enabled.
103+
EncryptionAtHost (8.4.0+) | Boolean | If true, the virtual machine will have [Encryption At Host](/azure/virtual-machines/disk-encryption) enabled.
104104
SecurityType (8.5.0+) | String | Sets the [security type](../how-to/vm-security.md); either undefined, `TrustedLaunch` or `ConfidentialVM`
105105
| EnableSecureBoot (8.5.0+) | Boolean | Enables [Secure Boot](../how-to/vm-security.md), if using Trusted Launch VMs or Confidential VMs.
106106
| EnableVTPM (8.5.0+) | Boolean | Enables [Virtual Trusted Platform Module](../how-to/vm-security.md), if using Trusted Launch VMs or Confidential VMs.

articles/cyclecloud/cluster-references/special-parsing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Special Parsing for Parameters
33
description: Read about special parsing for parameters. Azure CycleCloud is able to resolve parameter values and perform logical evaluation of functions.
44
author: mvrequa
5-
ms.date: 03/10/2020
5+
ms.date: 07/15/2024
66
ms.author: mirequa
77
---
88

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

Lines changed: 1 addition & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
title: Cluster Template Reference - Volumes
33
description: Read reference material for including volumes in cluster templates to be used with Azure CycleCloud. A volume represents an Azure Disk.
44
author: adriankjohnson
5-
ms.date: 06/20/2023
5+
ms.date: 07/15/2024
66
ms.author: adjohnso
77
ms.topic: conceptual
88
ms.service: cyclecloud
9-
ms.custom: compute-evergreen
109
---
1110

1211
# Volumes
@@ -17,27 +16,6 @@ ms.custom: compute-evergreen
1716

1817
Adding a `[[[volume]]]` section to a node will create an Azure Disk and attach it to the VM.
1918

20-
::: moniker range="=cyclecloud-7"
21-
``` ini
22-
[cluster my-cluster]
23-
[[node my-node]]
24-
Credentials = $Credentials
25-
SubnetId = $SubnetId
26-
MachineType = $MachineType
27-
ImageName = $ImageName
28-
29-
[[[volume my-volume]]]
30-
Size = 500
31-
32-
[[[volume another-volume]]]
33-
Size = 1024
34-
SSD = true
35-
36-
[[[volume data]]]
37-
VolumeId = /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/my-rg/providers/Microsoft.Compute/disks/datadisk
38-
```
39-
::: moniker-end
40-
4119
::: moniker range=">=cyclecloud-8"
4220
``` ini
4321
[cluster my-cluster]
@@ -61,24 +39,6 @@ Adding a `[[[volume]]]` section to a node will create an Azure Disk and attach i
6139

6240
Attribute values that begin with `$` are referencing parameters.
6341

64-
## Attribute Reference
65-
66-
::: moniker range="=cyclecloud-7"
67-
Attribute | Type | Definition
68-
------ | ----- | ----------
69-
Size | String | (Required) Size of disk in GB
70-
VolumeId | String | Resource ID for existing Azure Disk.
71-
SSD | Boolean | If true, use premium disk sku. Otherwise, use standard disk. Default: `false`.
72-
Azure.Lun | Integer | Override the auto-assigned LUN ID.
73-
Mount | String | Name of mount construct, described in `configuration` object
74-
Azure.Caching | String | [none, readonly, readwrite] Default: `none`.
75-
Persistent | Boolean | If false, disk will be deleted when VM is deleted. Default: `false`.
76-
Disabled | Boolean | If true, this volume will be ignored. Default: `false`.
77-
SourceUri | String | URI of blob to import into managed disk.
78-
StorageAccountId | String | Azure resource ID of storage account containing SourceUri blob. Required if blob is in a different subscription.
79-
SourceResourceId | String | Azure resource ID of source snapshot or managed disk.
80-
::: moniker-end
81-
8242
::: moniker range=">=cyclecloud-8"
8343
Attribute | Type | Definition
8444
------ | ----- | ----------
@@ -104,20 +64,6 @@ Azure.Encryption.DiskEncryptionSetId | String | Deprecated. Use `DiskEncryptionS
10464
::: moniker-end
10565

10666
### Boot Volume
107-
::: moniker range="=cyclecloud-7"
108-
For each node, the volume named `boot` exposes some advanced configuration of the OS boot volume.
109-
110-
``` ini
111-
[[node scheduler]]
112-
[[[volume boot]]]
113-
Size = 100
114-
SSD = true
115-
Azure.Caching = ReadOnly
116-
```
117-
118-
>[!NOTE]
119-
>This section is ignored if EphemeralOSDisk is set.
120-
::: moniker-end
12167

12268
::: moniker range=">=cyclecloud-8"
12369
For each node, the volume named `boot` exposes some advanced configuration of the OS boot volume. Storage type settings for the boot disk are ignored if `EphemeralOSDisk=true` is specified for the node.

articles/cyclecloud/cycleserver-configuration-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: CycleServer Configuration Reference
33
description: Configuration reference for cycle_server.properties file
44
author: atomic-penguin
5-
ms.date: 05/13/2020
5+
ms.date: 07/15/2024
66
ms.author: erwolfe
77
---
88

@@ -28,7 +28,7 @@ CycleCloud uses the _cycle_server.properties_ file to pass configuration paramet
2828
| webServerEnableHttps | Boolean | Enable HTTPS listen port. | `false` |
2929
| webServerRedirectHttp | Boolean | If both HTTPS and HTTP is enabled, controls whether HTTP redirects to HTTPS. | `true` |
3030
| webServerUseNativeHttps | Boolean | Improves HTTPS performance on Linux platforms by using Tomcat's native HTTPS implementation. `webServerEnableHttps` must also be `true`. | `false` |
31-
| sslEnabledProtocols | String | List of `+` separated TLS protocols to allow. e.g. `TLSv1.0+TLSv1.1+TLSv1.2` | `TLSv1.2` |
31+
| sslEnabledProtocols | String | List of `+` separated TLS protocols to allow. e.g. `TLSv1.2+TLSv1.3` | `TLSv1.3` |
3232
| brokerMaxHeapSize | String | This is a JVM maximum heap size setting for the message queue broker. | Linux: `1024M`; Windows: `512M` |
3333
| brokerJvmOptions | String | This setting is provided for any user configurable JVM settings for the message queue broker. CycleServer only appends the message broker heap size, and port, options. | None |
3434
| brokerPort | Integer | Listen port for the message queue broker. | `5672` |

articles/cyclecloud/jetpack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Jetpack Reference
33
description: Read reference information about the Jetpack tool in Azure CycleCloud. Jetpack provides node configuration, distributed synchronization, and HealthCheck.
44
author: staer
5-
ms.date: 01/06/2020
5+
ms.date: 07/15/2024
66
ms.author: adjohnso
77
---
88

articles/cyclecloud/python-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Python API
33
description: Use the Azure CycleCloud Python API to interact with the CycleCloud REST API without having to perform HTTP requests manually.
44
author: rokeptne
5-
ms.date: 07/16/2019
5+
ms.date: 07/15/2024
66
ms.author: rokeptne
77
---
88

0 commit comments

Comments
 (0)