From f47edf7da2eeff0747aff7efb5469647c9b5eece Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 19 Mar 2021 01:51:40 +0900 Subject: [PATCH 1/4] AkihiroSuda/containerd-fuse-overlayfs -> containerd/fuse-overlayfs-snapshotter Signed-off-by: Akihiro Suda --- .github/workflows/release.yml | 12 ++++++------ Dockerfile | 4 ++-- Makefile | 4 ++-- README.md | 3 +-- cmd/containerd-fuse-overlayfs-grpc/main.go | 4 ++-- go.mod | 2 +- plugin/plugin.go | 2 +- 7 files changed, 15 insertions(+), 16 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 616df24..a5d5e8c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -16,20 +16,20 @@ jobs: go-version: 1.16.x - uses: actions/checkout@v2 with: - path: go/src/github.com/AkihiroSuda/containerd-fuse-overlayfs + path: go/src/github.com/containerd/fuse-overlayfs-snapshotter - name: "Compile binaries" - working-directory: go/src/github.com/AkihiroSuda/containerd-fuse-overlayfs + working-directory: go/src/github.com/containerd/fuse-overlayfs-snapshotter run: make artifacts - name: "SHA256SUMS" - working-directory: go/src/github.com/AkihiroSuda/containerd-fuse-overlayfs + working-directory: go/src/github.com/containerd/fuse-overlayfs-snapshotter run: | ( cd _output; sha256sum containerd-fuse-overlayfs-* ) | tee /tmp/SHA256SUMS mv /tmp/SHA256SUMS _output/SHA256SUMS - name: "The sha256sum of the SHA256SUMS file" - working-directory: go/src/github.com/AkihiroSuda/containerd-fuse-overlayfs + working-directory: go/src/github.com/containerd/fuse-overlayfs-snapshotter run: (cd _output; sha256sum SHA256SUMS) - name: "Prepare the release note" - working-directory: go/src/github.com/AkihiroSuda/containerd-fuse-overlayfs + working-directory: go/src/github.com/containerd/fuse-overlayfs-snapshotter run: | tag="${GITHUB_REF##*/}" shasha=$(sha256sum _output/SHA256SUMS | awk '{print $1}') @@ -44,7 +44,7 @@ jobs: The sha256sum of the SHA256SUMS file itself is \`${shasha}\` . EOF - name: "Create release" - working-directory: go/src/github.com/AkihiroSuda/containerd-fuse-overlayfs + working-directory: go/src/github.com/containerd/fuse-overlayfs-snapshotter env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | diff --git a/Dockerfile b/Dockerfile index 97e8753..1fd542a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,8 +7,8 @@ ARG DEBIAN_VERSION=10 ARG ALPINE_VERSION=3.13 FROM golang:${GO_VERSION}-alpine AS containerd-fuse-overlayfs-test -COPY . /go/src/github.com/AkihiroSuda/containerd-fuse-overlayfs -WORKDIR /go/src/github.com/AkihiroSuda/containerd-fuse-overlayfs +COPY . /go/src/github.com/containerd/fuse-overlayfs-snapshotter +WORKDIR /go/src/github.com/containerd/fuse-overlayfs-snapshotter ENV CGO_ENABLED=0 ENV GO111MODULE=on RUN mkdir /out && go test -c -o /out/containerd-fuse-overlayfs.test diff --git a/Makefile b/Makefile index 54e281d..ed9da9c 100644 --- a/Makefile +++ b/Makefile @@ -4,8 +4,8 @@ VERSION=$(shell git describe --match 'v[0-9]*' --dirty='.m' --always --tags) VERSION_TRIMMED := $(VERSION:v%=%) REVISION=$(shell git rev-parse HEAD)$(shell if ! git diff --no-ext-diff --quiet --exit-code; then echo .m; fi) -PKG_MAIN := github.com/AkihiroSuda/containerd-fuse-overlayfs/cmd/containerd-fuse-overlayfs-grpc -PKG_VERSION := github.com/AkihiroSuda/containerd-fuse-overlayfs/cmd/containerd-fuse-overlayfs-grpc/version +PKG_MAIN := github.com/containerd/fuse-overlayfs-snapshotter/cmd/containerd-fuse-overlayfs-grpc +PKG_VERSION := github.com/containerd/fuse-overlayfs-snapshotter/cmd/containerd-fuse-overlayfs-grpc/version GO ?= go export GO_BUILD=GO111MODULE=on CGO_ENABLED=0 $(GO) build -ldflags "-s -w -X $(PKG_VERSION).Version=$(VERSION) -X $(PKG_VERSION).Revision=$(REVISION)" diff --git a/README.md b/README.md index 6ab6a3f..c21c48d 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,7 @@ with the following content, and recompile the containerd binary: package main -// NOTE: the package name was "github.com/AkihiroSuda/containerd-fuse-overlayfs" before v1.0.0 -import _ "github.com/AkihiroSuda/containerd-fuse-overlayfs/plugin" +import _ "github.com/containerd/fuse-overlayfs-snapshotter/plugin" ``` No extra configuration is needed. diff --git a/cmd/containerd-fuse-overlayfs-grpc/main.go b/cmd/containerd-fuse-overlayfs-grpc/main.go index 93121c4..d131294 100644 --- a/cmd/containerd-fuse-overlayfs-grpc/main.go +++ b/cmd/containerd-fuse-overlayfs-grpc/main.go @@ -29,8 +29,8 @@ import ( snapshotsapi "github.com/containerd/containerd/api/services/snapshots/v1" "github.com/containerd/containerd/contrib/snapshotservice" - fuseoverlayfs "github.com/AkihiroSuda/containerd-fuse-overlayfs" - "github.com/AkihiroSuda/containerd-fuse-overlayfs/cmd/containerd-fuse-overlayfs-grpc/version" + fuseoverlayfs "github.com/containerd/fuse-overlayfs-snapshotter" + "github.com/containerd/fuse-overlayfs-snapshotter/cmd/containerd-fuse-overlayfs-grpc/version" ) // main is from https://github.com/containerd/containerd/blob/b9fad5e310fafb453def5f1e7094f4c36a9806d2/PLUGINS.md diff --git a/go.mod b/go.mod index 622ea6e..588d610 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/AkihiroSuda/containerd-fuse-overlayfs +module github.com/containerd/fuse-overlayfs-snapshotter go 1.16 diff --git a/plugin/plugin.go b/plugin/plugin.go index 445e337..2a76554 100644 --- a/plugin/plugin.go +++ b/plugin/plugin.go @@ -21,9 +21,9 @@ package fuseoverlayfs import ( "errors" - fuseoverlayfs "github.com/AkihiroSuda/containerd-fuse-overlayfs" "github.com/containerd/containerd/platforms" "github.com/containerd/containerd/plugin" + fuseoverlayfs "github.com/containerd/fuse-overlayfs-snapshotter" ) // Config represents configuration for the fuse-overlayfs plugin. From d34b11b6b1e8abf63d5cb138f082b15f5c1d8000 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 19 Mar 2021 01:53:33 +0900 Subject: [PATCH 2/4] Use containerd copyright header Check command: `ltag -t "${GOPATH}/src/github.com/containerd/project-checks/script/validate/template" --check -v` Signed-off-by: Akihiro Suda --- Dockerfile | 14 ++++++++++++++ Makefile | 14 ++++++++++++++ README.md | 3 +++ 3 files changed, 31 insertions(+) diff --git a/Dockerfile b/Dockerfile index 1fd542a..58c5337 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,3 +1,17 @@ +# Copyright The containerd Authors. + +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# http://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + ARG FUSEOVERLAYFS_COMMIT=master ARG ROOTLESSKIT_COMMIT=v0.14.0 ARG SHADOW_COMMIT=4.8.1 diff --git a/Makefile b/Makefile index ed9da9c..af2fbf9 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,17 @@ +# Copyright The containerd Authors. + +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# http://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + DESTDIR ?= /usr/local VERSION=$(shell git describe --match 'v[0-9]*' --dirty='.m' --always --tags) diff --git a/README.md b/README.md index c21c48d..fb47c67 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,13 @@ with the following content, and recompile the containerd binary: ```go /* Copyright The containerd Authors. + Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. From 20151ef4370e1e298de26f1be54685166665f46c Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 19 Mar 2021 01:56:32 +0900 Subject: [PATCH 3/4] add containerd subproject docs Signed-off-by: Akihiro Suda --- MAINTAINERS | 4 ++++ README.md | 11 +++++++++++ 2 files changed, 15 insertions(+) create mode 100644 MAINTAINERS diff --git a/MAINTAINERS b/MAINTAINERS new file mode 100644 index 0000000..a35ce28 --- /dev/null +++ b/MAINTAINERS @@ -0,0 +1,4 @@ +# fuse-overlayfs-snapshotter maintainers +# +# As a containerd sub-project, containerd maintainers are also included from https://github.com/containerd/project/blob/master/MAINTAINERS. +# See https://github.com/containerd/project/blob/master/GOVERNANCE.md for description of maintainer role diff --git a/README.md b/README.md index fb47c67..5d6de73 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ You do NOT need this `fuse-overlayfs` plugin on the following environments, beca - [Debian 10 kernel](https://salsa.debian.org/kernel-team/linux/blob/283390e7feb21b47779b48e0c8eb0cc409d2c815/debian/patches/debian/overlayfs-permit-mounts-in-userns.patch) - Debian 10 needs `sudo modprobe overlay permit_mounts_in_userns=1`. Future release of Debian with kernel >= 5.11 will not need this `modprobe` hack. +fuse-overlayfs-snapshotter is a **non-core** sub-project of containerd. + ## Requirements * kernel >= 4.18 * containerd >= 1.4 @@ -146,3 +148,12 @@ To run the test as a non-root user, [RootlessKit](https://github.com/rootless-co ```console $ go test -exec rootlesskit -test.v -test.root ``` + +## Project details +fuse-overlayfs-snapshotter is a containerd **non-core** sub-project, licensed under the [Apache 2.0 license](./LICENSE). +As a containerd non-core sub-project, you will find the: + * [Project governance](https://github.com/containerd/project/blob/master/GOVERNANCE.md), + * [Maintainers](./MAINTAINERS), + * and [Contributing guidelines](https://github.com/containerd/project/blob/master/CONTRIBUTING.md) + +information in our [`containerd/project`](https://github.com/containerd/project) repository. From f98aa45d8ded12101c5ee092dc10ff8e827ed3ae Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 19 Mar 2021 02:00:52 +0900 Subject: [PATCH 4/4] CI: add containerd/project-checks Signed-off-by: Akihiro Suda --- .github/workflows/main.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 6e3e4a1..1880cb3 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -5,6 +5,22 @@ on: branches: - master jobs: + project: + name: Project Checks + runs-on: ubuntu-20.04 + timeout-minutes: 20 + steps: + - uses: actions/setup-go@v2 + with: + go-version: 1.16.x + - uses: actions/checkout@v2 + with: + path: src/github.com/containerd/fuse-overlayfs-snapshotter + fetch-depth: 25 + - uses: containerd/project-checks@v1 + with: + working-directory: src/github.com/containerd/fuse-overlayfs-snapshotter + test: runs-on: ubuntu-20.04 timeout-minutes: 30