To evaluate Occlum in non-docker environment, installers are needed. Occlum provides a variety of installers to support different scenarios. Users can choose to install different minimum subsets of Occlum installers to meet their needs.
- occlum-runtime: necessary binaries for
occlum run/exec. For deployment scenarios, this must be installed. - occlum-pal: only contains the Occlum PAL library (a thin layer to hide details of libOS and provide API for applications)
- occlum-sgx-tools: minimum dependencies from Intel SGX SDK e.g. sgx-gdb, sgx_sign
- occlum-toolchains-<language>: toolchain components for specific language
- occlum: complete package to support all Occlum commands.
occlum-toolchains-gccis also installed by default. Please install packages of other programming languages based on your need.
Normally, Occlum installers should be provided together with release. However, users can also build them on their own.
To build deb packages, a docker container with Occlum Ubuntu image (based on Ubuntu 20.04) is needed. Execute below commands under the occlum directory:
cd tools/installer/deb
make
and occlum deb installer can be found under build/debs.
If a user wants to build his application on a platform installed with Occlum installer, toolchain installers are also needed. To build language specific toolchain installer, just run the command:
cd tools/installer/deb
make <language option>
Now, only musl-gcc, glibc and golang options are supported. And the installer can be found under build/debs.
DEB installer should be found together with Occlum release package at this page. To run Occlum on clean Ubuntu 18.04, please follow below steps:
Step 1. Install Prerequisites
apt-get update
DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends libcurl4-openssl-dev libssl-dev libprotobuf-dev libfuse-dev autoconf automake make cmake libtool gdb python jq ca-certificates gnupg wget vim rsync
Step 2. Install Intel® SGX driver and Intel® SGX PSW Please follow Intel SGX Installation Guide to install SGX driver and SGX PSW. SGX SDK is not required. Using PSW installer is recommended.
To install PSW, follow the guide to add Intel® SGX repository to apt source. And then run:
apt-get update
apt-get install -y libsgx-epid libsgx-urts libsgx-quote-ex libsgx-uae-service libsgx-dcap-ql
After installing PSW, please make sure that the aesm service is running:
service aesmd status
Step 3. Install enable_RDFSBASE Kernel Module
Please follow this README to install enable_rdfsbase kernel module.
Step 4. Install Occlum Installer and Toolchains Installer
cd <path to installer>
apt install -y ./occlum-runtime*.deb
apt install -y ./occlum-pal*.deb
apt install -y ./occlum-sgx-tools*.deb
Toolchains are needed when compiling applications and also during runtime. C/C++ toolchain is a must for Occlum commands. To install musl C/C++ toolchain, just run the command:
apt install -y ./occlum-toolchains-gcc*.deb
Also, users can install glibc to support glibc based applications.
apt install -y ./occlum-toolchains-glibc*.deb
Besides, users can choose to install the toolchain installer based on the application's language. Currently, we also supports Golang. More language toolchain installers are on the way. To install Golang toolchain, run the below commands:
apt install -y ./occlum-toolchains-golang*.deb
At last, install occlum package to get complete support of Occlum:
apt install -y ./occlum_*.deb
To make the new installed binaries and libraries work, this command must be executed:
source /etc/profile
Step 5. Install Debug Symbol Packages (OPTIONAL) If users want to debug the application running inside the libos, debug symbol packages are also needed. Just run:
apt install -y ./occlum-dbgsym*.ddeb ./occlum-pal-dbgsym*.ddeb ./occlum-runtime-dbgsym*.ddeb ./occlum-toolchains-gcc-dbgsym*.ddeb ./occlum-sgx-tools-dbgsym*.ddeb
TBD