general/occlum
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[readthedocs] Update occlum commands chapter

Browse Source
This commit is contained in:
Qi Zheng 2024-01-15 19:01:02 +08:00 committed by volcano
parent beeffcced7
commit ce2cbccdb8
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/readthedocs/docs/source/occlum_cmds.md
View File

@ -19,15 +19,25 @@ occlum init
Initialize a directory as the Occlum instance. Initialize a directory as the Occlum instance.
```bash ```bash
occlum build [--sign-key <key_path>] [--sign-tool <tool_path>] [--image-key <key_path>] [-f/--force] occlum build [--sign-key <key_path>] [--sign-tool <tool_path>] [--image-key <key_path>] [-f/--force] [--enable-edmm <Y/N>]
``` ```
Build and sign an Occlum SGX enclave (.so) and generate its associated secure FS image according to the user-provided image directory and Occlum.json config file. Build and sign an Occlum SGX enclave (.so) and generate its associated secure FS image according to the user-provided image directory and Occlum.json config file.
The whole building process is incremental: the building artifacts are built only The whole building process is incremental: the building artifacts are built only
when needed. when needed.
To force rebuilding all artifacts, give the [-f/--force] flag. To force rebuilding all artifacts, give the [-f/--force] flag.
EDMM feature is not enabled by default. To enable it, set ENABLE_EDMM during the Occlum build phase as below:
```
ENABLE_EDMM=Y occlum build
```
Or
```
occlum build --enable-edmm Y
```
Details please refer to [doc](https://occlum.readthedocs.io/en/latest/edmm_config_guide.html).
```bash ```bash
occlum run [--cpus <num_of_cpus>] <program_name> <program_args> occlum run <program_name> <program_args>
``` ```
Run the user program inside an SGX enclave. Run the user program inside an SGX enclave.