Skip to content

Commit 18ac2ff

Browse files
jealousjealous
committed
Setup external storage interface.
Details: * Remove DMO dependencies and codes. * Update class/package name. * Add skeleton for local implementation. * Add default local implementation.
0 parents  commit 18ac2ff

Some content is hidden

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

52 files changed

+6827
-0
lines changed

‎.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
*.swp
2+
core.[0-9][0-9]*
3+
tags
4+
GPATH
5+
GRTAGS
6+
GTAGS
7+
.nfs[0-9a-z]*
8+
.projectile
9+
10+
# Output Folders
11+
target
12+
test-output
13+
splash*.log*
14+
15+
# Output binaries
16+
src/main/resources/lib/
17+
18+
# IntelliJ
19+
*.iml
20+
.idea
21+

‎CONTRIBUTING.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing
2+
3+
## How to contribute
4+
Contributing is welcome in this project. We are using a light-weight process
5+
for all code changes.
6+
7+
Please file an issue describing the bug or feature you are trying to address
8+
before creating a PR(pull request). It would help the maintainer to better
9+
understand the problem.
10+
11+
After a PR is created, online CI will be triggered automatically.
12+
13+
### Development model
14+
Use [this branching model](https://nvie.com/posts/a-successful-git-branching-model/)
15+
as reference.
16+
* Create an issue in github.
17+
* Fork your own repo.
18+
* Create a new branch from `development` for your development.
19+
* Create a PR from your branch to the `development` branch
20+
* Make sure your PR meets the PR criteria.
21+
* Address the review comments.
22+
* Squash and merge your PR in the rebase way.
23+
24+
### PR criteria
25+
Please make sure your PR reaches following criteria:
26+
27+
* Include the issue number in your PR title like this:
28+
```
29+
[SPLASH-05] Add HDFS implementation...
30+
```
31+
So that github will do the favor of creating a link from your PR to the issue.
32+
* CI for the PR is passing.
33+
* Make sure you have a test to cover the change.
34+
* Test coverage of the overall project should not drop more than 0.5%.
35+
* If you are a new contributor, make sure to add your name to the contributors'
36+
list at the bottom of this file.
37+
38+
### Release
39+
Releases are published in github and central repository.
40+
Each release should include a release note including:
41+
* Major feature introduction
42+
* Fixed issue list
43+
* Known issue list
44+
* Contributor list
45+
* All release commits are available in `master`
46+
47+
### Develop Storage Plugin
48+
* Storage plugins should be developed in separate repositories for following
49+
reasons.
50+
* De-couple release cycles.
51+
* Release the test burden for each plugin.
52+
* Do not force plugin to be open source.
53+
* Plugins may require different running privileges.
54+
55+
## Governance
56+
57+
We starts with BDFL.
58+
* Existing maintainers work as gatekeepers for the PR.
59+
* 2 approvals are required for each PR.
60+
* Issues and proposals are discussed in Github issues.
61+
62+
## Contributors
63+
64+
### MemVerge
65+
* [Cedric Zhuang](https://github.com/jealous), [email protected]
66+
* [Sheperd Huang](https://github.com/sheperdh), [email protected]
67+
* [Zeyi Qi](https://github.com/czoey), [email protected]

‎LICENSE

Lines changed: 201 additions & 0 deletions
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.

‎README.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Splash
2+
3+
A shuffle manager for Spark that supports different storage plugin.
4+
5+
## Vision
6+
Supply a fast, flexible and reliable shuffle manager for big data frameworks
7+
that allows different storage to plugin.
8+
9+
## License
10+
[Apache License Version 2.0](LICENSE)
11+
12+
## Project Motivation
13+
14+
* Local shuffle has limitations on reliability and performance. Loose of a
15+
single node or local storage may seriously impact the performance of the
16+
whole cluster.
17+
* The performance of local disk IO is affecting the overall performance of the
18+
shuffle.
19+
* There is no easy/general solution to plugin external storage to existing
20+
shuffle service.
21+
22+
## Deployment
23+
### Spark
24+
* Include the jar file in your spark default configuration or task
25+
configuration.
26+
* Include the plugin jar in the same way.
27+
* Switch to the Splash shuffle manager with following option:
28+
```
29+
spark.shuffle.manager org.apache.spark.shuffle.sort.SplashShuffleManager
30+
```
31+
* The storage plugin could be switched at application level.
32+
* Support both on-premise and cloud deployments.
33+
34+
## Release
35+
* Release number follows [Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200)
36+
* Release is tracked in project's release page.
37+
38+
## Upgrade
39+
* Public API is not fixed until we reach version 1.0.0.
40+
* Do not promise backward compatibility if the first digit in version is changed.
41+
42+
## Service & Support
43+
* Questions could be raised in github issue and tagged with `question`.
44+
* Project documents are available in the
45+
46+
## Community
47+
You could communicate with us in following ways:
48+
* Start a new thread in [github issues](https://github.com/MemVerge/splash/issues)
49+
* Check our slack group for [Splash](https://splash-headquarters.slack.com/)
50+
* Request to join the WeChat group through [email](mailto://[email protected])
51+
which includes your WeChat ID.
52+
53+
## Build
54+
55+
* Use `mvn install` to build. Use `-DskipTests=true` option to disable UT.
56+
When the build process completes:
57+
* A fat jar will be generated at: `./target/splash-<version>-shaded.jar`
58+
* You can find the unit test result in: `./target/surefire-reports`
59+
* You can find the coverage report in: `./target/site/jacoco`
60+
61+
* Use `mvn clean` to clean the build output.
62+
63+
* Use `integration-test` or `mvn failsafe:integration-test -DskipIT=false`
64+
to run the integration tests. Those tests should connect to the actual File
65+
System.
66+
* IT result is available in: `./target/failsafe-reports`
67+
68+
* Use `mvn pmd:pmd` to run static code analysis.
69+
* Analysis report is available in: `./target/site/pmd.html`
70+
71+
## Options
72+
* `spark.shuffle.splash.storageFactory`:
73+
Specify the class name of your factory. This class must implement
74+
[`StorageFactory`](src/main/java/com/memverge/splash/StorageFactory.java)
75+
* `spark.shuffle.splash.clearShuffleOutput`: Boolean value telling the shuffle
76+
manager whether to clear the shuffle output or not when the shuffle stage
77+
completes.
78+
79+
## Plugin Development
80+
Splash uses plugins to support different storage. User could develop their own
81+
storage plugins for the shuffle manager. And different storage could be used
82+
based on the usage of the file. For detail, please check the
83+
[Plugin API](doc/Plugin_API.md) document.

‎clean

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/bin/bash
2+
mvn clean

0 commit comments

Comments
 (0)