Skip to main content
Version: v5.0 Stable

Central HostPath Mapper

Enterprise
Available in these plansFreeDevProdScale
Central HostPath Mapper

Free, Dev, Prod, and Scale are vCluster Platform license plans. Open source does not need a license or a Platform connection. See Compare open source and free tiers.

Clusters on shared nodes require the HostPath Mapper for log collection. Log collectors such as Fluentd, the ELK stack, or Grafana Loki mount node host paths and use log filenames to match logs to pods. vCluster renames pods when it syncs them to the control plane cluster, so these collectors can't match the log files to the cluster's pods on their own. The HostPath Mapper creates symbolic links that map each cluster's pod and container names to their names on the control plane cluster.

The per-cluster HostPath Mapper runs a DaemonSet in each cluster's namespace. This setup works well for small environments with few nodes and clusters.

As the number of nodes and clusters grows, the number of required DaemonSet pods also grows. Each cluster's DaemonSet runs a pod on every node, which increases resource usage.

The Central HostPath Mapper solves this problem. It installs a single DaemonSet on the control plane cluster. This DaemonSet manages host path remapping for all clusters on the platform. It reduces overhead and simplifies cluster management.

Shared nodes only

The HostPath Mapper, central or per cluster, works only for clusters on shared nodes, where tenant pods run on control plane cluster nodes.

Prerequisites

To use this feature, install the Central HostPath Mapper on the control plane cluster. The component is available as a default vCluster Platform App in the Apps section. Install it before enabling the feature to ensure full capabilities are available.

Templates

This feature is only configurable from the UI for clusters created without a template. When using a custom template that has the feature enabled, the UI doesn't display the configuration in Advanced Control Plane as described below. In this case, configure the feature using the CLI or by modifying the manifests.

  1. From the project drop-down menu, click the project where you want to create the cluster.

  2. Click the button above the list of clusters.

  3. [Optional] Click the control plane cluster where you want to create the cluster.

  4. Leave the Select a template section blank and click the to continue.

  5. Go to the Advanced Control Plane section and find Host Path Mapper.

  6. Turn on Enable host path mapper. This adds the loft.sh/hpm-enabled annotation to the template metadata, which syncs automatically to the cluster on creation. It also sets enabled: true and central: true under the controlPlane.hostPathMapper field in the vcluster.yaml.

  7. Finish configuring anything else on your cluster, then click .