X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=048ca3d7c418a88bcaa9008bfaf587065222e074;hb=1a92c1096aa257ea14475c43e13aa62ba71d4495;hp=fb7c9121e1a6bf85628ef66baaaf2a946a7608d7;hpb=4ea6c305c910add58abd7b9d74c1da14e226adef;p=pti%2Frtp.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index fb7c912..048ca3d 100755 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -12,7 +12,7 @@ Developer-Guide This project implements a real time platform to deploy the O-CU and O-DU and it's based on Yocto/OpenEmbedded. -This includes a Yocto/OpenEmbedded compatible layer meta-oran and wrapper scripts +This includes a Yocto/OpenEmbedded compatible layer meta-stx-oran and wrapper scripts to pull all required Yocto/OE layers to build out the reference platform. 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: @@ -24,11 +24,9 @@ To contribute on this project, basic knowledge of Yocto/OpenEmbedded is needed, .. _`OpenEmbedded wiki`: http://www.openembedded.org/wiki/Main_Page -Processes ---------- 1. Prerequisite for build environment -````````````````````````````````````` +------------------------------------- * Your host need to meet the requirements for Yocto, please refer to: @@ -36,9 +34,9 @@ Processes * `Supported Linux Distributions`_ * `Required Packages for the Build Host`_ -* The recommended and tested host is Ubuntu 16.04/18.04 and CentOS 7. +The recommended and tested host is Ubuntu 16.04/18.04 and CentOS 7. - * To install the required packages for Ubuntu 16.04/18.04: +* To install the required packages for Ubuntu 16.04/18.04: .. _`Compatible Linux Distribution`: https://www.yoctoproject.org/docs/2.6.3/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-compatible-distro .. _`Supported Linux Distributions`: https://www.yoctoproject.org/docs/2.6.3/ref-manual/ref-manual.html#detailed-supported-distros @@ -51,7 +49,7 @@ Processes xz-utils debianutils iputils-ping make xsltproc docbook-utils fop dblatex xmlto \ python-git - * To install the required packages for CentOS 7: +* To install the required packages for CentOS 7: :: @@ -62,9 +60,8 @@ Processes perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-Digest-SHA \ python34-pip xz which SDL-devel xterm - 2. Use wrapper script build_inf.sh to setup build env and build the INF AIO x86 image -````````````````````````````````````````````````````````````````````````````````````` +------------------------------------------------------------------------------------- :: @@ -79,39 +76,3 @@ Processes If all go well, you will get the ISO image in: ${WORKSPACE}/prj_oran_inf_anaconda/tmp-glibc/deploy/images/intel-corei7-64/inf-image-aio-installer-intel-corei7-64.iso -3. (Optional) Use wrapper script build_oran.sh to setup build env and build the lagecy x86 image -```````````````````````````````````````````````````````````````````````````````````````````````` - -Note: The lagecy image is the Kubernetes Cluster image as the same one in Amber (1.0) release. - -:: - - # Get the wrapper script with either curl or wget - $ 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' - $ 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' - - $ chmod +x build_oran.sh - $ WORKSPACE=/path/to/workspace_lagecy - $ ./build_oran.sh -w ${WORKSPACE} - -If all go well, you will get the ISO image in: -${WORKSPACE}/prj_oran_inf/tmp-glibc/deploy/images/intel-x86-64/oran-image-inf-host-intel-x86-64.iso - -4. (Optional) Use wrapper script build_oran.sh to setup build env and build the ARM Kubernetes Cluster image -`````````````````````````````````````````````````````````````````````````````````````````````````````````````` -Note: - * the ARM Kubernetes Cluster image only supports the BSP nxp-lx2xxx and is verified with the board NXP LX2160ARDB - * The ISO image is supported yet. - -:: - - # Get the wrapper script with either curl or wget - $ 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' - $ 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' - - $ chmod +x build_oran.sh - $ WORKSPACE=/path/to/workspace_arm - $ ./build_oran.sh -w ${WORKSPACE} -b nxp-lx2xxx - -If all go well, you will get the rootfs image in: -${WORKSPACE}/prj_oran_inf/tmp-glibc/deploy/images/nxp-lx2xxx/oran-image-inf-host-nxp-lx2xxx.tar.bz2