Skip to content

Commit

Permalink
Update usage / terms
Browse files Browse the repository at this point in the history
Adds PRIVACY.md with terms of use for public environment and
privacy statement.

Contributing guide is added to point at the main faas repo.

LICENSE file has been added to root of repository - contributions
were under MIT since they used the faas contributing guide. This
is now explicit and more visible.

Sample JSON files / event-snapshots for testing are moved to
their own folders to tidy up the root

Signed-off-by: Alex Ellis (VMware) <[email protected]>
  • Loading branch information
alexellis committed May 15, 2018
1 parent d0d49e0 commit 3d719b6
Show file tree
Hide file tree
Showing 13 changed files with 72 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Contributing

Please follow the [contribution guide for OpenFaaS](https://github.com/openfaas/faas/blob/master/CONTRIBUTING.md).

9 changes: 9 additions & 0 deletions DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,12 @@ Within a few seconds you'll have your function deployed and live with a prefix o
* Find out more

For more information get in touch directly for a private trial of the public service.

### Appendix for Kubernetes

The functions which make up OpenFaaS Cloud are compatible with Kubernetes but some additional work is needed for the registry to make it work as seamlessly as it does on Swarm. The of-builder should also be brought up using a Kubernetes YAML file instead of `docker run` / `docker service create`.

You will need to edit `buildshiprun_limits_swarm.yml` and change the unit value from `30m` to `30Mi` so that Kubernetes can make use of the value.

The way Kubernetes accesses the Docker registry will need a NodePort and a TLS cert (or an insecure-registry setting in the kubelet), so bear this in mind when working through the `of-builder` README.

22 changes: 22 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2016 Alex Ellis
Copyright (c) 2018 OpenFaaS Author(s)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
36 changes: 36 additions & 0 deletions PRIVACY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## OpenFaaS Cloud (hosted version)

This statement applies to the public, hosted version of OpenFaaS Cloud operated by Alex Ellis. When running OpenFaaS Cloud on your own OpenFaaS cluster these terms do not apply.

### Terms of use

In order to make use of OpenFaaS Cloud you need to consent to add a GitHub App to each of your GitHub repositories, you also need to add yourself to the CUSTOMERS file in this repository which maintains a list of all people participating in the public hosted environment. By adding your GitHub user account to the CUSTOMERS file you are giving consent for OpenFaaS Cloud to clone, build, and deploy your functions and make them available via a public HTTP endpoint.

The system is monitored and will be subjected to fair use policies.

The operator of OpenFaaS Cloud reserves the right to remove or revoke individual accounts from the public trial or to end the trial and remove the hosted service.

Please see the [LICENSE](./LICENSE.md) of the project for further details.

## Privacy policy

After having given consent for OpenFaaS Cloud to integrate with one or more of your GitHub repositories the following information will be recorded:

Within the OpenFaaS API:

* GitHub username
* GitHub repository name

Within container log files:

* GitHub username
* GitHub repository name

Your public GitHub repo will be cloned and built, if successful the resulting Docker image will be stored in a Docker registry. Your function will be deployed and a public endpoint will be exposed to access your function.

No secret information is stored in OpenFaaS Cloud and minimal access is granted through OAuth permission scopes including: read/write to statuses and reading repository contents.

Uninstalling

If you want to remove your endpoints from OpenFaaS Cloud please remove the GitHub app integration via your GitHub profile page and contact [email protected] to have your functions and container images removed from OpenFaaS Cloud.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,6 @@ A private, local registry is deployed inside the cluster.

*Conceptual diagram of how OpenFaaS Cloud integrates with GitHub*

You can set up and host your own *OpenFaaS Cloud* or contact [email protected] for instructions on how to participate in a public trial of a fully-hosted service.
You can set up and host your own *OpenFaaS Cloud* or contact [email protected] for instructions on how to participate in a public trial of a fully-hosted service. Read the privacy statement and terms and conditions for the hosted version of [OpenFaaS Cloud](./PRIVACY.md).

Read the [development guide](DEV.md) to find out more about the functions and to start hacking on OpenFaaS Cloud.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 3d719b6

Please sign in to comment.