docs/developer-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2019 Wind River Systems, Inc.
   4
   5 Developer-Guide
   6 ===============
   7
   8 .. contents::
   9    :depth: 3
  10    :local:
  11
  12
  13 This project implements a real time platform to deploy the O-CU and O-DU and it's based on Yocto/OpenEmbedded.
  14
  15 This includes a Yocto/OpenEmbedded compatible layer meta-oran and wrapper scripts
  16 to pull all required Yocto/OE layers to build out the reference platform.
  17
  18 To contribute on this project, basic knowledge of Yocto/OpenEmbedded is needed, please refer to the following docs if you want to learn about how to develop with Yocto/OpenEmbedded:
  19
  20 - `Yocto dev manual`_
  21 - `OpenEmbedded wiki`_
  22
  23 .. _`Yocto dev manual`: https://www.yoctoproject.org/docs/2.6.3/dev-manual/dev-manual.html
  24 .. _`OpenEmbedded wiki`: http://www.openembedded.org/wiki/Main_Page
  25
  26
  27 Processes
  28 ---------
  29
  30 1. Prerequisite for build environment
  31 `````````````````````````````````````
  32
  33 * Your host need to meet the requirements for Yocto, please refer to:
  34
  35   * `Compatible Linux Distribution`_
  36   * `Supported Linux Distributions`_
  37   * `Required Packages for the Build Host`_
  38
  39 * The recommended and tested host is Ubuntu 16.04/18.04 and CentOS 7.
  40
  41   * To install the required packages for Ubuntu 16.04/18.04:
  42
  43 .. _`Compatible Linux Distribution`: https://www.yoctoproject.org/docs/2.6.3/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-compatible-distro
  44 .. _`Supported Linux Distributions`: https://www.yoctoproject.org/docs/2.6.3/ref-manual/ref-manual.html#detailed-supported-distros
  45 .. _`Required Packages for the Build Host`: https://www.yoctoproject.org/docs/2.6.3/ref-manual/ref-manual.html#required-packages-for-the-build-host
  46
  47 ::
  48
  49   $ sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib \
  50     build-essential chrpath socat cpio python python3 python3-pip python3-pexpect \
  51     xz-utils debianutils iputils-ping make xsltproc docbook-utils fop dblatex xmlto \
  52     python-git
  53
  54     * To install the required packages for CentOS 7:
  55
  56 ::
  57
  58   $ sudo yum install -y epel-release
  59   $ sudo yum makecache
  60   $ sudo yum install gawk make wget tar bzip2 gzip python unzip perl patch \
  61     diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath socat \
  62     perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-Digest-SHA \
  63     python34-pip xz which SDL-devel xterm
  64
  65
  66 2. Use wrapper script build_oran.sh to setup build env and build the image
  67 ``````````````````````````````````````````````````````````````````````````
  68
  69 ::
  70
  71   # Get the wrapper script with either curl or wget
  72   $ curl -o build_oran.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_oran.sh;hb=HEAD'
  73   $ wget -O build_oran.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_oran.sh;hb=HEAD'
  74
  75   $ chmod +x build_oran.sh
  76   $ WORKSPACE=/path/to/workspace
  77   $ ./build_oran.sh -w ${WORKSPACE}
  78
  79 If all go well, you will get the ISO image in:
  80 ${WORKSPACE}/prj_wrl1018_oran/tmp-glibc/deploy/images/intel-x86-64/oran-image-inf-host-intel-x86-64.iso