中文版入口

Get set up for iSulad development

This section contains some guides for iSulad project users who want to contribute code to the isulad project.

Automate compilation scripts

OpenEuler

You can automatically install isulad on openEuler directly by compiling dependencies (other rpm distributions can also refer to this method, but some package names are inconsistent).

dnf builddep iSulad.spec

tips：iSulad.spec directly uses the files in the isulad source code.

Then, you should build and install iSulad:

$ git clone https://gitee.com/openeuler/iSulad.git
$ cd iSulad
$ mkdir build
$ cd build
$ sudo -E cmake ..
$ sudo -E make
$ sudo -E make install

tips： The communication between isula and isulad uses grpc by default. If you want to use rest for communication, you can replace it with the following compilation options：

cmake -DENABLE_GRPC=OFF ../

Centos

We provided a script to auto install iSulad on centos7, you can just execute the script to install iSulad.

$ git clone https://gitee.com/openeuler/iSulad.git
$ cd iSulad/docs/build_docs/guide/script
$ sudo ./install_iSulad_on_Centos_7.sh

Ubuntu

We also provided a script to auto install iSulad on Ubuntu20.04, you can just execute the script to install iSulad.

$ git clone https://gitee.com/openeuler/iSulad.git
$ cd iSulad/docs/build_docs/guide/script
$ sudo chmod +x ./install_iSulad_on_Ubuntu_20_04_LTS.sh
$ sudo ./install_iSulad_on_Ubuntu_20_04_LTS.sh

tips: If you want to keep the source of all dependencies, you can comment rm -rf $BUILD_DIR in the script.

Build guide

We provide multiple ways to build iSulad:

• If you want to build and install iSulad through rpm package, please refer to build_guide_with_rpm.

• If you want to build and install iSulad from suorce, please refer to build_guide.

• If you want to build iSulad from source on an openeuler-deployed risc-v machine, please refer to build_guide_riscv.

• If you want to build iSulad and install iSulad with docker image, please refer to build_guide_with_docker_image.

Test guide

Fuzz testing is an automated software testing method that injects invalid, malformed, or unexpected inputs into a system to reveal software defects and vulnerabilities. If you want to test iSulad with fuzz, please refer to fuzz_test_guide.

Code optomization guide

The Clang Static Analyzer is a source code analysis tool that finds bugs in C, C++, and Objective-C programs. If you want to analyze iSulad by it, please refer to clang_analyzer_guide.

Include-what-you-use is a tool for use with clang to analyze #includes in C and C++ source files. If you want to analyze iSulad by it, please refer to include_what_you_use_guide.