docs/installation-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2019-2024 Wind River Systems, Inc.
   4
   5
   6 INF Installation Guide
   7 ======================
   8
   9 .. contents::
  10    :depth: 3
  11    :local:
  12
  13 Overview
  14 ********
  15
  16 O-RAN INF is a downstream project of `StarlingX`_ and `OKD`_, and use the installation and deployment methods of those platforms.
  17
  18 Please see the detail of all the supported `Deployment Configurations`_.
  19
  20 Notes: For Yocto based image, only "All-in-one Simplex" and "All-in-one Duplex (up to 50 worker nodes)" are supported.
  21
  22 .. _`Deployment Configurations`: https://docs.starlingx.io/r/stx.7.0/deploy/index-deploy-da06a98b83b1.html
  23
  24 Preface
  25 *******
  26
  27 Before starting the installation and deployment of O-RAN INF, you need to download the released ISO image or build from source as described in developer-guide.
  28
  29 The INF project supports Multi OS and the latest released images for each based OS can be dwonloaded in:
  30   - CentOS 7: `inf-image-centos-all-x86-64.iso`_
  31   - Debian 11 (bullseye): `inf-image-debian-all-x86-64.iso`_
  32   - Yocto 2.7 (warrior): `inf-image-yocto-aio-x86-64.iso`_
  33
  34 .. _`inf-image-debian-all-x86-64.iso`: https://nexus.o-ran-sc.org/content/sites/images/org/o-ran-sc/pti/rtp/latest/inf-image-debian-all-x86-64.iso
  35 .. _`inf-image-centos-all-x86-64.iso`: https://nexus.o-ran-sc.org/content/sites/images/org/o-ran-sc/pti/rtp/latest/inf-image-centos-all-x86-64.iso
  36 .. _`inf-image-yocto-aio-x86-64.iso`: https://nexus.o-ran-sc.org/content/sites/images/org/o-ran-sc/pti/rtp/latest/inf-image-yocto-aio-x86-64.iso
  37
  38 Deployment automation and documentation for OKD / Fedora CoreOS 38 can be found under the 'okd' directory in the `pti/rtp`_ repository.
  39
  40 .. _`pti/rtp`: https://gerrit.o-ran-sc.org/r/admin/repos/pti/rtp
  41
  42 Hardware Requirements
  43 *********************
  44
  45 * For INF platform Hardware Requirements, refer to `System Hardware Requirements`_.
  46 * For INF Openstack Hardware Requirements, refer to `Openstack Hardware Requirements`_.
  47
  48 * And you can also refer to the `Verified Commercial Hardware`_.
  49
  50 .. _`System Hardware Requirements`: https://docs.starlingx.io/planning/kubernetes/starlingx-hardware-requirements.html
  51 .. _`Verified Commercial Hardware`: https://docs.starlingx.io/planning/kubernetes/verified-commercial-hardware.html
  52 .. _`Openstack Hardware Requirements`: https://docs.starlingx.io/planning/openstack/hardware-requirements.html
  53
  54 Installation
  55 ************
  56
  57 Platform Installation
  58 ---------------------
  59
  60 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.
  61
  62 .. _`StarlingX Installation`: https://docs.starlingx.io/r/stx.7.0/deploy_install_guides/index-install-e083ca818006.html
  63
  64 Applications Installation
  65 -------------------------
  66
  67 Here are the example applications installations:
  68
  69 * `Install O-RAN O2`_
  70 * `Install FlexRAN`_
  71
  72 .. _`Install O-RAN O2`: https://docs.starlingx.io/admintasks/kubernetes/oran-o2-application-b50a0c899e66.html
  73 .. _`Install FlexRAN`: https://docs.starlingx.io/sample_apps/flexran/deploy-flexran-2203-on-starlingx-1d1b15ecb16f.html
  74
  75 References
  76 **********
  77
  78 - `StarlingX`_
  79 - `OKD`_
  80
  81 .. _`StarlingX`: https://docs.starlingx.io/
  82 .. _`OKD`: https://www.okd.io/