X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=78a12cfaaf3a959f9d9adf376e29cfa913f91f05;hb=fc1aac903c9ca67bc56df27d8716a4ab34b82c46;hp=d5282f4dec7f5f30c7b98dd13fe6a395e39a605b;hpb=9d2dd051e56a64667ed89340fb1734da41b05415;p=pti%2Frtp.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst old mode 100644 new mode 100755 index d5282f4..78a12cf --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -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,12 +34,12 @@ 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) +.. _`Supported Linux Distributions`: https://www.yoctoproject.org/docs/2.6.3/ref-manual/ref-manual.html#detailed-supported-distros .. _`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 :: @@ -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,19 +60,56 @@ 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 +------------------------------------------------------------------------------------- -2. Use wrapper script build_oran.sh to setup build env and build the image -`````````````````````````````````````````````````````````````````````````` +:: + + # Get the wrapper script with either curl or wget + $ 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' + $ 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' + + $ chmod +x build_inf.sh + $ WORKSPACE=/path/to/workspace + $ ./build_inf.sh -w ${WORKSPACE} + +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, will be obsoleted in F release) 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 + $ WORKSPACE=/path/to/workspace_lagecy $ ./build_oran.sh -w ${WORKSPACE} If all go well, you will get the ISO image in: -${WORKSPACE}/prj_wrl1018_oran/tmp-glibc/deploy/images/intel-x86-64/oran-image-inf-host-intel-x86-64.iso +${WORKSPACE}/prj_oran_inf/tmp-glibc/deploy/images/intel-x86-64/oran-image-inf-host-intel-x86-64.iso + +4. (Optional, will be obsoleted in F release) 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