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.
13 This project implements a real time platform to deploy the O-CU and O-DU and it's based on Yocto/OpenEmbedded.
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.
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:
21 - `OpenEmbedded wiki`_
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
30 1. Prerequisite for build environment
31 `````````````````````````````````````
33 * Your host need to meet the requirements for Yocto, please refer to:
35 * `Compatible Linux Distribution`_
36 * `Supported Linux Distributions`_
37 * `Required Packages for the Build Host`_
39 * The recommended and tested host is Ubuntu 16.04/18.04 and CentOS 7.
41 * To install the required packages for Ubuntu 16.04/18.04:
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
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 \
54 * To install the required packages for CentOS 7:
58 $ sudo yum install -y epel-release
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
66 2. Use wrapper script build_inf.sh to setup build env and build the INF AIO x86 image
67 `````````````````````````````````````````````````````````````````````````````````````
71 # Get the wrapper script with either curl or wget
72 $ curl -o build_inf.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_inf.sh;hb=HEAD'
73 $ wget -O build_inf.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_inf.sh;hb=HEAD'
75 $ chmod +x build_inf.sh
76 $ WORKSPACE=/path/to/workspace
77 $ ./build_inf.sh -w ${WORKSPACE}
79 If all go well, you will get the ISO image in:
80 ${WORKSPACE}/prj_oran_inf_anaconda/tmp-glibc/deploy/images/intel-corei7-64/inf-image-aio-installer-intel-corei7-64.iso
82 3. (Optional) Use wrapper script build_oran.sh to setup build env and build the lagecy x86 image
83 ````````````````````````````````````````````````````````````````````````````````````````````````
85 Note: The lagecy image is the Kubernetes Cluster image as the same one in Amber (1.0) release.
89 # Get the wrapper script with either curl or wget
90 $ 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'
91 $ 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'
93 $ chmod +x build_oran.sh
94 $ WORKSPACE=/path/to/workspace_lagecy
95 $ ./build_oran.sh -w ${WORKSPACE}
97 If all go well, you will get the ISO image in:
98 ${WORKSPACE}/prj_oran_inf/tmp-glibc/deploy/images/intel-x86-64/oran-image-inf-host-intel-x86-64.iso
100 4. (Optional) Use wrapper script build_oran.sh to setup build env and build the ARM Kubernetes Cluster image
101 ``````````````````````````````````````````````````````````````````````````````````````````````````````````````
103 * the ARM Kubernetes Cluster image only supports the BSP nxp-lx2xxx and is verified with the board NXP LX2160ARDB
104 * The ISO image is supported yet.
108 # Get the wrapper script with either curl or wget
109 $ 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'
110 $ 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'
112 $ chmod +x build_oran.sh
113 $ WORKSPACE=/path/to/workspace_arm
114 $ ./build_oran.sh -w ${WORKSPACE} -b nxp-lx2xxx
116 If all go well, you will get the rootfs image in:
117 ${WORKSPACE}/prj_oran_inf/tmp-glibc/deploy/images/nxp-lx2xxx/oran-image-inf-host-nxp-lx2xxx.tar.bz2