From cec59966de5a949f084b4a944a5d76a7347e9910 Mon Sep 17 00:00:00 2001 From: Chris Wheeler Date: Wed, 26 Jun 2024 16:14:30 -0700 Subject: [PATCH 1/1] Documentation updates for addition of OKD as alternative O-Cloud platform Issue-ID: INF-469 Change-Id: I93bb9168605a0f05e6f051c3d87691810a0c3a23 Signed-off-by: Chris Wheeler --- docs/developer-guide.rst | 19 +++++++++++++++---- docs/installation-guide.rst | 12 ++++++++---- docs/overview.rst | 16 +++++++++++++--- 3 files changed, 36 insertions(+), 11 deletions(-) diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 41e1391..9a374fc 100755 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -12,13 +12,19 @@ INF Developer Guide 1. About the INF project ************************ -This project is a reference implementation of O-Cloud infrastructure which is based on StarlingX, and it supports multi-OS. +This project is a reference implementation of O-Cloud infrastructure which is based on StarlingX and OKD, and it supports multi-OS. * Currently the following OS are supported: - * Debian 11 (bullseye) - * CentOS 7 - * Yocto 2.7 (warrior) + * StarlingX + + * Debian 11 (bullseye) + * CentOS 7 + * Yocto 2.7 (warrior) + + * OKD + + * Fedora CoreOS 38 Notes: * Debian based is the recommended platfrom. @@ -58,6 +64,11 @@ To contribute on this project, basic knowledge of Yocto/OpenEmbedded is needed, .. _`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 Fedora CoreOS / OKD based implementation +------------------------------------------------------ +Deployment automation and documentation for OKD / Fedora CoreOS 38 can be found under the 'okd' directory in the `pti/rtp`_ repository. + +.. _`pti/rtp`: https://gerrit.o-ran-sc.org/r/admin/repos/pti/rtp 2. How to build the INF project ******************************* diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 6e76a59..095e28b 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -13,7 +13,7 @@ INF Installation Guide Overview ******** -O-RAN INF is a downstream project of `StarlingX`_, and use the same installation and deployment methods. +O-RAN INF is a downstream project of `StarlingX`_ and `OKD`_, and use the installation and deployment methods of those platforms. Please see the detail of all the supported `Deployment Configurations`_. @@ -35,6 +35,10 @@ The INF project supports Multi OS and the latest released images for each based .. _`inf-image-centos-all-x86-64.iso`: https://nexus.o-ran-sc.org/content/sites/images/org/o-ran-sc/pti/rtp/g-release/inf-image-centos-all-x86-64.iso .. _`inf-image-yocto-aio-x86-64.iso`: https://nexus.o-ran-sc.org/content/sites/images/org/o-ran-sc/pti/rtp/g-release/inf-image-yocto-aio-x86-64.iso +Deployment automation and documentation for OKD / Fedora CoreOS 38 can be found under the 'okd' directory in the `pti/rtp`_ repository. + +.. _`pti/rtp`: https://gerrit.o-ran-sc.org/r/admin/repos/pti/rtp + Hardware Requirements ********************* @@ -53,11 +57,10 @@ Installation Platform Installation --------------------- -INF uses the same installation and deployment methods of StarlingX, please refer to `StarlingX Installation`_ for the detail installation steps. +INF uses the same installation and deployment methods of StarlingX or OKD, please refer to `StarlingX Installation`_ or 'okd/README.md' in the `pti/rtp`_ repository for the detail installation steps. .. _`StarlingX Installation`: https://docs.starlingx.io/r/stx.7.0/deploy_install_guides/index-install-e083ca818006.html - Applications Installation ------------------------- @@ -73,6 +76,7 @@ References ********** - `StarlingX`_ +- `OKD`_ .. _`StarlingX`: https://docs.starlingx.io/ - +.. _`OKD`: https://www.okd.io/ diff --git a/docs/overview.rst b/docs/overview.rst index a7c7f5a..919aed1 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -136,9 +136,15 @@ Multi OS and Deployment Configurations * The INF project supports Multi OS and currently the following OS are supported: - - Debian 11 (bullseye) - - CentOS 7 - - Yocto 2.7 (warrior) + * StarlingX + + * Debian 11 (bullseye) + * CentOS 7 + * Yocto 2.7 (warrior) + + * OKD + + * Fedora CoreOS 38 A variety of deployment configuration options are supported: @@ -189,6 +195,10 @@ About StarlingX --------------- StarlingX is a complete cloud infrastructure software stack for the edge used by the most demanding applications in industrial IOT, telecom, video delivery and other ultra-low latency use cases. With deterministic low latency required by edge applications, and tools that make distributed edge manageable, StarlingX provides a container-based infrastructure for edge implementations in scalable solutions that is ready for production now. +About OKD +--------------- +OKD is a complete open source container application platform and the community Kubernetes distribution that powers Red Hat OpenShift. + Contact info ------------ If you need support or add new features/components, please feel free to contact the following: -- 2.16.6