diff --git a/demos/README.md b/demos/README.md index 1e4ba82a..9899c824 100644 --- a/demos/README.md +++ b/demos/README.md @@ -14,9 +14,13 @@ This set of demos shows how the Occlum toolchain can be used with different buil This set of demos shows how real-world apps can be easily run inside SGX enclaves with Occlum. +* [fish](fish/): A demo of [FISH](https://fishshell.com) shell script. +* [flink](flink/): A demo of [Apache Flink](https://flink.apache.org). +* [font](font/font_support_for_java): A demo of supporting font with Java. * [https_server](https_server/): A HTTPS file server based on [Mongoose Embedded Web Server Library](https://github.com/cesanta/mongoose). * [grpc](grpc/): A client and server communicating through [gRPC](https://grpc.io). * [openvino](openvino/) A benchmark of [OpenVINO Inference Engine](https://docs.openvinotoolkit.org/2019_R3/_docs_IE_DG_inference_engine_intro.html). +* [redis](redis/): A demo of [redis](https://redis.io). * [sqlite](sqlite/) A demo of [SQLite](https://www.sqlite.org) SQL database engine. * [tensorflow_lite](tensorflow_lite/): A demo and benchmark of [Tensorflow Lite](https://www.tensorflow.org/lite) inference engine. * [xgboost](xgboost/): A demo of [XGBoost](https://xgboost.readthedocs.io/en/latest). @@ -25,7 +29,7 @@ This set of demos shows how real-world apps can be easily run inside SGX enclave This set of demos shows how apps written with popular programming languages can be run inside SGX enclaves with Occlum. -* [golang](golang/): A [Golang](https://golang.org) web server demo app. +* [golang](golang/): A collection of [Golang](https://golang.org) program demos. * [java](java/): A demo of [Java](https://openjdk.java.net) program. * [python](python/) A demo of [Python](https://www.python.org) program. * [rust](rust/) A demo of [Rust](https://www.rust-lang.org) program. diff --git a/demos/flink/README.txt b/demos/flink/README.txt index e131673e..127e39d3 100644 --- a/demos/flink/README.txt +++ b/demos/flink/README.txt @@ -1,7 +1,9 @@ 1. Run the flink jobmanager ./run_flink_jobmanager_on_host.sh + 2. Run the taskManager ./run_flink_on_occlum_glibc.sh tm + 3. Run flink jobs example ./run_flink_on_occlum.sh task diff --git a/demos/font/font_support_for_java/README.md b/demos/font/font_support_for_java/README.md index 55deaee1..67755f2f 100644 --- a/demos/font/font_support_for_java/README.md +++ b/demos/font/font_support_for_java/README.md @@ -1,4 +1,4 @@ -# Make Occlum support font +# Support font with Java This project demonstrates how Occlum support font with a Java demo in SGX enclaves. @@ -10,26 +10,26 @@ Our demos use Dragonwell as the default JDK, you are free to change to OpenJDK b ## Demo: Java excel file writting with Poi -We provide a excel file writting demo to show how to make occlum support font inside SGX enclaves. +We provide an excel file writting demo to show how to make occlum support font inside SGX enclaves. ### Create demo and build it -Excel writting demo is created in create_java_font_app.sh, and the script also creates a build.gradle to build demo. Then a docker container is created to -build the demo and we will get a fat jar file. The docker container is based on Alpine, we will collect all dependency libs and font in document font-lib -from the container. +The excel writting demo is created in `create_java_font_app.sh`, and the script also creates a `build.gradle` to build demo. Then a docker container is created to build the demo and we will get a fat jar file. The docker container is based on Alpine, we will collect all dependent libs and font in document font-lib from the container. ### Run demo in Occlum container -Create occlum instance and copy all libs into occlum image which font dependence in occlum container, then build the occlum image and run the demo. +Create occlum instance and copy all libs into occlum image which font depends in occlum container, then build the occlum image and run the demo. ### How to Run -Step 1: Create and build demo, also collect font dependency occlum needs - +Step 1: Create and build demo, it also collects the font dependencies +``` ./create_java_font_app.sh +``` -Step 2: Create occlum instance and run the demo in occlum's latest docker image release - +Step 2: Create occlum instance and run the demo in occlum's latest docker image +``` docker run -it --device /dev/isgx --rm -v `pwd`:`pwd` -w `pwd` occlum/occlum:[latest version]-ubuntu18.04 `pwd`/run_java_font_app_internal.sh +``` -Step 3: To check whether it works, a Demo.xlsx file should be created in occlum image host path. +Step 3: To check whether it works, a `Demo.xlsx` file should be created in the host path of occlum instance. diff --git a/demos/redis/README.md b/demos/redis/README.txt similarity index 92% rename from demos/redis/README.md rename to demos/redis/README.txt index ae77fe46..82b18619 100644 --- a/demos/redis/README.md +++ b/demos/redis/README.txt @@ -1,16 +1,17 @@ -1.Download and build +1. Download and build occlum-gcc: ./download_and_build_redis.sh glibc: ./download_and_build_redis_glibc.sh + 2. Run redis occlum-gcc: ./run_occlum_redis.sh glibc: ./run_occlum_redis_glibc.sh + 3. Benchmark occlum-gcc: ./benchmark.sh glibc: ./benchmark_glibc.sh - diff --git a/docs/occlum_mount.md b/docs/occlum_mount.md index f9c49dc2..2a5b7459 100644 --- a/docs/occlum_mount.md +++ b/docs/occlum_mount.md @@ -37,6 +37,6 @@ mkdir Step 2: Mount the secure FS at the newly created mount point ``` -occlum mount [--sign-key ] [--sign-tool ] +occlum mount [--sign-key ] [--sign-tool ] [--image-key ] ``` After mounting the secure FS successfully, you can access and manipulate the FS from the mount point as easy as regular Linux FS.