This is an automated email from the ASF dual-hosted git repository.
mssun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-teaclave.git
The following commit(s) were added to refs/heads/master by this push:
new fd1fd9d Add docs for worker (#312)
fd1fd9d is described below
commit fd1fd9d658e8bee76129bff3558e6cc076dd3ab9
Author: Mingshen Sun <[email protected]>
AuthorDate: Fri May 22 17:10:16 2020 -0700
Add docs for worker (#312)
---
README.md | 1 +
worker/README.md | 36 ++++++++++++++++++++++++++++++++++++
2 files changed, 37 insertions(+)
diff --git a/README.md b/README.md
index b122cab..47b7126 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,7 @@ platform, making computation on privacy-sensitive data safe
and simple.
### Codebase
- [Teaclave Services](services)
+- [Teaclave Worker](worker)
- [Function Executors](executor)
- [Configurations in Teaclave](config)
- [Data Center Attestation Service](dcap)
diff --git a/worker/README.md b/worker/README.md
new file mode 100644
index 0000000..1907a21
--- /dev/null
+++ b/worker/README.md
@@ -0,0 +1,36 @@
+---
+permalink: /worker
+---
+
+# Teaclave Worker
+
+The worker layer in Teaclave is a thin layer to manage executors and runtimes.
+There are several executors and runtime for different usage scenarios.
+Developers can customize and register different executors in a worker.
+
+This diagram demonstrates the relationship between the execution service,
+worker, executor and runtime.
+
+```
+ +-----------------------------------+
+ | Execution Service |
+ | +-----------------------------+ |
+ | | Worker | |
+ | | +----------+ +---------+ | |
+ | | | Executor | | Runtime | | |
+ | | +----------+ +---------+ | |
+ | +-----------------------------+ |
+ +-----------------------------------+
+```
+
+The execution service is a service instance to maintain communication with
other
+services through attested RPC, prepare data and related information for
function
+execution, execute a function with a *worker* and report execution result. The
+worker will prepare a proper *executor* and *runtime* combination, and then
+dispatch the function to the executor, which will eventually run the function.
+At the same time, the runtime will help to manage input and output data of
+functions and provide interfaces in executor.
+
+Currently, there are several executors (e.g., mesapy, builtin) and runtime
+(e.g., default, raw-io) are implemented and registered in worker. Please refer
+to the docs of executor and runtime for more details.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
