Enable disk encryption for Azure Service Fabric cluster nodes in Linux

Article
03/10/2023

In this tutorial, you'll learn how to enable disk encryption on Azure Service Fabric cluster nodes in Linux. You'll need to follow these steps for each of the node types and virtual machine scale sets. For encrypting the nodes, we'll use the Azure Disk Encryption capability on virtual machine scale sets.

The guide covers the following topics:

Key concepts to be aware of when enabling disk encryption on Service Fabric cluster virtual machine scale sets in Linux.
Steps to be followed before enabling disk encryption on Service Fabric cluster nodes in Linux.
Steps to be followed to enable disk encryption on Service Fabric cluster nodes in Linux.

Note

We recommend that you use the Azure Az PowerShell module to interact with Azure. See Install Azure PowerShell to get started. To learn how to migrate to the Az PowerShell module, see Migrate Azure PowerShell from AzureRM to Az.

Prerequisites

Self-registration

The disk encryption preview for the virtual machine scale set requires self-registration. Use the following steps:

Run the following command:

Register-AzProviderFeature -ProviderNamespace Microsoft.Compute -FeatureName "UnifiedDiskEncryption"

Wait about 10 minutes until the status reads Registered. You can check the status by running the following command:

Get-AzProviderFeature -ProviderNamespace "Microsoft.Compute" -FeatureName "UnifiedDiskEncryption"
Register-AzResourceProvider -ProviderNamespace Microsoft.Compute

Azure Key Vault

Create a key vault in the same subscription and region as the scale set. Then select the EnabledForDiskEncryption access policy on the key vault by using its PowerShell cmdlet. You can also set the policy by using the Key Vault UI in the Azure portal with the following command:
```
Set-AzKeyVaultAccessPolicy -VaultName $keyVaultName -EnabledForDiskEncryption
```
Install the latest version of the Azure CLI, which has the new encryption commands.
Install the latest version of the Azure SDK from Azure PowerShell release. Following are the virtual machine scale set Azure Disk Encryption cmdlets to enable (set) encryption, retrieve (get) encryption status, and remove (disable) encryption on the scale set instance.

Command	Version	Source
Get-AzVmssDiskEncryptionStatus	1.0.0 or later	Az.Compute
Get-AzVmssVMDiskEncryptionStatus	1.0.0 or later	Az.Compute
Disable-AzVmssDiskEncryption	1.0.0 or later	Az.Compute
Get-AzVmssDiskEncryption	1.0.0 or later	Az.Compute
Get-AzVmssVMDiskEncryption	1.0.0 or later	Az.Compute
Set-AzVmssDiskEncryptionExtension	1.0.0 or later	Az.Compute

Supported scenarios for disk encryption

Encryption for virtual machine scale sets is supported only for scale sets created with managed disks. It's not supported for native (or unmanaged) disk scale sets.
Both encryption and disable encryption are supported for OS and data volumes in virtual machine scale sets in Linux.
Virtual machine (VM) reimage and upgrade operations for virtual machine scale sets aren't supported in the current preview.

Create a new cluster and enable disk encryption

Use the following commands to create a cluster and enable disk encryption by using a Azure Resource Manager template and a self-signed certificate.


Login-AzAccount
Set-AzContext -SubscriptionId <guid>


azure login
az account set --subscription $subscriptionId

Use the custom template that you already have

If you need to author a custom template, we highly recommend that you use one of the templates on the Azure Service Fabric cluster creation template samples page.

If you already have a custom template, double-check that all three certificate-related parameters in the template and the parameter file are named as follows. Also ensure that the values are null as follows:

   "certificateThumbprint": {
      "value": ""
    },
    "sourceVaultValue": {
      "value": ""
    },
    "certificateUrlValue": {
      "value": ""
    },

