Repository: incubator-pirk Updated Branches: refs/heads/gh-pages [created] 55d73394c
http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/e6753b26/people_pirk.md ---------------------------------------------------------------------- diff --git a/people_pirk.md b/people_pirk.md new file mode 100644 index 0000000..f3a5be2 --- /dev/null +++ b/people_pirk.md @@ -0,0 +1,49 @@ +--- +title: People +skiph1fortitle: true +nav: nav_peoplepirk +--- + +## PMC Members + +{: .table .table-striped} +| username | name | +|---------------|-------------------| +| tbrown | Tracy Brown | +| tellison | Tim Ellison | +| elserj | Josh Elser | +| charris | Chris Harris | +| smarthi | Suneel Marthi | +| raydulany | Walter Ray-Dulany | +| billie | Billie Rinaldi | +| jacobwilder | Jacob Wilder | +| eawilliams | Ellison Anne Williams | +| joewitt | Joe Witt | + +## Contributors + +{: .table .table-striped} +| username | name | +|---------------|-------------------| +| tbrown | Tracy Brown | +| charris | Chris Harris | +| raydulany | Walter Ray-Dulany | +| jacobwilder | Jacob Wilder | +| eawilliams | Ellison Anne Williams | + + +## Mentors + +Many thanks to our awesome incubation mentors! + +{: .table .table-striped} +| username | name | +|---------------|-------------------| +| tellison | Tim Ellison | +| elserj | Josh Elser | +| smarthi | Suneel Marthi | +| billie | Billie Rinaldi | +| joewitt | Joe Witt | + + + http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/e6753b26/pirk_papers.md ---------------------------------------------------------------------- diff --git a/pirk_papers.md b/pirk_papers.md new file mode 100644 index 0000000..d9dc7b5 --- /dev/null +++ b/pirk_papers.md @@ -0,0 +1,6 @@ +--- +title: Papers +nav: nav_papers +--- + +The Wideskies paper may be found [here] http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/e6753b26/releasing.md ---------------------------------------------------------------------- diff --git a/releasing.md b/releasing.md new file mode 100755 index 0000000..bc3d153 --- /dev/null +++ b/releasing.md @@ -0,0 +1,6 @@ +--- +title: Making a Release +nav: nav_releasing +--- + +Information regarding how to make a release for Apache Pirk coming soon! http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/e6753b26/roadmap/index.md ---------------------------------------------------------------------- diff --git a/roadmap/index.md b/roadmap/index.md new file mode 100644 index 0000000..5100c52 --- /dev/null +++ b/roadmap/index.md @@ -0,0 +1,32 @@ +--- +title: Roadmap +nav: nav_roadmap +--- + +The Pirk roadmap includes both implementation and algorithmic components. + +## Implementation Roadmap + +### Input Adaptors +* [HBase](https://hbase.apache.org/) +* [Accumulo](https://accumulo.apache.org/) +* [Kafka](http://kafka.apache.org/) +* [NiFi](https://nifi.apache.org/) + +### Streaming Wideskies Implementations +* [Storm](http://storm.apache.org/) +* [Heron](https://github.com/twitter/heron) +* [Spark Streaming](http://spark.apache.org/streaming/) +* [Flink](https://flink.apache.org/) + +### Batch Wideskies Implementations +* [Flink](https://flink.apache.org/) + +## Algorithmic Roadmap + +* Secure Multi Party Computation +* Secure/Private PIR Analytics +* Fully Homomorphic Encryption + +Improvements to Pirkâs documentation as well as itâs build and testing environments and optimizations to existing code/algorithms are also a component of the Pirk roadmap. + http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/e6753b26/roadmap/index.md~ ---------------------------------------------------------------------- diff --git a/roadmap/index.md~ b/roadmap/index.md~ new file mode 100644 index 0000000..4a5dad2 --- /dev/null +++ b/roadmap/index.md~ @@ -0,0 +1,32 @@ +--- +title: Roadmap +nav: nav_roadmap +--- + +The Pirk roadmap includes both implementation and algorithmic components. + +## Implementation Roadmap + +Input Adaptors + * HBase + * Accumulo + * Kafka + * NiFi + +Streaming Wideskies implementations + * Storm + * Heron + * Spark Streaming + * Flink + +Batch Wideskies Implementations + * Flink + +## Algorithmic Roadmap + +* Secure Multi Party Computation +* Secure/Private PIR Analytics +* Fully Homomorphic Encryption + +Improvements to Pirkâs documentation as well as itâs build and testing environments and optimizations to existing code/algorithms are also a component of the Pirk roadmap. + http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/e6753b26/verifying_releases.md ---------------------------------------------------------------------- diff --git a/verifying_releases.md b/verifying_releases.md new file mode 100755 index 0000000..ee9929a --- /dev/null +++ b/verifying_releases.md @@ -0,0 +1,78 @@ +--- +title: Verifying a Release +nav: nav_verify_release +--- + +This guide for the verification of a release candidate is meant to encapsulate +the requirements of the PMC set forth by the ASF. + +Verification of a release candidate can be broken down into three categories. + +## Pirk Correctness ## + +Pirk contains unit and integration tests which can be automatically run via Maven. These tests can be invoked by issues the following commands: + + $ mvn verify + +Additionally, Pirk contains multiple distributed tests which must be run and must pass on a live cluster: + + hadoop jar <pirkJar> test.distributed.DistributedTestDriver -j <full path to pirkJar> + + +## Foundation Level Requirements ## + +The ASF requires that all artifacts in a release are cryptographically signed and distributed with hashes. + +OpenPGP is an asymmetric encryption scheme which lends itself well to the globally distributed nature of Apache. +Verification of a release artifact can be done using the signature and the release-maker's public key. Hashes +can be verified using the appropriate command (e.g. `sha1sum`, `md5sum`). + +An Apache release must contain a source-only artifact. This is the official release artifact. While a release of +an Apache project can contain other artifacts that do contain binary files. These non-source artifacts are for +user convenience only, but still must adhere to the same licensing rules. + +PMC members should take steps to verify that the source-only artifact does not contain any binary files. There is +some leeway in this rule. For example, test-only binary artifacts (such as test files or jars) are acceptable as long +as they are only used for testing the software and not running it. + +The following are the aforementioned Foundation-level documents provided for reference: + +* [Applying the Apache Software License][2] +* [Legal's license application guidelines][3] +* [Common legal-discuss mailing list questions/resolutions][4] +* [ASF Legal Affairs Page][5] + +## Apache Software License Application ## + +Application of the Apache Software License v2 consists of the following steps on each artifact in a release. It's +important to remember that for artifacts that contain other artifacts (e.g. a tarball that contains JAR files or +an RPM which contains JAR files), both the tarball, RPM and JAR files are subject to the following roles. + +The difficulty in verifying each artifact is that, often times, each artifact requires a different LICENSE and NOTICE +file. + +### LICENSE file ### + +The LICENSE file should be present at the top-level of the artifact. This file should be explicitly named `LICENSE`, +however `LICENSE.txt` is acceptable but not preferred. This file contains the text of the Apache Software License +at the top of the file. At the bottom of the file, all other open source licenses _contained in the given +artifact_ must be listed at the bottom of the LICENSE file. Contained components that are licensed with the ASL themselves +do not need to be included in this file. It is common to see inclusions in file such as the MIT License of 3-clause +BSD License. + +### NOTICE file ### + +The NOTICE file should be present at the top-level of the artifact beside the LICENSE file. This file should be explicitly +name `NOTICE`, while `NOTICE.txt` is also acceptable but not preferred. This file contains the copyright notice for +the artifact being released. As a reminder, the copyright is held by the Apache Software Foundation, not the individual +project. + +The second purpose this file serves is to distribute third-party notices from dependent software. Specifically, other code +which is licensed with the ASLv2 may also contain a NOTICE file. If such an artifact which contains a NOTICE file is +contained in artifact being verified for releases, the contents of the contained artifact's NOTICE file should be appended +to this artifact's NOTICE file. + +[2]: https://www.apache.org/dev/apply-license +[3]: https://www.apache.org/legal/src-headers +[4]: https://www.apache.org/legal/resolved +[5]: https://www.apache.org/legal
