Skip to content

Commit

Permalink
Merge pull request #4415 from bryan-cox/add_disk_encryption_doc
Browse files Browse the repository at this point in the history
Add disk encryption options documentation
  • Loading branch information
k8s-ci-robot authored Dec 23, 2023
2 parents 2bfbdc9 + 1777054 commit 140df0e
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@
- [Custom Images](./topics/custom-images.md)
- [Custom Private DNS Zone Name](./topics/custom-dns.md)
- [Custom VM Extensions](./topics/custom-vm-extensions.md)
- [Data Disks](./topics/data-disks.md)
- [Disks](./topics/disks.md)
- [Data Disks](./topics/data-disks.md)
- [OS Disk](./topics/os-disk.md)
- [Disk Encryption](./topics/disk-encryption.md)
- [Dual-Stack](./topics/dual-stack.md)
- [Externally managed Azure infrastructure](./topics/externally-managed-azure-infrastructure.md)
- [Failure Domains](./topics/failure-domains.md)
Expand All @@ -31,7 +34,6 @@
- [Machine Pools (VMSS)](./topics/machinepools.md)
- [Managed Clusters (AKS)](./topics/managedcluster.md)
- [Node Outbound Connection](./topics/node-outbound-connection.md)
- [OS Disk](./topics/os-disk.md)
- [Spot Virtual Machines](./topics/spot-vms.md)
- [SSH Access to nodes](./topics/ssh-access.md)
- [Virtual Networks](./topics/custom-vnet.md)
Expand Down
55 changes: 55 additions & 0 deletions docs/book/src/topics/disk-encryption.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Disk Encryption
This document describes how to configure different encryption options for disks allocated to VMs provisioned in Azure.

## Azure Disk Storage Server-Side Encryption
Azure Disk Storage Server-Side Encryption (SSE) is also referred to as encryption-at-rest. This encryption option does not encrypt temporary disks or disk caches.

When enabled, Azure Disk Storage SSE encrypts data stored on Azure managed disks, i.e. OS and data disks. This option can be enabled using customer-managed keys.

Customer-managed keys must be configured through a Disk Encryption Set (DES) resource. For more information on Azure Disk Storage SSE, please see this [link](https://learn.microsoft.com/azure/virtual-machines/disk-encryption).

### Example with OS Disk using DES
When using customer-managed keys, you only need to provide the DES ID within the managedDisk spec.
> **Note**: The DES must be within the same subscription.
```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: AzureMachineTemplate
metadata:
name: <machine-template-name>
namespace: <namespace>
spec:
template:
spec:
[...]
osDisk:
managedDisk:
diskEncryptionSet:
id: <disk_encryption_set_id>
[...]
```

## Encryption at Host
This encryption option is a VM option enhancing Azure Disk Storage SSE to ensure any temp disk or disk cache is encrypted at rest.

For more information on encryption at host, please see this [link](https://learn.microsoft.com/azure/virtual-machines/disk-encryption#encryption-at-host---end-to-end-encryption-for-your-vm-data).

### Example with OS Disk and DES
```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: AzureMachineTemplate
metadata:
name: <machine-template-name>
namespace: <namespace>
spec:
template:
spec:
[...]
osDisk:
managedDisk:
diskEncryptionSet:
id: <disk_encryption_set_id>
securityProfile:
encryptionAtHost: true
[...]
```
3 changes: 3 additions & 0 deletions docs/book/src/topics/disks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Disks

This section contains information about enabling and configuring different disk types for VMs provisioned in Azure.

0 comments on commit 140df0e

Please sign in to comment.