Prepare Linux for Edge Volumes using a single-node or two-node cluster

Prepare Linux with AKS enabled by Azure Arc

If you run a single-node or two-node cluster on Linux with AKS enabled by Azure Arc, you don't need to perform any additional steps.

Prepare Linux with AKS Edge Essentials

This section describes how to prepare Linux with AKS Edge Essentials if you run a single-node or two-node cluster.

1. For Edge Essentials to support Azure IoT Operations and Azure Container Storage enabled by Azure Arc, the Kubernetes hosts must be modified to support more memory. You can also increase vCPU and disk allocations at this time if you anticipate requiring additional resources for your Kubernetes uses.

   Start by following the How-To guide here. The QuickStart uses the default configuration and should be avoided.

   Following Step 1: single machine configuration parameters, you have a file in your working directory called aksedge-config.json. Open this file in Notepad or another text editor:

   "SchemaVersion": "1.11",
   "Version": "1.0",
   "DeploymentType": "SingleMachineCluster",
   "Init": {
       "ServiceIPRangeSize": 0
   },
   "Machines": [
   {
       "LinuxNode": {
           "CpuCount": 4,
           "MemoryInMB": 4096,
           "DataSizeInGB": 10,
       }
   }
   ]
   

   Increase MemoryInMB to at least 16384 and DataSizeInGB to 40G. Set ServiceIPRangeSize to 15. If you intend to run many PODs, you can increase the CpuCount as well. For example:

   "Init": {
       "ServiceIPRangeSize": 15
      },
   "Machines": [
   {
       "LinuxNode": {
           "CpuCount": 4,
           "MemoryInMB": 16384,
           "DataSizeInGB": 40,
       }
   }
   ]
   

   Continue with the remaining steps starting with create a single machine cluster. Next, connect your AKS Edge Essentials cluster to Arc.

2. Check for and install Local Path Provisioner storage if it's not already installed. Check if the local-path storage class is already available on your node by running the following cmdlet:

   kubectl get StorageClass
   

   If the local-path storage class is not available, run the following command:

   kubectl apply -f https://raw.githubusercontent.com/Azure/AKS-Edge/main/samples/storage/local-path-provisioner/local-path-storage.yaml
   

   Note

   Local-Path-Provisioner and Busybox images are not maintained by Microsoft and are pulled from the Rancher Labs repository. Local-Path-Provisioner and BusyBox are only available as a Linux container image.

   If everything is correctly configured, you should see the following output:

   NAME                   PROVISIONER             RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
   local-path (default)   rancher.io/local-path   Delete          WaitForFirstConsumer   false                  21h
   

   If you have multiple disks and want to redirect the path, use:

   kubectl edit configmap -n kube-system local-path-config
   

3. Run the following command to determine if you set fs.inotify.max_user_instances to 1024:

   Invoke-AksEdgeNodeCommand -NodeType "Linux" -Command "sysctl fs.inotify.max_user_instances
   

   After you run this command, if it outputs less than 1024, run the following command to increase the maximum number of files:

   Invoke-AksEdgeNodeCommand -NodeType "Linux" -Command "echo 'fs.inotify.max_user_instances = 1024' | sudo tee -a /etc/sysctl.conf && sudo sysctl -p"
   

Prepare Linux with Ubuntu

This section describes how to prepare Linux with Ubuntu if you run a single-node or two-node cluster.

1. Run the following command to determine if you set fs.inotify.max_user_instances to 1024:

   sysctl fs.inotify.max_user_instances
   

   After you run this command, if it outputs less than 1024, run the following command to increase the maximum number of files and reload the sysctl settings:

   echo 'fs.inotify.max_user_instances = 1024' | sudo tee -a /etc/sysctl.conf
   sudo sysctl -p
   

Prepare Linux with other platforms

The available platform options are production-like environments that Microsoft validated. These platforms aren't necessarily the only environments on which Azure Container Storage enabled by Azure Arc can run. Azure Container Storage can run on any Arc-enabled Kubernetes cluster that meets the Azure Arc-enabled Kubernetes system requirements. If you're running on an environment not listed, here are a few suggestions to increase the likelihood of a successful installation:

1. Run the following commands to increase the user watch and instance limits:

   echo fs.inotify.max_user_instances=8192 | sudo tee -a /etc/sysctl.conf
   echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf
   sudo sysctl -p
   

2. Run the following commands to increase the file descriptor limit for better performance:

   echo fs.file-max = 100000 | sudo tee -a /etc/sysctl.conf
   sudo sysctl -p
   

3. Run the following command to install the local path provisioner:

   kubectl apply -f https://raw.githubusercontent.com/Azure/AKS-Edge/main/samples/storage/local-path-provisioner/local-path-storage.yaml