Skip to content

Commit 343b60b

Browse files
naoki9911naoki9911
committed
release v0.1.0
Signed-off-by: Naoki MATSUMOTO <m.naoki9911@gmail.com>
0 parents  commit 343b60b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+3871
-0
lines changed

‎.github/workflows/e2e.yaml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: "E2E test with kind"
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
e2e-with-kind:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: docker/setup-buildx-action@v1
15+
- name: Expose GitHub Runtime
16+
uses: crazy-max/ghaction-github-runtime@v2
17+
# buildkit requires $ACTIONS_CACHE_URL and $ACTIONS_RUNTIME_TOKEN for GHA build cache
18+
- name: e2e-test
19+
run: |
20+
make test-e2e

‎.github/workflows/publish-image.yaml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: "Publish Container Image"
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
8+
jobs:
9+
publish-image:
10+
runs-on: ubuntu-latest
11+
env:
12+
STAGINGVERSION: ${{ github.ref_name }}
13+
PUBLISH_IMAGE: true
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: docker/setup-buildx-action@v1
17+
- name: Login to GitHub Container Registry
18+
uses: docker/login-action@v2
19+
with:
20+
registry: ghcr.io
21+
username: ${{ github.actor }}
22+
password: ${{ secrets.GITHUB_TOKEN }}
23+
- name: Expose GitHub Runtime
24+
uses: crazy-max/ghaction-github-runtime@v2
25+
# buildkit requires $ACTIONS_CACHE_URL and $ACTIONS_RUNTIME_TOKEN for GHA build cache
26+
- name: publish image
27+
run: |
28+
make build-driver
29+
make build-examples

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/bin

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎Makefile

