Azure ARM

ARM Template Examples for Launching SoftNAS

There are two templates. One is a template for a single instance and the other template is for HA pair. The templates create the SoftNAS instance(s) and the network stack. The required parameters used in the template are located at the top of the JSON inside the Parameters {} section. Most values are empty. You can either define them as the defaults in the parameters section or pass them in at template creation time using the Azure cli.

Once the template launch completes you can browse to the private or public IP of the instance via HTTPS and log in. The default password to log into the SoftNAS instance Web UI will be passed in at creation time. The default username will be 'softnas'

Parameter Keys Explained

dnsLabelPrefix : This string will prefix all the resource names so you can easily identify them.
region : The Azure region that you want to launch in.
rg_name : The resource group name, will create if it the name does not exist.
adminUsername : Defaults to 'softnas', do not change this.
adminPassword : The password for the user 'softnas'
vnetCIDR : CIDR for the newly created VNET '10.100.0.0/26'.
subnetOnePrefix : Subnet one CIDR address '10.100.1.0/24'.
subnetTwoPrefix : Subnet two CIDR address (if using HA) '10.100.3.0/24'.
assignPubIp : Assign pub IP or not (yes or no).
vmSize : The Azure instance size to launch the SoftNAS image on.
imagePublisher : Leave this at the default 'Softnas'
imageSku : Image SKU from azure marketplace
imageOffer : Offer name from Azure marketplace
imageName : Image name from Azure marketplace
trustedIp : The IP range to allow access from, added to the NSG.
vipAddress : The HA VIP to assign (If using HA)
armClientId : The application-id URI of your application registration or Service Principal.
armClientSecret : The secret key for the app URI.
armTenantId : The tenant ID for the subscruption where the App Registrtation can authenticate.

Example of passing in parameters for a single instance

# give it a name that will also serve as a prefix tag for all the resources
name="SoftnasAzTest"

Now launch the template using Azure CLI and pass in all the parameters using the --parameters flag:

az group deployment create --resource-group 'AzureTestRG' --template-file azure_single_network.json --parameters\
 dnsLabelPrefix="$name"\
 region="centralus"\
 rg_name="test_rg"\
 assignPubIp="Yes"\
 adminPassword='Pass4W0rd'\
 vnetCIDR="10.100.0.0/16"\
 subnetOnePrefix="10.100.1.0/24"\
 vmSize="Standard_DS2_v2"\
 imageOffer="buurst_nas"\
 imageSku="buurst_nas"\
 imageName="4.4.3"\
 trustedIp="1.2.3.4/32"\
 armClientId='https://xyz.com/403161d0-44a1-4716-d85x-abcd430f7911'\ # USE YOUR SPN ID HERE
 armClientSecret='qwerty~~some-key-azure-assigns'\                   # USE YOUR SECRET KEY HERE
 armTenantId='1234z=abcdef-1234-1234-abc1-12345678912345'\           # USE YOUR TENANT ID HERE
 --name $name

Example of passing in parameters for a HA pair

# give it a name that will also serve as a prefix tag for all the resources
name="SoftnasHA"

Now launch the template using Azure CLI and pass in all the parameters using the --parameters flag:

az group deployment create --resource-group 'AzureTestRG' --template-file azure_ha_network.json --parameters\
 dnsLabelPrefix="$name"\
 region="centralus"\
 rg_name="AzureTestRG"\
 adminPassword='Pass4W0rd'\
 vnetCIDR="10.100.0.0/16"\
 subnetOnePrefix="10.100.0.1/24"\
 subnetTwoPrefix="10.100.0.3/24"\
 vipAddress="99.99.99.99"\
 vmSize="Standard_DS2_v2"\
 imageOffer="buurst_nas"\
 imageSku="buurst_nas"\
 imageName="4.4.3"\
 trustedIp="1.2.3.4/32"\
 armClientId='https://xyz.com/403161d0-44a1-4716-d85x-abcd430f7911'\ # USE YOUR SPN ID HERE
 armClientSecret='qwerty~~some-key-azure-assigns'\                   # USE YOUR SECRET KEY HERE
 armTenantId='1234z=abcdef-1234-1234-abc1-12345678912345'\           # USE YOUR TENANT ID HERE
 --name $name

Reach out to Buurst support if you have any questions