github.com/shivanshs9/go-overlay2@v0.0.0-20160814221707-8877415a0206/README.md (about) 1 go-overlay2 2 =========== 3 4 [![GoDoc](https://godoc.org/github.com/barracks510/go-overlay2?status.svg)](https://godoc.org/github.com/barracks510/go-overlay2) 5 6 Copyright (c) 2016 Dennis Chen <barracks510@gmail.com> 7 8 Description 9 ----------- 10 11 Port of the Docker Overlay2 GraphDriver to a non-Docker implementation. 12 13 OverlayFS is a union filesystem that allows the presentation of a single filesystem that results from the overlay of one unto another. 14 15 Installation 16 ------------ 17 18 This package can be installed with the `go get` command: 19 20 go get github.com/barracks510/go-overlay2 21 22 _go-overlay2_ depends on Linux kernel 4.0 or newer, compiled with OverlayFS. 23 RedHat has backported the latest OverlayFS to kernel 3.10 for RHEL7.1 and CentOS 7.1. 24 Using go-overlay2 on these backported kernels has been minimally tested. 25 If you want to build your app with go-overlay2, you will need to cross compile for Linux. 26 27 This package currently is a work-in-progress. I do not forsee the API becoming stable in the near future. 28 It is not recommended to use this package without locking in or vendoring it as a dependency. 29 30 Documentation 31 ------------- 32 33 API documentation may be found here: https://godoc.org/github.com/barracks510/go-overlay2 34 Kernel documentation may be found here: https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt 35 Docker docmentation may be found here: https://docs.docker.com/engine/userguide/storagedriver/overlayfs-driver/ 36 37 38 Examples can be found under the `./_example` directory 39 40 License 41 ------- 42 43 Apache Software License 2.0. See COPYING for details. 44 This repository contains code from other projects. See NOTICE for details.