Enable huge pages in a host profile¶

The BareMetalHostProfile API allows configuring a host to use the huge pages feature of the Linux kernel on managed clusters.

To enable huge pages in a custom bare metal host profile for a managed cluster:

1. Log in to the local machine where you management cluster kubeconfig is located and where kubectl is installed.

   Note

   The management cluster kubeconfig is created automatically during the last stage of the management cluster bootstrap.

2. Open for editing or create a new bare metal host profile under the templates/bm/ directory.

3. Edit the grubConfig section of the host profile spec using the example below to configure the kernel boot parameters and enable huge pages:

   spec:
     grubConfig:
       defaultGrubOptions:
       - GRUB_DISABLE_RECOVERY="true"
       - GRUB_PRELOAD_MODULES=lvm
       - GRUB_TIMEOUT=20
       - GRUB_CMDLINE_LINUX_DEFAULT="hugepagesz=1G hugepages=N"
   

   The example configuration above will allocate N huge pages of 1 GB each on the server boot. The last hugepagesz parameter value is default unless default_hugepagesz is defined. For details about possible values, see official Linux kernel documentation.

4. Add the bare metal host profile to your management cluster:

   kubectl --kubeconfig <pathToManagementClusterKubeconfig> -n <projectName> apply -f <pathToBareMetalHostProfileFile>
   

5. If required, further modify the host profile:

   kubectl --kubeconfig <pathToManagementClusterKubeconfig> -n <projectName> edit baremetalhostprofile <hostProfileName>
   

6. Proceed with creating a managed cluster as described in Create a managed cluster.