voverlay

Documentation

Overview

Package voverlay implements the viceroy overlay filesystem, which combines two fine.Handlers into a single filesystem. voverlay is a special type of overlay, unlike the standard overlay mount type supported by Linux. The rules are:

1. The upper filesystem will be preferred for files that exist on both the upper and the lower filesystem.

2. The lower filesystem will be preferred for creating new files or directories if the parent directory exists on both filesystems.

3. Otherwise, the matching filesystem will be used for reads and writes for files that only exist on one of the two filesystems.

voverlay has no concept of "copy up," and both the upper and lower filesystems must be writeable. Other than these rules, the overlay should mostly behave as expected: directories that exist on both filesystems are merged, etc.

It is expected that the upper filesystem will be a viceroy worker, and the lower filesystem will be the host machine filesystem.

Index

• func New(l log.Logger, upper, lower server.Handler) server.Handler

Functions

func New

func New(l log.Logger, upper, lower server.Handler) server.Handler

New creates a new voverlay filesystem that overlays an upper filesystem on top of a lower filesystem.