overlay: add overlay implementation

[WeiZhang555]

With help of newly introduced Overlay FileSystem in fuse-backend-rs library, now we can create writable rootfs in Nydus. Implementation of writable rootfs is based on one passthrough FS(as upper layer) over one readonly rafs(as lower layer).

To do so, configuration is extended with some Overlay options.

Details

An userspace overlay filesystem is usable for control of user data, with this implementation, Nydus can have stronger control on container rootfs.

Types of changes

What types of changes does your PullRequest introduce? Put an x in all the boxes that apply:

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation Update (if none of the other choices apply)

Checklist

Go over all the following points, and put an x in all the boxes that apply.

• I have updated the documentation accordingly.
• I have added tests to cover my changes.

[WeiZhang555]

The PR is not ready for merging since it rely heavily on fuse-backend-rs changes(see PR ), this PR can be regarded as a simple demo usage of userspace Overlay FS currently.

[codecov]

Codecov Report

Attention: Patch coverage is 11.68831% with 68 lines in your changes are missing coverage. Please review.

Project coverage is 61.22%. Comparing base (3dfa9e9) to head (e2bc4bf).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1544      +/-   ##
==========================================
- Coverage   61.29%   61.22%   -0.08%     
==========================================
  Files         144      144              
  Lines       47035    47100      +65     
  Branches    44537    44602      +65     
==========================================
+ Hits        28832    28838       +6     
- Misses      16719    16778      +59     
  Partials     1484     1484              

Files	Coverage Δ
builder/src/core/context.rs	67.06% <100.00%> (+0.03%)	⬆️
api/src/config.rs	87.58% <80.00%> (-0.03%)	⬇️
storage/src/device.rs	69.26% <0.00%> (+0.22%)	⬆️
rafs/src/fs.rs	34.33% <28.57%> (-0.20%)	⬇️
service/src/fs_service.rs	40.92% <3.27%> (-10.20%)	⬇️

... and 1 file with indirect coverage changes

[imeoer]

Thanks for the implementation! Please also add a test case in https://github.com/dragonflyoss/nydus/tree/master/smoke/tests (maybe create a overlay_writable_test.go ?).

[imeoer]

Maybe we should get macOS to pass unit tests as well: https://github.com/dragonflyoss/nydus/actions/runs/7735769409/job/21091979887?pr=1544

others LGTM, thanks!

[WeiZhang555]

Maybe we should get macOS to pass unit tests as well: https://github.com/dragonflyoss/nydus/actions/runs/7735769409/job/21091979887?pr=1544

others LGTM, thanks!

Smoke test cases were added and passed.

[imeoer]

It seems the CI broken, others LGTM!

[imeoer]

Thanks, LGTM! We can also add the doc in https://github.com/dragonflyoss/nydus/blob/master/docs/nydusd.md, may be Enable Overlay Writable ?

[WeiZhang555]

@imeoer docs updated to docs/nydus-overlayfs.md

[imeoer]

LGTM, thanks!