-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
500 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
*.log | ||
Makefile | ||
*.deb | ||
*.rpm |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Contributing to Folding@home Containers | ||
|
||
Contributions are always welcome. Things get better one patch at a time. | ||
|
||
#### File Issue First | ||
|
||
Any suggestions or bug reports should start with issue for tracking and | ||
discussion. We want to know about bugs as soon as possible. | ||
Features or changes should have discussion before work starts, so the work | ||
will fit the overall goals and architecture of the containers. | ||
|
||
Container issues: <https://github.com/foldingathome/containers/issues> | ||
|
||
#### Releace Cycle and Flow | ||
|
||
We will do our best to follow stable, tested versions of Folding@home | ||
software suitable for deployment. | ||
|
||
Standard "fork and pull request" git workflow. | ||
|
||
#### Commit Messages | ||
|
||
All commit messages should follow | ||
[Conventional Commits](https://www.conventionalcommits.org/) when possible. | ||
|
||
#### Pull Request Scope & Method | ||
|
||
Each pull request should address a single overall feature or bug if possible. | ||
If the change requires documentation updates those should be in the SAME | ||
pull request. | ||
This makes reviews easier, rollbacks manageable, and the history clearer. | ||
|
||
Merges will generally be done as "Squash and Merge" in most cases, so do not | ||
worry about having multiple commits. Commit messages will get consolidated. | ||
|
||
#### Formatting | ||
|
||
* Clarity over brevity. Comments, use long command arguments, etc. | ||
* Less than 80 columns whenever reasonable. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
CC0 1.0 Universal | ||
|
||
Statement of Purpose | ||
|
||
The laws of most jurisdictions throughout the world automatically confer | ||
exclusive Copyright and Related Rights (defined below) upon the creator and | ||
subsequent owner(s) (each and all, an "owner") of an original work of | ||
authorship and/or a database (each, a "Work"). | ||
|
||
Certain owners wish to permanently relinquish those rights to a Work for the | ||
purpose of contributing to a commons of creative, cultural and scientific | ||
works ("Commons") that the public can reliably and without fear of later | ||
claims of infringement build upon, modify, incorporate in other works, reuse | ||
and redistribute as freely as possible in any form whatsoever and for any | ||
purposes, including without limitation commercial purposes. These owners may | ||
contribute to the Commons to promote the ideal of a free culture and the | ||
further production of creative, cultural and scientific works, or to gain | ||
reputation or greater distribution for their Work in part through the use and | ||
efforts of others. | ||
|
||
For these and/or other purposes and motivations, and without any expectation | ||
of additional consideration or compensation, the person associating CC0 with a | ||
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright | ||
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work | ||
and publicly distribute the Work under its terms, with knowledge of his or her | ||
Copyright and Related Rights in the Work and the meaning and intended legal | ||
effect of CC0 on those rights. | ||
|
||
1. Copyright and Related Rights. A Work made available under CC0 may be | ||
protected by copyright and related or neighboring rights ("Copyright and | ||
Related Rights"). Copyright and Related Rights include, but are not limited | ||
to, the following: | ||
|
||
i. the right to reproduce, adapt, distribute, perform, display, communicate, | ||
and translate a Work; | ||
|
||
ii. moral rights retained by the original author(s) and/or performer(s); | ||
|
||
iii. publicity and privacy rights pertaining to a person's image or likeness | ||
depicted in a Work; | ||
|
||
iv. rights protecting against unfair competition in regards to a Work, | ||
subject to the limitations in paragraph 4(a), below; | ||
|
||
v. rights protecting the extraction, dissemination, use and reuse of data in | ||
a Work; | ||
|
||
vi. database rights (such as those arising under Directive 96/9/EC of the | ||
European Parliament and of the Council of 11 March 1996 on the legal | ||
protection of databases, and under any national implementation thereof, | ||
including any amended or successor version of such directive); and | ||
|
||
vii. other similar, equivalent or corresponding rights throughout the world | ||
based on applicable law or treaty, and any national implementations thereof. | ||
|
||
2. Waiver. To the greatest extent permitted by, but not in contravention of, | ||
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and | ||
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright | ||
and Related Rights and associated claims and causes of action, whether now | ||
known or unknown (including existing as well as future claims and causes of | ||
action), in the Work (i) in all territories worldwide, (ii) for the maximum | ||
duration provided by applicable law or treaty (including future time | ||
extensions), (iii) in any current or future medium and for any number of | ||
copies, and (iv) for any purpose whatsoever, including without limitation | ||
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes | ||
the Waiver for the benefit of each member of the public at large and to the | ||
detriment of Affirmer's heirs and successors, fully intending that such Waiver | ||
shall not be subject to revocation, rescission, cancellation, termination, or | ||
any other legal or equitable action to disrupt the quiet enjoyment of the Work | ||
by the public as contemplated by Affirmer's express Statement of Purpose. | ||
|
||
3. Public License Fallback. Should any part of the Waiver for any reason be | ||
judged legally invalid or ineffective under applicable law, then the Waiver | ||
shall be preserved to the maximum extent permitted taking into account | ||
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver | ||
is so judged Affirmer hereby grants to each affected person a royalty-free, | ||
non transferable, non sublicensable, non exclusive, irrevocable and | ||
unconditional license to exercise Affirmer's Copyright and Related Rights in | ||
the Work (i) in all territories worldwide, (ii) for the maximum duration | ||
provided by applicable law or treaty (including future time extensions), (iii) | ||
in any current or future medium and for any number of copies, and (iv) for any | ||
purpose whatsoever, including without limitation commercial, advertising or | ||
promotional purposes (the "License"). The License shall be deemed effective as | ||
of the date CC0 was applied by Affirmer to the Work. Should any part of the | ||
License for any reason be judged legally invalid or ineffective under | ||
applicable law, such partial invalidity or ineffectiveness shall not | ||
invalidate the remainder of the License, and in such case Affirmer hereby | ||
affirms that he or she will not (i) exercise any of his or her remaining | ||
Copyright and Related Rights in the Work or (ii) assert any associated claims | ||
and causes of action with respect to the Work, in either case contrary to | ||
Affirmer's express Statement of Purpose. | ||
|
||
4. Limitations and Disclaimers. | ||
|
||
a. No trademark or patent rights held by Affirmer are waived, abandoned, | ||
surrendered, licensed or otherwise affected by this document. | ||
|
||
b. Affirmer offers the Work as-is and makes no representations or warranties | ||
of any kind concerning the Work, express, implied, statutory or otherwise, | ||
including without limitation warranties of title, merchantability, fitness | ||
for a particular purpose, non infringement, or the absence of latent or | ||
other defects, accuracy, or the present or absence of errors, whether or not | ||
discoverable, all to the greatest extent permissible under applicable law. | ||
|
||
c. Affirmer disclaims responsibility for clearing rights of other persons | ||
that may apply to the Work or any use thereof, including without limitation | ||
any person's Copyright and Related Rights in the Work. Further, Affirmer | ||
disclaims responsibility for obtaining any necessary consents, permissions | ||
or other rights required for any use of the Work. | ||
|
||
d. Affirmer understands and acknowledges that Creative Commons is not a | ||
party to this document and has no duty or obligation with respect to this | ||
CC0 or use of the Work. | ||
|
||
For more information, please see | ||
http://creativecommons.org/publicdomain/zero/1.0/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,43 @@ | ||
# containers | ||
Docker containers for easily launching the Folding@home client anywhere! | ||
# Official Folding@home Containers | ||
|
||
The official Folding@home containers are designed to be simple and run | ||
in any container environment - desktop, laptop, Kubernetes, Helm, | ||
Docker Compose, OpenShift, Cloud... | ||
|
||
Containers track stable versions of the Folding@home Client. They will | ||
run on any Linux distribution, and are based on LTS version of Ubuntu, | ||
OpenCL, and CUDA libraries. They contain enough utilities to exec in and be | ||
able to debug any problems. | ||
|
||
## Containers | ||
|
||
* GPU container - [fah-gpu](fah-gpu/) | ||
|
||
## Deployments | ||
|
||
This repo will also container Helm templates and other deployment | ||
scripts/tools for a variety of environments. | ||
|
||
## Folding@home Container Design Rules | ||
|
||
* Containers will mount all read-write state, including config.xml | ||
which also has client state, into `/fah/`. | ||
* Containerized clients will output to stdout/sterr for container logs. | ||
* Containers are designed to be monitored via logs, and controlled with files. | ||
* No example configurations will expose ports, and that functionality will | ||
be configured off in examples. Folding@home was built to run on | ||
desktops/LANs, and currently should not be exposed to the internet. | ||
|
||
## Tags | ||
|
||
* `MAJOR.MINOR.PATCH` - follows Folding@home Client version. | ||
* `MAJOR.MINOR.PATCH-rc...` - test builds of the containers, stable clients. | ||
* `latest` - please never use latest in production, specify a version. Points | ||
at the latest released container. | ||
|
||
## Folding@home Websites | ||
|
||
* Folding@home: https://foldingathome.org/ | ||
* Folding@home Support Forum: <https://foldingforum.org/index.php> | ||
* Folding@home Containers GitHub: <https://github.com/foldingathome/containers/> | ||
* Folding@home Docker Hub: <https://hub.docker.com/u/foldingathome> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Folding@home GPU Container | ||
|
||
# CUDA 9.2 is chosen to be compatable with all drivers v396+ | ||
FROM nvidia/cuda:9.2-base-ubuntu18.04 | ||
LABEL description="Official Folding@home GPU Container" | ||
|
||
RUN apt-get update \ | ||
&& apt-get install -y --no-install-recommends \ | ||
ocl-icd-opencl-dev \ | ||
clinfo \ | ||
curl \ | ||
# point at lib mapped in by container runtime | ||
&& mkdir -p /etc/OpenCL/vendors \ | ||
&& echo "libnvidia-opencl.so.1" > /etc/OpenCL/vendors/nvidia.icd \ | ||
# next line gets past the fahclient.postinst | ||
&& mkdir -p /etc/fahclient && touch /etc/fahclient/config.xml \ | ||
# download and verify checksum | ||
&& curl -fsSL \ | ||
https://download.foldingathome.org/releases/public/release/fahclient/debian-stable-64bit/v7.5/fahclient_7.5.1_amd64.deb \ | ||
-o fah.deb \ | ||
&& echo "efe47061d328667259c1815b98bc6c37da339363fb8e9386673f6a96f4d37d26 fah.deb" \ | ||
| sha256sum -c --strict - \ | ||
# install and cleanup | ||
&& DEBIAN_FRONTEND=noninteractive dpkg --install --force-depends fah.deb \ | ||
&& rm -rf fah.deb \ | ||
&& apt-get purge --autoremove -y curl \ | ||
&& rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/* | ||
|
||
COPY README.md / | ||
|
||
WORKDIR "/fah" | ||
VOLUME ["/fah"] | ||
EXPOSE 7396 36330 | ||
|
||
ENTRYPOINT ["/usr/bin/FAHClient", "--chdir", "/fah"] |
Oops, something went wrong.