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

Improve the grammar and typo of some documents

Browse Source
This commit is contained in:
LI Qing 2021-05-26 12:06:58 +08:00 committed by Zongmin.Gu
parent 692dc57355
commit 76cee51251
3 changed files with 18 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/code_coverage.md
View File

@ -2,6 +2,4 @@
[![codecov](https://codecov.io/gh/occlum/occlum/branch/master/graph/badge.svg?token=FS22ULGGRC)](https://codecov.io/gh/occlum/occlum) [![codecov](https://codecov.io/gh/occlum/occlum/branch/master/graph/badge.svg?token=FS22ULGGRC)](https://codecov.io/gh/occlum/occlum)
Occlum is written in different languages. Only *Rust* code coverage is enabled, Occlum is written in several different programming languages(i.e., Rust, C and Assembly), and Rust is the major part, so we have only collected the code coverage for Rust so far. The code coverage data is collected through the `make test` and `make test-glibc` commands, it can be improved if we add more tests.
currently. Besides, the coverage data is only collected during `make test` and
`make test-glibc`. Adding more tests will improve the coverage data.

41
docs/dragonwell_install.md
View File

@ -1,33 +1,24 @@
# Dragonwell11 For Enclave # Dragonwell11 For Enclave
Dragonwell11 for enclave is an opensource project, see [here](https://github.com/alibaba/dragonwell11/tree/dragonwell-for-enclave). Dragonwell11 for enclave is a musl-based JDK version compatible with the Alpine Linux and Occlum, and it's an open source project, see [here](https://github.com/alibaba/dragonwell11/tree/dragonwell-for-enclave) for the code.
It's a musl-based JDK version compatible with Alpine platform and Occlum libos. Dragonwell11 for enclave will be built in a Alpine docker, Dragonwell11 for enclave must be built in the Alpine Docker container, you can change to the top path of Dragonwell11 project, then run the `./make.sh release` command to build it.
you can cd the top path of dragonwell11 project, will see make.sh and musl.sh files, then './make.sh release' begin to built dragonwell11 ## How to install
for enclave. We provide three ways to install the Dragonwell11 JDK image:
# How to install Dragonwell11 1. Download Dragonwell11 JDK image directly from the OSS, then unzip and copy it into the host path `/opt/occlum/toolchains/jvm`.
```
wget https://dragonwell.oss-cn-shanghai.aliyuncs.com/11/linux/x64/11.0.8.3-enclave/Dragonwell11-11.0.8.3.tar.gz
```
We provide three ways to install dragonwell11 jdk image: 2. Download Dragonwell11 `src.rpm` from OSS, the `src.rpm` will build dragonwell11 project and then install the image automatically. The `src.rpm` contains the source code and spec file of Dragonwell11, it will build Dragonwell11 and then copy the built image into host path `/opt/occlum/toolchains/jvm`. Be cautious that Docker container should not work in root mode.
```
wget https://dragonwell.oss-cn-shanghai.aliyuncs.com/11/linux/x64/11.0.8.3-enclave/Dragonwell11-11.0.8.3-EnclaveExperimental.src.rpm rpm -ivh dragonwell11-for-enclave-11.0.8.3-EnclaveExperimental.src.rpm --nodeps --force
```
1. download dragonwell11 jdk image directly from oss, then decompress and copy it into host path /opt/occlum/toolchains/jvm 3. Download Dragonwell11 rpm file from OSS, the rpm file contains the JDK image and spec file of Dragonwell11. It will not build the Dragonwell11 from source code, but install the JDK image directly, which will copy the Dragonwell11 image into host path `/opt/occlum/toolchains/jvm`.
```
wget https://dragonwell.oss-cn-shanghai.aliyuncs.com/11/linux/x64/11.0.8.3-enclave/Dragonwell11-11.0.8.3.tar.gz wget https://dragonwell.oss-cn-shanghai.aliyuncs.com/11/linux/x64/11.0.8.3-enclave/Dragonwell11-11.0.8.3-EnclaveExperimental.x86_64.rpm rpm -ivh dragonwell11-for-enclave-11.0.8.3-EnclaveExperimental.x86_64.rpm --nodeps --force
```
2. download dragonwell11 src.rpm from oss, the src.rpm will build dragonwell11 project and then install the image automatically.
src.rpm contains dragonwell11 source code and spec file, it will build dragonwell11 and then copy the built image into
host path /opt/occlum/toolchains/jvm. Be cautious that docker should not work in root mode.
wget https://dragonwell.oss-cn-shanghai.aliyuncs.com/11/linux/x64/11.0.8.3-enclave/Dragonwell11-11.0.8.3-EnclaveExperimental.src.rpm
rpm -ivh dragonwell11-for-enclave-11.0.8.3-EnclaveExperimental.src.rpm --nodeps --force
3. download dragonwell11 rpm from oss, the .rpm contains dragonwell11 jdk image and spec file. it will not build the dragonwell11
source code, but install the jdk image directly, which will copy the dragonwell11 image into host path /opt/occlum/toolchains/jvm.
wget https://dragonwell.oss-cn-shanghai.aliyuncs.com/11/linux/x64/11.0.8.3-enclave/Dragonwell11-11.0.8.3-EnclaveExperimental.x86_64.rpm
rpm -ivh dragonwell11-for-enclave-11.0.8.3-EnclaveExperimental.x86_64.rpm --nodeps --force

2
docs/encrypted_image.md
View File

@ -1,5 +1,5 @@
# The Encrypted FS Image # The Encrypted FS Image
Since 0.21.1, Occlum has supported using an encrypted FS image, which is encrypted by a user-provided key, to run apps inside the enclave. The confidentiality and integrity of user's files and libraries are both protected with it. Since 0.22.0, Occlum has supported using an encrypted FS image, which is encrypted by a user-provided key, to run apps inside the enclave. The confidentiality and integrity of user's files and libraries are both protected with it.
## How to use ## How to use
To generate the encrypted FS image, user must give the `--image-key <key_path>` flag in the `occlum build` command (If the flag is not given, the secure FS image will be integrity protected only). The `<key_path>` refers to a file consisting of a 128-bit key and the user can generate it via the `occlum gen-image-key <key_path>` command. To generate the encrypted FS image, user must give the `--image-key <key_path>` flag in the `occlum build` command (If the flag is not given, the secure FS image will be integrity protected only). The `<key_path>` refers to a file consisting of a 128-bit key and the user can generate it via the `occlum gen-image-key <key_path>` command.