Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for the file agent and examples directory (#335)
- Loading branch information
Showing
4 changed files
with
46 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,23 @@ | ||
examples | ||
--- | ||
permalink: /examples | ||
--- | ||
|
||
# Examples | ||
|
||
In this directory, we implement some examples to illustrate how to register | ||
input/output data for a function, create and invoke a task and get execution | ||
results with the Teclave's client SDK in both single and multi-party setups. | ||
|
||
Before trying these examples, please make sure all services in the Teaclave | ||
platform has been properly launched. Also, for examples implemented in Python, | ||
don't forget to set the `PYTHONPATH` to the `sdk` path so that the scripts can | ||
successfully import the `teaclave` module. | ||
|
||
For instance, use the following command to invoke an echo function in Teaclave: | ||
|
||
``` | ||
$ PYTHONPATH=../../sdk/python python3 builtin_echo.py 'Hello, Teaclave!' | ||
``` | ||
|
||
Please checkout the sources of these examples to learn more about the process of | ||
invoking a function in Teaclave. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
permalink: /file-agent | ||
--- | ||
|
||
# File Agent | ||
|
||
The file agent is a component in the execution service. The main function is to | ||
handle file downloading/uploading from and to various storage service providers | ||
(e.g., AWS S3). | ||
|
||
Before executing a task, the execution service will use the file agent to | ||
prepare any registered input files comes with the task. For example, the | ||
registered file input could be a presigned URL from AWS S3. The file agent will | ||
download and prepare the file in local. With these files in the local storage, | ||
the executor can finally invoke the function. Similarly, after the task is | ||
successfully executed, the file agent will help to upload the output files to | ||
a remote file storage like S3. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters