You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@teaclave.apache.org by GitBox <gi...@apache.org> on 2020/05/27 03:52:48 UTC
[GitHub] [incubator-teaclave] m4sterchain commented on a change in pull request #315: Polish and improve documentation
m4sterchain commented on a change in pull request #315:
URL: https://github.com/apache/incubator-teaclave/pull/315#discussion_r430093992
##########
File path: third_party/README.md
##########
@@ -1,25 +1,21 @@
-# Dependencies and Rust Packages (Crates) Vendoring
+---
+permalink: /third-party
+---
-In order to ease auditing, ensure product stability, as well as reduce the
-possibility of the [supply chain
-attack](https://en.wikipedia.org/wiki/Supply_chain_attack), we vendored all TEE
-dependencies here. During the build process, the trusted components will only
-consumes packages from this designated repository and will not download any code
-from external sources such as [crates.io](https://crates.io).
+# Third-Party Dependency Vendoring
-## To Add A New Vendored Dependency
+For Teaclave, since all dependencies are part of trusted computing base (TCB),
Review comment:
all SGX/Enclave dependencies
##########
File path: third_party/README.md
##########
@@ -1,25 +1,21 @@
-# Dependencies and Rust Packages (Crates) Vendoring
+---
+permalink: /third-party
+---
-In order to ease auditing, ensure product stability, as well as reduce the
-possibility of the [supply chain
-attack](https://en.wikipedia.org/wiki/Supply_chain_attack), we vendored all TEE
-dependencies here. During the build process, the trusted components will only
-consumes packages from this designated repository and will not download any code
-from external sources such as [crates.io](https://crates.io).
+# Third-Party Dependency Vendoring
-## To Add A New Vendored Dependency
+For Teaclave, since all dependencies are part of trusted computing base (TCB),
+in order to ease auditing, ensure product stability, as well as reduce the
+possibility of the [supply chain attack](https://en.wikipedia.org/wiki/Supply_chain_attack),
+we vendored all TEE dependencies here. During the build process, both the
+untrusted (i.e., the app part) and trusted components (i.e., the enclave part)
+will only consumes packages from this designated repository and will not
Review comment:
will only comsumes -> only comsume
##########
File path: function/README.md
##########
@@ -0,0 +1,23 @@
+---
+permalink: /function
+---
+
+# Built-in Functions
+
+Since Teaclave is a FaaS-like platform, users can define and register customized
+functions (e.g., written in Python). To make data computation more easier and
+faster (in native speed), the platform also provide some commonly used functions
+written in Rust. We call them built-in functions. These functions can be
+selectively compiled in the *built-in executor* with a "builtin" prefix in the
+function names.
Review comment:
Users can selectively invoke these build-in functions by their names.
##########
File path: third_party/README.md
##########
@@ -1,25 +1,21 @@
-# Dependencies and Rust Packages (Crates) Vendoring
+---
+permalink: /third-party
+---
-In order to ease auditing, ensure product stability, as well as reduce the
-possibility of the [supply chain
-attack](https://en.wikipedia.org/wiki/Supply_chain_attack), we vendored all TEE
-dependencies here. During the build process, the trusted components will only
-consumes packages from this designated repository and will not download any code
-from external sources such as [crates.io](https://crates.io).
+# Third-Party Dependency Vendoring
-## To Add A New Vendored Dependency
+For Teaclave, since all dependencies are part of trusted computing base (TCB),
+in order to ease auditing, ensure product stability, as well as reduce the
+possibility of the [supply chain attack](https://en.wikipedia.org/wiki/Supply_chain_attack),
+we vendored all TEE dependencies here. During the build process, both the
+untrusted (i.e., the app part) and trusted components (i.e., the enclave part)
+will only consumes packages from this designated repository and will not
+download any code from external package registry such as
+[crates.io](https://crates.io).
-If a crate is not available in the vendor directory, it can to be added with
-the following steps:
-
-1. Add the crates you need in the corresponding Cargo.toml (e.g.
- [crates-sgx/Cargo.toml](https://github.com/mesalock-linux/crates-sgx/blob/master/Cargo.toml))
-and update the crate list in the README.txt (e.g.
-[crates-sgx/README.txt](https://github.com/mesalock-linux/crates-sgx/blob/master/README.txt)).
-2. Run ``cargo build`` and ensure that it passes.
-3. Run ``cargo vendor`` and update the config file (e.g. crates-sgx/config).
- You may also utilize
-[crates-sgx/Makefile](https://github.com/mesalock-linux/crates-sgx/blob/master/Makefile)
-for automation.
-4. ``git add/commit`` the changes of
- Cargo.toml/Cargo.lock/config/README.txt/vendor and submit a pull request.
+Basically, we have these submodules:
+ - `crates-io`: Rust crates vendored from crates.io.
Review comment:
for non-SGX components.
##########
File path: function/README.md
##########
@@ -0,0 +1,23 @@
+---
+permalink: /function
+---
+
+# Built-in Functions
+
+Since Teaclave is a FaaS-like platform, users can define and register customized
+functions (e.g., written in Python). To make data computation more easier and
+faster (in native speed), the platform also provide some commonly used functions
+written in Rust. We call them built-in functions. These functions can be
+selectively compiled in the *built-in executor* with a "builtin" prefix in the
+function names.
Review comment:
+ Users can selectively invoke these build-in functions by their names.
##########
File path: function/README.md
##########
@@ -0,0 +1,23 @@
+---
+permalink: /function
+---
+
+# Built-in Functions
+
+Since Teaclave is a FaaS-like platform, users can define and register customized
+functions (e.g., written in Python). To make data computation more easier and
+faster (in native speed), the platform also provide some commonly used functions
+written in Rust. We call them built-in functions. These functions can be
+selectively compiled in the *built-in executor* with a "builtin" prefix in the
+function names.
Review comment:
\+ Users can selectively invoke these build-in functions by their names.
##########
File path: third_party/README.md
##########
@@ -1,25 +1,21 @@
-# Dependencies and Rust Packages (Crates) Vendoring
+---
+permalink: /third-party
+---
-In order to ease auditing, ensure product stability, as well as reduce the
-possibility of the [supply chain
-attack](https://en.wikipedia.org/wiki/Supply_chain_attack), we vendored all TEE
-dependencies here. During the build process, the trusted components will only
-consumes packages from this designated repository and will not download any code
-from external sources such as [crates.io](https://crates.io).
+# Third-Party Dependency Vendoring
-## To Add A New Vendored Dependency
+For Teaclave, since all dependencies are part of trusted computing base (TCB),
+in order to ease auditing, ensure product stability, as well as reduce the
+possibility of the [supply chain attack](https://en.wikipedia.org/wiki/Supply_chain_attack),
+we vendored all TEE dependencies here. During the build process, both the
+untrusted (i.e., the app part) and trusted components (i.e., the enclave part)
+will only consumes packages from this designated repository and will not
+download any code from external package registry such as
+[crates.io](https://crates.io).
-If a crate is not available in the vendor directory, it can to be added with
-the following steps:
-
-1. Add the crates you need in the corresponding Cargo.toml (e.g.
- [crates-sgx/Cargo.toml](https://github.com/mesalock-linux/crates-sgx/blob/master/Cargo.toml))
-and update the crate list in the README.txt (e.g.
-[crates-sgx/README.txt](https://github.com/mesalock-linux/crates-sgx/blob/master/README.txt)).
-2. Run ``cargo build`` and ensure that it passes.
-3. Run ``cargo vendor`` and update the config file (e.g. crates-sgx/config).
- You may also utilize
-[crates-sgx/Makefile](https://github.com/mesalock-linux/crates-sgx/blob/master/Makefile)
-for automation.
-4. ``git add/commit`` the changes of
- Cargo.toml/Cargo.lock/config/README.txt/vendor and submit a pull request.
+Basically, we have these submodules:
+ - `crates-io`: Rust crates vendored from crates.io.
Review comment:
Rust crates vendored from crates.io for non-SGX components.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@teaclave.apache.org
For additional commands, e-mail: notifications-help@teaclave.apache.org