+139
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Copyright 2018 The Kubernetes Authors.
2+
# Copyright 2022 Google LLC
3+
# Copyright 2023 Preferred Networks, Inc.
4+
#
5+
# Licensed under the Apache License, Version 2.0 (the "License");
6+
# you may not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
17+
export STAGINGVERSION ?= $(shell git describe --long --tags --match='v*' --dirty 2>/dev/null || git rev-list -n1 HEAD)
18+
export BUILD_DATE ?= $(shell date --iso-8601=minutes)
19+
BINDIR ?= bin
20+
LDFLAGS ?= -s -w -X main.version=${STAGINGVERSION} -X main.builddate=${BUILD_DATE} -extldflags '-static'
21+
22+
DRIVER_BINARY = meta-fuse-csi-plugin
23+
STARTER_BINARY = fuse-starter
24+
FUSERMOUNT3PROXY_BINARY = fusermount3-proxy
25+
26+
REGISTRY ?= ghcr.io/pfnet-research/meta-fuse-csi-plugin
27+
DRIVER_IMAGE = ${REGISTRY}/${DRIVER_BINARY}
28+
STARTER_IMAGE = ${REGISTRY}/${STARTER_BINARY}
29+
EXAMPLE_IMAGE = ${REGISTRY}/mfcp-example
30+
31+
DOCKER_BUILD_ARGS ?= --load --build-arg STAGINGVERSION=${STAGINGVERSION}
32+
ifneq ("$(shell docker buildx build --help | grep 'provenance')", "")
33+
DOCKER_BUILD_ARGS += --provenance=false
34+
endif
35+
36+
LOAD_TO_KIND ?= false
37+
PUBLISH_IMAGE ?= false
38+
39+
$(info STAGINGVERSION is ${STAGINGVERSION})
40+
$(info DRIVER_IMAGE is ${DRIVER_IMAGE})
41+
$(info STARTER_IMAGE is ${STARTER_IMAGE})
42+
43+
.PHONY: all build-image-linux-amd64
44+
45+
all: build-driver build-examples
46+
47+
driver:
48+
mkdir -p ${BINDIR}
49+
CGO_ENABLED=0 GOOS=linux GOARCH=$(shell dpkg --print-architecture) go build -ldflags "${LDFLAGS}" -o ${BINDIR}/${DRIVER_BINARY} cmd/csi_driver/main.go
50+
51+
fuse-starter:
52+
mkdir -p ${BINDIR}
53+
CGO_ENABLED=0 GOOS=linux GOARCH=$(shell dpkg --print-architecture) go build -ldflags "${LDFLAGS}" -o ${BINDIR}/${STARTER_BINARY} cmd/fuse_starter/main.go
54+
55+
fusermount3-proxy:
56+
mkdir -p ${BINDIR}
57+
CGO_ENABLED=0 GOOS=linux GOARCH=$(shell dpkg --print-architecture) go build -ldflags "${LDFLAGS}" -o ${BINDIR}/${FUSERMOUNT3PROXY_BINARY} cmd/fusermount3-proxy/main.go
58+
59+
build-driver:
60+
$(eval IMAGE_NAME := ${DRIVER_IMAGE}:${STAGINGVERSION})
61+
docker buildx build ${DOCKER_BUILD_ARGS} ${DOCKER_CACHE_ARGS} \
62+
--file ./cmd/csi_driver/Dockerfile \
63+
--tag ${IMAGE_NAME} \
64+
--platform linux/amd64 .
65+
if [ "${PUBLISH_IMAGE}" = "true" ]; then \
66+
docker push ${IMAGE_NAME}; \
67+
docker tag ${IMAGE_NAME} ${DRIVER_IMAGE}:latest; \
68+
docker push ${DRIVER_IMAGE}:latest; \
69+
fi
70+
if [ "${LOAD_TO_KIND}" = "true" ]; then \
71+
kind load docker-image ${IMAGE_NAME};\
72+
fi
73+
74+
define build-example-template
75+
ifneq ("$(EXAMPLES)", "")
76+
EXAMPLES += build-example-$(1)-$(2)
77+
else
78+
EXAMPLES := build-example-$(1)-$(2)
79+
endif
80+
81+
.PHONY: build-example-$1-$2
82+
build-example-$(1)-$(2):
83+
$(eval IMAGE_NAME := ${EXAMPLE_IMAGE}-$1-$2:${STAGINGVERSION})
84+
docker buildx build ${DOCKER_BUILD_ARGS} ${DOCKER_CACHE_ARGS} \
85+
--file ./examples/$1/$2/Dockerfile \
86+
--tag ${IMAGE_NAME} \
87+
--platform linux/amd64 .
88+
if [ "${PUBLISH_IMAGE}" = "true" ]; then \
89+
docker push ${IMAGE_NAME}; \
90+
docker tag ${IMAGE_NAME} ${EXAMPLE_IMAGE}-$1-$2:latest; \
91+
docker push ${EXAMPLE_IMAGE}-$1-$2:latest; \
92+
fi
93+
if [ "${LOAD_TO_KIND}" = "true" ]; then \
94+
kind load docker-image ${IMAGE_NAME};\
95+
fi
96+
endef
97+
98+
$(eval $(call build-example-template,proxy,mountpoint-s3))
99+
$(eval $(call build-example-template,proxy,goofys))
100+
$(eval $(call build-example-template,proxy,s3fs))
101+
$(eval $(call build-example-template,proxy,ros3fs))
102+
$(eval $(call build-example-template,proxy,gcsfuse))
103+
$(eval $(call build-example-template,proxy,sshfs))
104+
$(eval $(call build-example-template,starter,ros3fs))
105+
$(eval $(call build-example-template,starter,sshfs))
106+
107+
$(info $(EXAMPLES))
108+
109+
.PHONY: build-examples
110+
build-examples: $(EXAMPLES)
111+
112+
define test-example-template
113+
ifneq ("$(EXAMPLES)", "")
114+
EXAMPLE_TESTS += test-example-$(1)-$(2)
115+
else
116+
EXAMPLE_TESTS := test-example-$(1)-$(2)
117+
endif
118+
119+
.PHONY: test-example-$1-$2
120+
test-example-$(1)-$(2):
121+
./examples/check.sh ./$1/$2 mfcp-example-$1-$2 $3 $4 $5 $6
122+
endef
123+
124+
$(eval $(call test-example-template,proxy,mountpoint-s3,starter,/test.txt,busybox,/data/test.txt))
125+
$(eval $(call test-example-template,proxy,goofys,starter,/test.txt,busybox,/data/test.txt))
126+
$(eval $(call test-example-template,proxy,s3fs,starter,/test.txt,busybox,/data/test.txt))
127+
$(eval $(call test-example-template,proxy,ros3fs,starter,/test.txt,busybox,/data/test.txt))
128+
$(eval $(call test-example-template,proxy,sshfs,starter,/root/sshfs-example/test.txt,busybox,/data/test.txt))
129+
$(eval $(call test-example-template,starter,ros3fs,starter,/test.txt,busybox,/data/test.txt))
130+
$(eval $(call test-example-template,starter,sshfs,starter,/root/sshfs-example/test.txt,busybox,/data/test.txt))
131+
132+
.PHONY: test-examples
133+
test-examples: $(EXAMPLE_TESTS)
134+
135+
.PHONY: test-e2e
136+
test-e2e:
137+
- kind delete cluster
138+
kind create cluster
139+
./test_e2e.sh

0 commit comments

Comments
 (0)