Skip to content

Commit a1e83de

Browse files
Jak-MSJak-MS
authored
Merge pull request #114802 from a-santamaria/sfmc_ext_BeforeSFRuntime2
Add How to provision extension before Service Fabric runtime
2 parents b430d41 + 51bc3d7 commit a1e83de

File tree

1 file changed

+82
-10
lines changed

1 file changed

+82
-10
lines changed

‎articles/service-fabric/how-to-managed-cluster-vmss-extension.md

Lines changed: 82 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ ms.date: 07/11/2022
1414
Each node type in a Service Fabric managed cluster is backed by a virtual machine scale set. This enables you to add [virtual machine scale set extensions](../virtual-machines/extensions/overview.md) to your Service Fabric managed cluster node types. Extensions are small applications that provide post-deployment configuration and automation on Azure VMs. The Azure platform hosts many extensions covering VM configuration, monitoring, security, and utility applications. Publishers take an application, wrap it into an extension, and simplify the installation. All you need to do is provide mandatory parameters.
1515

1616
## Add a virtual machine scale set extension
17+
1718
You can add a virtual machine scale set extension to a Service Fabric managed cluster node type using the [Add-AzServiceFabricManagedNodeTypeVMExtension](/powershell/module/az.servicefabric/add-azservicefabricmanagednodetypevmextension) PowerShell command.
1819

1920
Alternately, you can add a virtual machine scale set extension on a Service Fabric managed cluster node type in your Azure Resource Manager template, for example:
@@ -29,22 +30,21 @@ Alternately, you can add a virtual machine scale set extension on a Service Fabr
2930
"location": "[resourceGroup().location]",
3031
"properties": {
3132
"isPrimary": true,
32-
"vmInstanceCount": 3,
33-
"dataDiskSizeGB": 100,
34-
"vmSize": "Standard_D2",
35-
"vmImagePublisher": "MicrosoftWindowsServer",
36-
"vmImageOffer": "WindowsServer",
37-
"vmImageSku": "2019-Datacenter",
38-
"vmImageVersion": "latest",
33+
...
3934
"vmExtensions": [
4035
{
41-
"name": "ExtensionA",
36+
"name": "KvExtension",
4237
"properties": {
43-
"publisher": "ExtensionA.Publisher",
38+
"publisher": "Microsoft.Azure.KeyVault",
4439
"type": "KeyVaultForWindows",
45-
"typeHandlerVersion": "1.0",
40+
"typeHandlerVersion": "3.0",
4641
"autoUpgradeMinorVersion": true,
4742
"settings": {
43+
"secretsManagementSettings": {
44+
"observedCertificates": [
45+
...
46+
]
47+
}
4848
}
4949
}
5050
}
@@ -55,6 +55,78 @@ Alternately, you can add a virtual machine scale set extension on a Service Fabr
5555

5656
For more information on configuring Service Fabric managed cluster node types, see [managed cluster node type](/azure/templates/microsoft.servicefabric/2022-01-01/managedclusters/nodetypes).
5757

58+
## How to provision before Service Fabric runtime
59+
To provision extensions before the Service Fabric runtime starts, you can use the `setupOrder` parameter with the value `BeforeSFRuntime` in the extension properties for each extension as needed. This allows you to set up the environment and dependencies before the runtime and applications begin running on the node. See the example below for clarification:
60+
61+
>[!NOTE]
62+
> It's essential to note that if an extension marked with `BeforeSFRuntime` fails, it will prevent the Service Fabric runtime from starting. Consequently, the node will be down from the Service Fabric perspective. Therefore, it is crucial to maintain these extensions with correct configurations and promptly address any issues that may arise to ensure the health of nodes within the cluster.
63+
64+
### Requirements
65+
Use Service Fabric API version `2023-09-01-preview` or later.
66+
67+
### ARM Template example:
68+
```json
69+
{
70+
"type": "Microsoft.ServiceFabric/managedclusters/nodetypes",
71+
"apiVersion": "2023-09-01-preview",
72+
"name": "[concat(parameters('clusterName'), '/', parameters('nodeTypeName'))]",
73+
"properties": {
74+
"isPrimary": true,
75+
...
76+
"vmExtensions": [
77+
{
78+
"name": "KvExtension",
79+
"properties": {
80+
"setupOrder": [
81+
"BeforeSFRuntime"
82+
],
83+
"provisionAfterExtensions" [ "GenevaMonitoringExtension" ],
84+
"publisher": "Microsoft.Azure.KeyVault",
85+
"type": "KeyVaultForWindows",
86+
"typeHandlerVersion": "3.0",
87+
"autoUpgradeMinorVersion": true,
88+
"settings": {
89+
"secretsManagementSettings": {
90+
"observedCertificates": [
91+
...
92+
]
93+
}
94+
}
95+
}
96+
},
97+
{
98+
"name": "GenevaMonitoringExtension",
99+
"properties": {
100+
"setupOrder": [
101+
"BeforeSFRuntime"
102+
],
103+
"autoUpgradeMinorVersion": true,
104+
"enableAutomaticUpgrade": true,
105+
"publisher": "Microsoft.Azure.Geneva",
106+
"type": "GenevaMonitoring",
107+
"typeHandlerVersion": "2.40",
108+
"settings": {
109+
"configurations": [
110+
{
111+
"ServiceArguments": {
112+
...
113+
},
114+
"UserArguments": {
115+
...
116+
}
117+
}
118+
]
119+
}
120+
}
121+
}
122+
]
123+
}
124+
}
125+
```
126+
127+
>[!NOTE]
128+
> Special handling for AzureDiskEncryption (ADE) extension: ADE needs to run before the Service Fabric runtime to ensures that the disk is decrypted after a reimage operations, allowing the Service Fabric runtime to start using it. Even if the extension is not explicitly marked with `BeforeSFRuntime`, it will run before the runtime. But note that enabling encryption at host is recommended over using ADE extension. For detailed instructions, refer to [Enable encryption at host](how-to-managed-cluster-enable-disk-encryption.md#enable-encryption-at-host).
129+
58130
## Next steps
59131

60132
To learn more about Service Fabric managed clusters, see:

0 commit comments

Comments
 (0)