README.md

   1 # o-ran repo for Performance Tuned Infrastructure
   2
   3 This includes a Yocto/OpenEmbedded compatible layer meta-stx-oran and wrapper scripts
   4 to pull all required Yocto/OE layers to build out the reference platform.
   5
   6 meta-stx-oran layer depends on many Yocto/OE layers with 'thud' branch (Yocto version 2.6),to have a better user experience, meta-stx-oran depends on WRLinux 1018 open source version and uses wrlinux setup tools to create the build environment.
   7
   8 ## About Yocto and Wind River Linux
   9
  10 The Yocto Project is an open source collaboration project that provides templates,
  11 tools and methods to help you create custom Linux-based systems for embedded and
  12 IOT products, regardless of the hardware architecture.
  13
  14 Wind River is a founding member of the Linux Foundation's Yocto Project and continues
  15 to help maintain many Yocto Project components.
  16
  17 Wind River Linux is based on Yocto and is the leading free open-source Linux for the
  18 embedded industry.
  19
  20 ## How to use
  21
  22 ### Prerequisite:
  23
  24   * Your host need to meet the requirements for Yocto, please refer to:
  25     * [Compatible Linux Distribution](https://www.yoctoproject.org/docs/2.6.3/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-compatible-distro)
  26     * [Supported Linux Distributions](https://www.yoctoproject.org/docs/2.6.3/ref-manual/ref-manual.html#detailed-supported-distros)
  27     * [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)
  28
  29   * The recommended and tested host is Ubuntu 16.04/18.04 and CentOS 7.
  30     * To install the required packages for Ubuntu 16.04/18.04:
  31 ```
  32 $ sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib \
  33   build-essential chrpath socat cpio python python3 python3-pip python3-pexpect \
  34   xz-utils debianutils iputils-ping make xsltproc docbook-utils fop dblatex xmlto \
  35   python-git
  36 ```
  37
  38     * To install the required packages for CentOS 7:
  39
  40 ```
  41 $ sudo yum install -y epel-release
  42 $ sudo yum makecache
  43 $ sudo yum install gawk make wget tar bzip2 gzip python unzip perl patch \
  44   diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath socat \
  45   perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-Digest-SHA \
  46   python34-pip xz which SDL-devel xterm
  47 ```
  48 ### Use wrapper script build_oran.sh to build the image
  49
  50 ```
  51 # Get the wrapper script with either curl or wget
  52 $ 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'
  53 $ 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'
  54
  55 $ chmod +x build_oran.sh
  56 $ WORKSPACE=/path/to/workspace
  57 $ ./build_oran.sh -w ${WORKSPACE}
  58 ```
  59
  60 If all go well, you will get the ISO image in:
  61 ${WORKSPACE}/prj_wrl1018_oran/tmp-glibc/deploy/images/intel-x86-64/oran-image-inf-host-intel-x86-64.iso
  62
  63 ## License
  64 Copyright (C) 2019 Wind River Systems, Inc.
  65
  66 Source code included in the tree for individual recipes is under the LICENSE
  67 stated in the associated recipe (.bb file) unless otherwise stated.
  68
  69 The metadata is under the following license unless otherwise stated.
  70
  71 Licensed under the Apache License, Version 2.0 (the "License");
  72 you may not use this file except in compliance with the License.
  73 You may obtain a copy of the License at
  74
  75     http://www.apache.org/licenses/LICENSE-2.0
  76
  77 Unless required by applicable law or agreed to in writing, software
  78 distributed under the License is distributed on an "AS IS" BASIS,
  79 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  80 See the License for the specific language governing permissions and
  81 limitations under the License.