Skip to content

Deployer Command‐line Options

Matt McLoughlin edited this page Mar 10, 2024 · 19 revisions

The Cromwell on Azure deployer supports several command-line options, categorized into required and optional parameters below. For a deeper dive into the source code, you can refer to the configuration section here.

Required Parameters

Name Default Value Example Value
MainIdentifierPrefix coa coa
SubscriptionId 12345678-1234-1234-1234-1234567890ab
RegionName eastus
HelmBinaryPath If Windows: C:\ProgramData\chocolatey\bin\helm.exe
If Unix-like: /usr/local/bin/helm
Windows: C:\ProgramData\chocolatey\bin\helm.exe
Unix-like: /usr/local/bin/helm

Optional Parameters

If there is no default value, it will be automatically generated or selected.

Name Default Value Example Value
AzureCloudName AzureCloud AzureCloud, AzureUSGovernment, AzureChinaCloud
ResourceGroupName myResourceGroup
IdentityResourceId /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}
BatchAccountName myBatchAccount
StorageAccountName mystorageaccount
LogAnalyticsArmId /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
ApplicationInsightsAccountName myAppInsightsAccount
KeyVaultName myKeyVault
VnetAddressSpace 10.1.0.0/16 10.1.0.0/16
VmSubnetAddressSpace 10.1.0.0/24 10.1.0.0/24
PostgreSqlSubnetAddressSpace 10.1.1.0/24 10.1.1.0/24
KubernetesServiceCidr 10.1.4.0/22 10.1.4.0/22
KubernetesDnsServiceIP 10.1.4.10 10.1.4.10
KubernetesDockerBridgeCidr 172.17.0.1/16 172.17.0.1/16
BatchNodesSubnetAddressSpace 10.1.128.0/17 10.1.128.0/17
VnetResourceGroupName myVnetResourceGroup
VnetName myVnet
SubnetName mySubnet
VmSubnetName myVmSubnet
PostgreSqlSubnetName myPostgreSqlSubnet
BatchSubnetName myBatchSubnet
BatchNodesSubnetId /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}
DisableBatchNodesPublicIpAddress false true or false
PrivateNetworking false true or false
BatchPrefix mydept
AksClusterName myAksCluster
AksCoANamespace coa coa
ManualHelmDeployment true or false
AksPoolSize 2 2
CrossSubscriptionAKSDeployment false true or false
Silent false true or false
DeleteResourceGroupOnFailure false true or false
DebugLogging false true
Update false true
CromwellVersion See code 86
TesImageName Current release version mcr.microsoft.com/cromwellonazure/tes:5.3.0
TriggerServiceImageName Current release version mcr.microsoft.com/cromwellonazure/triggerservice:5.3.0
SkipTestWorkflow false true
Tags key=value,key2=value2
PostgreSqlServerName mypsql
PostgreSqlServerNameSuffix .postgres.database.azure.com .postgres.database.azure.com
PostgreSqlServerPort 5432 5432
PostgreSqlServerSslMode VerifyFull VerifyFull
ContainersToMountPath /path/to/container
AadGroupIds 12345678-1234-1234-1234-1234567890ab,2345678-1234-1234-1234-1234567890ab (Admin group object IDs)
Clone this wiki locally