From dc7e6354c34678c311ab95929b98c7c570b399cd Mon Sep 17 00:00:00 2001 From: Jackie Huang Date: Fri, 3 Jan 2025 15:59:13 +0800 Subject: [PATCH] developer-guide.rst: update for K-release Issue-ID: INF-487 Signed-off-by: Jackie Huang Change-Id: I947b2def0e87520c7b02ce628ae48c3adc833244 --- docs/developer-guide.rst | 118 ++--------------------------------------------- 1 file changed, 4 insertions(+), 114 deletions(-) diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index df5f1aa5..d506ef20 100755 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -19,8 +19,6 @@ This project is a reference implementation of O-Cloud infrastructure which is ba * StarlingX * Debian 11 (bullseye) - * CentOS 7 - * Yocto 2.7 (warrior) * OKD @@ -45,26 +43,7 @@ The project provde wrapper scripts to automate all the steps of `StarlingX Debia .. _`StarlingX Debian Build Guide`: https://wiki.openstack.org/wiki/StarlingX/DebianBuildEnvironment -1.2 About the CentOS based implementaion ----------------------------------------- -The project provde wrapper scripts to automate all the steps of `StarlingX Build Guide`_ to build out the reference platform as an installable ISO image. - -.. _`StarlingX Build Guide`: https://docs.starlingx.io/developer_resources/build_guide.html - -1.3 About the Yocto based implementation ----------------------------------------- - -The project provde wrapper scripts to pull all required Yocto/OE layers to build out the reference platform as an installable ISO image. - -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: - -- `Yocto dev manual`_ -- `OpenEmbedded wiki`_ - -.. _`Yocto dev manual`: https://www.yoctoproject.org/docs/2.6.3/dev-manual/dev-manual.html -.. _`OpenEmbedded wiki`: http://www.openembedded.org/wiki/Main_Page - -1.4 About the CentOS Stream CoreOS / OKD based implementation +1.2 About the CentOS Stream CoreOS / OKD based implementation ------------------------------------------------------------- Deployment automation and documentation for OKD / CentOS Stream CoreOS can be found under the 'okd' directory in the `pti/rtp`_ repository. @@ -103,99 +82,10 @@ NOTE: The build system for Debian requires a Linux system with Docker and python If all go well, you will get the ISO image in: ${WORKSPACE}/prj_output/inf-image-debian-all-x86-64.iso -2.2 How to build the CentOS based image ---------------------------------------- - -NOTE: This only supports build on CentOS 7 which will be EOL 30 Jun 2024. - -2.2.1 Prerequisite for CentOS build environment -+++++++++++++++++++++++++++++++++++++++++++++++ - -NOTE: This step needs the user has sudo permission. - -:: - - # Get the wrapper script for preparing the build environment - $ wget -O build_inf_prepare.sh https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_inf_centos/build_inf_prepare_jenkins.sh;hb=HEAD - - $ chmod +x build_inf_prepare.sh - $ WORKSPACE=/path/to/workspace - $ ./build_inf_prepare.sh -w ${WORKSPACE} - -2.2.2 Use wrapper script build_inf_centos.sh to build the CentOS based image -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -:: - - # Get the wrapper script to build the centos image - $ wget -O build_inf_centos.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_inf_centos/build_inf_centos.sh;hb=HEAD' - - $ chmod +x build_inf_centos.sh - $ WORKSPACE=/path/to/workspace - $ ./build_inf_centos.sh -w ${WORKSPACE} - -If all go well, you will get the ISO image in: -${WORKSPACE}/prj_output/inf-image-centos-all-x86-64.iso - - -2.3 How to build the Yocto based image --------------------------------------- - -2.3.1 Prerequisite for Yocto build environment -++++++++++++++++++++++++++++++++++++++++++++++ - -* Your host need to meet the requirements for Yocto, please refer to: - - * `Compatible Linux Distribution`_ - * `Supported Linux Distributions`_ - * `Required Packages for the Build Host`_ - -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: - -.. _`Compatible Linux Distribution`: https://docs.yoctoproject.org/2.7.4/brief-yoctoprojectqs/brief-yoctoprojectqs.html#brief-compatible-distro -.. _`Supported Linux Distributions`: https://docs.yoctoproject.org/2.7.4/ref-manual/ref-manual.html#detailed-supported-distros -.. _`Required Packages for the Build Host`: https://docs.yoctoproject.org/2.7.4/ref-manual/ref-manual.html#required-packages-for-the-build-host - -:: - - $ sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib \ - build-essential chrpath socat cpio python python3 python3-pip python3-pexpect \ - xz-utils debianutils iputils-ping make xsltproc docbook-utils fop dblatex xmlto \ - python-git - -* To install the required packages for CentOS 7: - -:: - - $ sudo yum install -y epel-release - $ sudo yum makecache - $ sudo yum install gawk make wget tar bzip2 gzip python unzip perl patch \ - diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath socat \ - perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-Digest-SHA \ - python34-pip xz which SDL-devel xterm - -2.3.2 Use wrapper script build_inf_yocto.sh to setup build the Yocto based image -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -:: - - # Get the wrapper script with either curl or wget - $ curl -o build_inf_yocto.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_inf_yocto/build_inf_yocto.sh;hb=HEAD' - $ wget -O build_inf_yocto.sh 'https://gerrit.o-ran-sc.org/r/gitweb?p=pti/rtp.git;a=blob_plain;f=scripts/build_inf_yocto/build_inf_yocto.sh;hb=HEAD' - - $ chmod +x build_inf_yocto.sh - $ WORKSPACE=/path/to/workspace - $ ./build_inf_yocto.sh -w ${WORKSPACE} - -If all go well, you will get the ISO image in: -${WORKSPACE}/prj_output/inf-image-yocto-aio-x86-64.iso - -2.4 How to build the Debian based image for ARM64 arch +2.2 How to build the Debian based image for ARM64 arch ------------------------------------------------------ -2.4.1 Prerequisite for Debian build environment +2.2.1 Prerequisite for Debian build environment +++++++++++++++++++++++++++++++++++++++++++++++ NOTE: @@ -208,7 +98,7 @@ NOTE: .. _`Install docker on debian`: https://docs.docker.com/engine/install/debian/ .. _`Configure_Debian_build_environment`: https://wiki.openstack.org/wiki/StarlingX/DebianBuildEnvironment#Configure_build_environment -2.4.2 Use wrapper script build_stx_debian.sh to build the Debian based image +2.2.2 Use wrapper script build_stx_debian.sh to build the Debian based image ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ :: -- 2.16.6