Configure Batch-only and Interactive-only AOS nodes in on-premises deployments

Article
06/19/2024

Important

This feature is supported starting in application update 10.0.12, Platform update 36.

This article explains how to configure your environment so that you can deploy batch-only and interactive-only Application Object Server (AOS) nodes.

To make this feature available, Microsoft has introduced two new Microsoft Azure Service Fabric node types. For batch-only AOS nodes, the new node type is BatchOnlyAOSNodeType. For interactive-only AOS nodes, the new node type is InteractiveOnlyAOSNodeType.

Note

The traditional deployment option, where an AOS node is interactive and is running batch jobs, is still supported and isn't affected by these changes.

Sizing

For sandbox environments, we recommend that you have at least two nodes of each type.

For production environments, there should be at least three nodes of each type.

New deployments

When you're describing your configuration as explained in Set up and deploy on-premises environments, edit the configtemplate.xml file to enable the new node types. When you are done, the template should resemble the following example.

<NodeType name="AOSNodeType" primary="false" namePrefix="AOS" purpose="AOS" disabled="true">
    <VMList>
        <VM name="aos1" ipAddress="" faultDomain="fd:/fd0" updateDomain="ud0" hasSSIS="false" />
        <VM name="aos2" ipAddress="" faultDomain="fd:/fd1" updateDomain="ud1" hasSSIS="false" />
        <VM name="aos3" ipAddress="" faultDomain="fd:/fd0" updateDomain="ud2" hasSSIS="false" />
    </VMList>
</NodeType>
<NodeType name="InteractiveOnlyAOSNodeType" primary="false" namePrefix="AOS" purpose="AOS" disabled="false">
    <VMList>
        <VM name="LBDE05FS1AOS01" ipAddress="192.168.5.51" faultDomain="fd:/fd0" updateDomain="ud0" hasSSIS="false" />
        <VM name="LBDE05FS1AOS02" ipAddress="192.168.5.52" faultDomain="fd:/fd1" updateDomain="ud1" hasSSIS="false" />
        <VM name="LBDE05FS1AOS03" ipAddress="192.168.5.53" faultDomain="fd:/fd0" updateDomain="ud2" hasSSIS="false" />
    </VMList>
</NodeType>
<NodeType name="BatchOnlyAOSNodeType" primary="false" namePrefix="AOS" purpose="AOS" disabled="false">
    <VMList>
        <VM name="LBDE05FS1AOS04" ipAddress="192.168.5.54" faultDomain="fd:/fd0" updateDomain="ud0" hasSSIS="false" />
        <VM name="LBDE05FS1AOS05" ipAddress="192.168.5.55" faultDomain="fd:/fd1" updateDomain="ud1" hasSSIS="false" />
        <VM name="LBDE05FS1AOS06" ipAddress="192.168.5.56" faultDomain="fd:/fd0" updateDomain="ud2" hasSSIS="false" />
    </VMList>
</NodeType>

Follow the remaining instructions in Set up and deploy on-premises environments in the usual way.

Existing deployments

Follow the instructions in Remove an AOS node up through the point where you save the configuration file.

Important

You must use option 1, "Use a configuration file (preferred option)." Do not use option 2.

Continue to edit the ClusterConfig.json file to add the new node types to the NodeTypes section. When you've finished, the NodeTypes section should resemble the following example.

