Skip to content

Commit a5564f2

Browse files
committed
init
1 parent 2b0ad5d commit a5564f2

File tree

6 files changed

+500
-2
lines changed

6 files changed

+500
-2
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.log
2+
Makefile
3+
*.deb
4+
*.rpm

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to Folding@home Containers
2+
3+
Contributions are always welcome. Things get better one patch at a time.
4+
5+
#### File Issue First
6+
7+
Any suggestions or bug reports should start with issue for tracking and
8+
discussion. We want to know about bugs as soon as possible.
9+
Features or changes should have discussion before work starts, so the work
10+
will fit the overall goals and architecture of the containers.
11+
12+
Container issues: <https://github.com/foldingathome/containers/issues>
13+
14+
#### Releace Cycle and Flow
15+
16+
We will do our best to follow stable, tested versions of Folding@home
17+
software suitable for deployment.
18+
19+
Standard "fork and pull request" git workflow.
20+
21+
#### Commit Messages
22+
23+
All commit messages should follow
24+
[Conventional Commits](https://www.conventionalcommits.org/) when possible.
25+
26+
#### Pull Request Scope & Method
27+
28+
Each pull request should address a single overall feature or bug if possible.
29+
If the change requires documentation updates those should be in the SAME
30+
pull request.
31+
This makes reviews easier, rollbacks manageable, and the history clearer.
32+
33+
Merges will generally be done as "Squash and Merge" in most cases, so do not
34+
worry about having multiple commits. Commit messages will get consolidated.
35+
36+
#### Formatting
37+
38+
* Clarity over brevity. Comments, use long command arguments, etc.
39+
* Less than 80 columns whenever reasonable.

LICENSE

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
CC0 1.0 Universal
2+
3+
Statement of Purpose
4+
5+
The laws of most jurisdictions throughout the world automatically confer
6+
exclusive Copyright and Related Rights (defined below) upon the creator and
7+
subsequent owner(s) (each and all, an "owner") of an original work of
8+
authorship and/or a database (each, a "Work").
9+
10+
Certain owners wish to permanently relinquish those rights to a Work for the
11+
purpose of contributing to a commons of creative, cultural and scientific
12+
works ("Commons") that the public can reliably and without fear of later
13+
claims of infringement build upon, modify, incorporate in other works, reuse
14+
and redistribute as freely as possible in any form whatsoever and for any
15+
purposes, including without limitation commercial purposes. These owners may
16+
contribute to the Commons to promote the ideal of a free culture and the
17+
further production of creative, cultural and scientific works, or to gain
18+
reputation or greater distribution for their Work in part through the use and
19+
efforts of others.
20+
21+
For these and/or other purposes and motivations, and without any expectation
22+
of additional consideration or compensation, the person associating CC0 with a
23+
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
24+
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
25+
and publicly distribute the Work under its terms, with knowledge of his or her
26+
Copyright and Related Rights in the Work and the meaning and intended legal
27+
effect of CC0 on those rights.
28+
29+
1. Copyright and Related Rights. A Work made available under CC0 may be
30+
protected by copyright and related or neighboring rights ("Copyright and
31+
Related Rights"). Copyright and Related Rights include, but are not limited
32+
to, the following:
33+
34+
i. the right to reproduce, adapt, distribute, perform, display, communicate,
35+
and translate a Work;
36+
37+
ii. moral rights retained by the original author(s) and/or performer(s);
38+
39+
iii. publicity and privacy rights pertaining to a person's image or likeness
40+
depicted in a Work;
41+
42+
iv. rights protecting against unfair competition in regards to a Work,
43+
subject to the limitations in paragraph 4(a), below;
44+
45+
v. rights protecting the extraction, dissemination, use and reuse of data in
46+
a Work;
47+
48+
vi. database rights (such as those arising under Directive 96/9/EC of the
49+
European Parliament and of the Council of 11 March 1996 on the legal
50+
protection of databases, and under any national implementation thereof,
51+
including any amended or successor version of such directive); and
52+
53+
vii. other similar, equivalent or corresponding rights throughout the world
54+
based on applicable law or treaty, and any national implementations thereof.
55+
56+
2. Waiver. To the greatest extent permitted by, but not in contravention of,
57+
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
58+
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
59+
and Related Rights and associated claims and causes of action, whether now
60+
known or unknown (including existing as well as future claims and causes of
61+
action), in the Work (i) in all territories worldwide, (ii) for the maximum
62+
duration provided by applicable law or treaty (including future time
63+
extensions), (iii) in any current or future medium and for any number of
64+
copies, and (iv) for any purpose whatsoever, including without limitation
65+
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
66+
the Waiver for the benefit of each member of the public at large and to the
67+
detriment of Affirmer's heirs and successors, fully intending that such Waiver
68+
shall not be subject to revocation, rescission, cancellation, termination, or
69+
any other legal or equitable action to disrupt the quiet enjoyment of the Work
70+
by the public as contemplated by Affirmer's express Statement of Purpose.
71+
72+
3. Public License Fallback. Should any part of the Waiver for any reason be
73+
judged legally invalid or ineffective under applicable law, then the Waiver
74+
shall be preserved to the maximum extent permitted taking into account
75+
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
76+
is so judged Affirmer hereby grants to each affected person a royalty-free,
77+
non transferable, non sublicensable, non exclusive, irrevocable and
78+
unconditional license to exercise Affirmer's Copyright and Related Rights in
79+
the Work (i) in all territories worldwide, (ii) for the maximum duration
80+
provided by applicable law or treaty (including future time extensions), (iii)
81+
in any current or future medium and for any number of copies, and (iv) for any
82+
purpose whatsoever, including without limitation commercial, advertising or
83+
promotional purposes (the "License"). The License shall be deemed effective as
84+
of the date CC0 was applied by Affirmer to the Work. Should any part of the
85+
License for any reason be judged legally invalid or ineffective under
86+
applicable law, such partial invalidity or ineffectiveness shall not
87+
invalidate the remainder of the License, and in such case Affirmer hereby
88+
affirms that he or she will not (i) exercise any of his or her remaining
89+
Copyright and Related Rights in the Work or (ii) assert any associated claims
90+
and causes of action with respect to the Work, in either case contrary to
91+
Affirmer's express Statement of Purpose.
92+
93+
4. Limitations and Disclaimers.
94+
95+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
96+
surrendered, licensed or otherwise affected by this document.
97+
98+
b. Affirmer offers the Work as-is and makes no representations or warranties
99+
of any kind concerning the Work, express, implied, statutory or otherwise,
100+
including without limitation warranties of title, merchantability, fitness
101+
for a particular purpose, non infringement, or the absence of latent or
102+
other defects, accuracy, or the present or absence of errors, whether or not
103+
discoverable, all to the greatest extent permissible under applicable law.
104+
105+
c. Affirmer disclaims responsibility for clearing rights of other persons
106+
that may apply to the Work or any use thereof, including without limitation
107+
any person's Copyright and Related Rights in the Work. Further, Affirmer
108+
disclaims responsibility for obtaining any necessary consents, permissions
109+
or other rights required for any use of the Work.
110+
111+
d. Affirmer understands and acknowledges that Creative Commons is not a
112+
party to this document and has no duty or obligation with respect to this
113+
CC0 or use of the Work.
114+
115+
For more information, please see
116+
http://creativecommons.org/publicdomain/zero/1.0/

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# containers
2-
Docker containers for easily launching the Folding@home client anywhere!
1+
# Official Folding@home Containers
2+
3+
The official Folding@home containers are designed to be simple and run
4+
in any container environment - desktop, laptop, Kubernetes, Helm,
5+
Docker Compose, OpenShift, Cloud...
6+
7+
Containers track stable versions of the Folding@home Client. They will
8+
run on any Linux distribution, and are based on LTS version of Ubuntu,
9+
OpenCL, and CUDA libraries. They contain enough utilities to exec in and be
10+
able to debug any problems.
11+
12+
## Containers
13+
14+
* GPU container - [fah-gpu](fah-gpu/)
15+
16+
## Deployments
17+
18+
This repo will also container Helm templates and other deployment
19+
scripts/tools for a variety of environments.
20+
21+
## Folding@home Container Design Rules
22+
23+
* Containers will mount all read-write state, including config.xml
24+
which also has client state, into `/fah/`.
25+
* Containerized clients will output to stdout/sterr for container logs.
26+
* Containers are designed to be monitored via logs, and controlled with files.
27+
* No example configurations will expose ports, and that functionality will
28+
be configured off in examples. Folding@home was built to run on
29+
desktops/LANs, and currently should not be exposed to the internet.
30+
31+
## Tags
32+
33+
* `MAJOR.MINOR.PATCH` - follows Folding@home Client version.
34+
* `MAJOR.MINOR.PATCH-rc...` - test builds of the containers, stable clients.
35+
* `latest` - please never use latest in production, specify a version. Points
36+
at the latest released container.
37+
38+
## Folding@home Websites
39+
40+
* Folding@home: https://foldingathome.org/
41+
* Folding@home Support Forum: <https://foldingforum.org/index.php>
42+
* Folding@home Containers GitHub: <https://github.com/foldingathome/containers/>
43+
* Folding@home Docker Hub: <https://hub.docker.com/u/foldingathome>

fah-gpu/Dockerfile

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Folding@home GPU Container
2+
3+
# CUDA 9.2 is chosen to be compatable with all drivers v396+
4+
FROM nvidia/cuda:9.2-base-ubuntu18.04
5+
LABEL description="Official Folding@home GPU Container"
6+
7+
RUN apt-get update \
8+
&& apt-get install -y --no-install-recommends \
9+
ocl-icd-opencl-dev \
10+
clinfo \
11+
curl \
12+
# point at lib mapped in by container runtime
13+
&& mkdir -p /etc/OpenCL/vendors \
14+
&& echo "libnvidia-opencl.so.1" > /etc/OpenCL/vendors/nvidia.icd \
15+
# next line gets past the fahclient.postinst
16+
&& mkdir -p /etc/fahclient && touch /etc/fahclient/config.xml \
17+
# download and verify checksum
18+
&& curl -fsSL \
19+
https://download.foldingathome.org/releases/public/release/fahclient/debian-stable-64bit/v7.5/fahclient_7.5.1_amd64.deb \
20+
-o fah.deb \
21+
&& echo "efe47061d328667259c1815b98bc6c37da339363fb8e9386673f6a96f4d37d26 fah.deb" \
22+
| sha256sum -c --strict - \
23+
# install and cleanup
24+
&& DEBIAN_FRONTEND=noninteractive dpkg --install --force-depends fah.deb \
25+
&& rm -rf fah.deb \
26+
&& apt-get purge --autoremove -y curl \
27+
&& rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*
28+
29+
COPY README.md /
30+
31+
WORKDIR "/fah"
32+
VOLUME ["/fah"]
33+
EXPOSE 7396 36330
34+
35+
ENTRYPOINT ["/usr/bin/FAHClient", "--chdir", "/fah"]

0 commit comments

Comments
 (0)