Because only data disk encryption is supported for virtual machine scale sets in Linux, you must add a data disk by using a Resource Manager template. Update your template for data disk provision as follows:

   
   "storageProfile": { 
            "imageReference": { 
              "publisher": "[parameters('vmImagePublisher')]", 
              "offer": "[parameters('vmImageOffer')]", 
              "sku": "[parameters('vmImageSku')]", 
              "version": "[parameters('vmImageVersion')]" 
            }, 
            "osDisk": { 
              "caching": "ReadOnly", 
              "createOption": "FromImage", 
              "managedDisk": { 
                "storageAccountType": "[parameters('storageAccountType')]" 
              } 
           }, 
                "dataDisks": [ 
                { 
                    "diskSizeGB": 1023, 
                    "lun": 0, 
                    "createOption": "Empty"

$resourceGroupLocation="westus"
$resourceGroupName="mycluster"
$CertSubjectName="mycluster.westus.cloudapp.azure.com"
$certPassword="Password!1" | ConvertTo-SecureString -AsPlainText -Force 
$certOutputFolder="c:\certificates"

$parameterFilePath="c:\templates\templateparam.json"
$templateFilePath="c:\templates\template.json"


New-AzServiceFabricCluster -ResourceGroupName $resourceGroupName -CertificateOutputFolder $certOutputFolder -CertificatePassword $certpassword -CertificateSubjectName $CertSubjectName -TemplateFile $templateFilePath -ParameterFile $parameterFilePath

Here is the equivalent CLI command. Change the values in the declare statements to the appropriate values. The CLI supports all the other parameters that the preceding PowerShell command supports.

declare certPassword=""
declare resourceGroupLocation="westus"
declare resourceGroupName="mylinux"
declare certSubjectName="mylinuxsecure.westus.cloudapp.azure.com"
declare parameterFilePath="c:\mytemplates\linuxtemplateparm.json"
declare templateFilePath="c:\mytemplates\linuxtemplate.json"
declare certOutputFolder="c:\certificates"


az sf cluster create --resource-group $resourceGroupName --location $resourceGroupLocation  \
	--certificate-output-folder $certOutputFolder --certificate-password $certPassword  \
	--certificate-subject-name $certSubjectName \
    --template-file $templateFilePath --parameter-file $parametersFilePath

Mount a data disk to a Linux instance

Before you continue with encryption on a virtual machine scale set, ensure the added data disk is correctly mounted. Sign in to the Linux cluster VM and run the LSBLK command. The output should show that added data disk in the Mount Point column.

Deploy application to a Service Fabric cluster in Linux

To deploy an application to your cluster, follow the steps and guidance at Quickstart: Deploy Linux containers to Service Fabric.

Enable disk encryption for the virtual machine scale sets created previously

To enable disk encryption for the virtual machine scale sets you created through the previous steps, run the following commands:

$VmssName = "nt1vm"
$vaultName = "mykeyvault"
$resourceGroupName = "mycluster"
$KeyVault = Get-AzKeyVault -VaultName $vaultName -ResourceGroupName $rgName
$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri
$KeyVaultResourceId = $KeyVault.ResourceId

Set-AzVmssDiskEncryptionExtension -ResourceGroupName $resourceGroupName -VMScaleSetName $VmssName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -VolumeType All


az vmss encryption enable -g <resourceGroupName> -n <VMSS name> --disk-encryption-keyvault <KeyVaultResourceId>

Validate if disk encryption is enabled for a virtual machine scale set in Linux

To get the status of an entire virtual machine scale set or any instance in a scale set, run the following commands. Additionally, you can sign in to the Linux cluster VM and run the LSBLK command. The output should show the added data disk in the Mount Point column, and the Type column should read Crypt.


$VmssName = "nt1vm"
$resourceGroupName = "mycluster"
Get-AzVmssDiskEncryption -ResourceGroupName $resourceGroupName -VMScaleSetName $VmssName

Get-AzVmssVMDiskEncryption -ResourceGroupName $resourceGroupName -VMScaleSetName $VmssName -InstanceId "0"

az vmss encryption show -g <resourceGroupName> -n <VMSS name>

Disable disk encryption for a virtual machine scale set in a Service Fabric cluster

Disable disk encryption for a virtual machine scale set by running the following commands. Note that disabling disk encryption applies to the entire virtual machine scale set and not an individual instance.

$VmssName = "nt1vm"
$resourceGroupName = "mycluster"
Disable-AzVmssDiskEncryption -ResourceGroupName $rgName -VMScaleSetName $VmssName

az vmss encryption disable -g <resourceGroupName> -n <VMSS name>

Next steps

At this point, you should have a secure cluster and know how to enable and disable disk encryption for Service Fabric cluster nodes and virtual machine scale sets. For similar guidance on Service Fabric cluster nodes in Linux, see Disk Encryption for Windows.

Enable disk encryption for Azure Service Fabric cluster nodes in Linux

Prerequisites

Supported scenarios for disk encryption

Create a new cluster and enable disk encryption

Use the custom template that you already have

Mount a data disk to a Linux instance

Deploy application to a Service Fabric cluster in Linux

Enable disk encryption for the virtual machine scale sets created previously

Validate if disk encryption is enabled for a virtual machine scale set in Linux

Disable disk encryption for a virtual machine scale set in a Service Fabric cluster

Next steps

Feedback

Additional resources

Enable disk encryption for Azure Service Fabric cluster nodes in Linux

Prerequisites

Supported scenarios for disk encryption

Create a new cluster and enable disk encryption

Sign in to Azure

Use the custom template that you already have

Mount a data disk to a Linux instance

Deploy application to a Service Fabric cluster in Linux

Enable disk encryption for the virtual machine scale sets created previously

Validate if disk encryption is enabled for a virtual machine scale set in Linux

Disable disk encryption for a virtual machine scale set in a Service Fabric cluster

Next steps

Feedback

Additional resources