"NodeTypes": [
    {
        "Name": "AOSNodeType",
        "PlacementProperties": {
            "IsAosEnabled": "True"
        },
        "ClientConnectionEndpointPort": 19000,
        "HttpGatewayEndpointPort": 19080,
        "ReverseProxyEndpointPort": 19081,
        "LeaseDriverEndpointPort": 19002,
        "ClusterConnectionEndpointPort": 19001,
        "ServiceConnectionEndpointPort": 19003,
        "ApplicationPorts": {
            "StartPort": 20001,
            "EndPort": 20031
        },
        "IsPrimary": false
    },
    {
        "Name": "BatchOnlyAOSNodeType",
        "PlacementProperties": {
            "IsAosEnabled": "True"
        },
        "ClientConnectionEndpointPort": 19000,
        "HttpGatewayEndpointPort": 19080,
        "ReverseProxyEndpointPort": 19081,
        "LeaseDriverEndpointPort": 19002,
        "ClusterConnectionEndpointPort": 19001,
        "ServiceConnectionEndpointPort": 19003,
        "ApplicationPorts": {
            "StartPort": 20001,
            "EndPort": 20031
        },
        "IsPrimary": false
    },
    {
        "Name": "InteractiveOnlyAOSNodeType",
        "PlacementProperties": {
            "IsAosEnabled": "True"
        },
        "ClientConnectionEndpointPort": 19000,
        "HttpGatewayEndpointPort": 19080,
        "ReverseProxyEndpointPort": 19081,
        "LeaseDriverEndpointPort": 19002,
        "ClusterConnectionEndpointPort": 19001,
        "ServiceConnectionEndpointPort": 19003,
        "ApplicationPorts": {
            "StartPort": 20001,
            "EndPort": 20031
        },
        "IsPrimary": false
    },
    ...
]

Continue to follow the instructions in Remove an AOS node from the point where you stopped until you've finished removing the nodes from your cluster.
On the machines that you've removed from the Service Fabric cluster, follow these steps:
1. Delete the contents of your Service Fabric data root (C:\ProgramData\SF) and your Service Fabric log root (C:\ProgramData\SF\Log).
2. Copy or download the standalone package for Service Fabric for Windows Server to the virtual machine (VM) or machine.
3. Unzip the package (C:\Temp\ServiceFabricStandalone).
4. Open Windows PowerShell as an admin.
5. Run the following commands.
  
  Important
  
  Replace parameters as appropriate for your machine configuration.
```
cd C:\Temp\ServiceFabricStandalone
.\AddNode.ps1 -NodeName AOS_12 -NodeType BatchOnlyAOSNodeType -NodeIpAddressOrFQDN 192.168.5.12 -ExistingClientConnectionEndpoint 192.168.5.21:19000 -UpgradeDomain ud0 -FaultDomain fd:/fd0 -X509Credential -ServerCertThumbprint 1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A -AcceptEULA -StoreLocation LocalMachine -StoreName MY -FindValueThumbprint 1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A1A
```
  Note
  
  When the node first reappears in Service Fabric Explorer, it might show the old node type. However, it should show the updated node type after a few minutes.

Query the Service Fabric cluster again for the ClusterConfig.json file.

Get-ServiceFabricClusterConfiguration -UseApiVersion -ApiVersion 10-2017 > C:\Temp\ClusterConfig.json

In the fabricSettings section, remove the NodesToBeRemoved parameter. When you've finished, the fabricSettings section should resemble the following example.

"fabricSettings": [
    {
        "name": "Setup",
        "parameters": [
            {
                "name": "FabricDataRoot",
                "value": "C:\\\\ProgramData\\\\SF"
            },
            {
                "name": "FabricLogRoot",
                "value": "C:\\\\ProgramData\\\\SF\\\\Log"
            }
        ]
    }
]

Remove the following lines from the Security section.
```
"WindowsIdentities": {
    "\$id": "3"
},
```
Note

If you don't remove these lines, you will receive the following error message later:

ValidationException: Authentication type can't be changed from unsecured to Windows.
Increment the version number of the configuration file. Make this change at the lowest increment. In the following example, the version number went from 1.0.1 to 1.0.2.
```
"ClusterConfigurationVersion": "1.0.2"
```
Save the configuration file.

Open Windows PowerShell as an admin, and run the following commands.

Connect-ServiceFabricCluster
Start-ServiceFabricClusterConfigurationUpgrade -ClusterConfigPath C:\Temp\ClusterConfig.json
Update-ServiceFabricClusterUpgrade -UpgradeReplicaSetCheckTimeoutSec 30

To monitor the upgrade, you can run the following command.
```
Get-ServiceFabricClusterUpgrade
```
Once the upgrade is finished from LCS use the Update Settings button without changing any settings to trigger an environment refresh. Alternatively you could also apply the latest hotfix.

Important

This step causes downtime so be sure that your environment can be unavailable for some time.

Share via

Configure Batch-only and Interactive-only AOS nodes in on-premises deployments

Sizing

New deployments

Existing deployments

Feedback

Additional resources