Documentation updates for OKD in L release 70/14470/1 l-release
authorChris Wheeler <chwheele@redhat.com>
Tue, 1 Jul 2025 23:28:19 +0000 (16:28 -0700)
committerJackie Huang <jackie.huang@windriver.com>
Thu, 3 Jul 2025 04:19:32 +0000 (04:19 +0000)
Change-Id: Iaddb92b6ab3c597e4bd1d5bb07a5d799d4b84691
Signed-Off-By: Chris Wheeler <chwheele@redhat.com>
Issue-ID: INF-490
(cherry picked from commit 6e5d405d98100ac797965c96b86f88ff3124e72b)

README.md
docs/developer-guide.rst
docs/installation-guide.rst
docs/overview.rst
docs/release-notes.rst

index 4d97ef3..dba4ffd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,6 +5,8 @@ to pull all required Yocto/OE layers to build out the reference platform.
 
 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.
 
+Deployment automation for OKD O-Cloud clusters is also provided. Refer to the README under the 'okd' directory for more details.
+
 ## About Yocto and Wind River Linux
 
 The Yocto Project is an open source collaboration project that provides templates,
@@ -17,6 +19,11 @@ to help maintain many Yocto Project components.
 Wind River Linux is based on Yocto and is the leading free open-source Linux for the
 embedded industry.
 
+## About OKD
+
+[OKD](https://okd.io/) is an open source Kubernetes distribution that serves as the upstream basis of
+Red Hat OpenShift Container Platform.
+
 ## How to use
 
 ### Prerequisite:
index d506ef2..a764972 100755 (executable)
@@ -22,7 +22,7 @@ This project is a reference implementation of O-Cloud infrastructure which is ba
 
   * OKD
 
-    * CentOS Stream CoreOS 4.17
+    * CentOS Stream CoreOS 9
 
 Notes:
   * Debian based is the recommended platfrom.
index b302212..a507e1f 100644 (file)
@@ -45,6 +45,10 @@ Hardware Requirements
 .. _`Verified Commercial Hardware`: https://docs.starlingx.io/planning/kubernetes/verified-commercial-hardware.html
 .. _`Openstack Hardware Requirements`: https://docs.starlingx.io/planning/openstack/hardware-requirements.html
 
+* For OKD O-Cloud hardware requirements, refer to `OKD minimum resource requirements`_ in the documentation
+
+.. _`OKD minimum resource requirements`: https://docs.okd.io/latest/installing/installing_platform_agnostic/installing-platform-agnostic.html#installation-minimum-resource-requirements_installing-platform-agnostic
+
 Installation
 ************
 
index 29239fa..f6c6f9b 100644 (file)
@@ -249,7 +249,7 @@ Multi O-Clouds and Deployment Configurations
 
   * OKD
 
-    * CentOS Stream CoreOS 4.17
+    * CentOS Stream CoreOS 9
 
 A variety of deployment configuration options are supported:
 
@@ -277,9 +277,17 @@ A variety of deployment configuration options are supported:
 
    Distributed Cloud configuration supports an edge computing solution by providing central management and orchestration for a geographically distributed network of StarlingX systems.
 
+7. **Single-node OKD**
+
+   A single node providing control plane, worker, and storage functions in an OKD O-Cloud cluster.
+
+8. **Multi-node OKD**
+
+   A minimum of 3 control plane nodes and optional additional worker nodes (up to a theoretical maximum of 2,000 nodes) comprising an OKD O-Cloud cluster.
+
 **NOTE:**
-   - For StarlingX O-Cloud, all the above deployment configuration are supported.
-   - For OKD O-Cloud, only All-in-one Simplex is supported currently.
+   - For StarlingX O-Cloud, all the above deployment configuration are supported, with the exception of those specific to OKD.
+   - For OKD O-Cloud, Single-node OKD and Multi-node OKD deployment configurations are supported.
 
 Upstream Opensource Projects
 ****************************
index 57ae92d..4f1b659 100644 (file)
@@ -71,7 +71,7 @@ Version 12.0.0, 2025-06-30
 
      * Supported OS:
 
-       * CentOS Stream CoreOS 4.17
+       * CentOS Stream CoreOS 9
 
 #. INF MultiArch support for StarlingX O-Cloud:
 
@@ -99,8 +99,17 @@ Version 12.0.0, 2025-06-30
    * AIO duplex mode (2 servers with High Availabity)
    * AIO duplex mode (2 servers with High Availabity) with additional worker node
 
+#. Support two deployment modes on OKD O-Cloud:
+
+   * Single-Node OKD (SNO)
+   * Multi-Node OKD (3 control plane nodes minimum)
+
 #. Support VM and bare metal automated deployment for OKD O-Cloud
-#. Support automated integration of Stolostron and oran-o2ims operator into OKD O-Cloud
+#. Support automated integration of Stolostron, multi-cluster-observability,
+   cluster-group-upgrades, siteconfig, oran-hwmgr-plugin, and oran-o2ims
+   operators into OKD O-Cloud
+#. Includes supporting playbooks/roles for automating O2 compliance testing
+   and sample workload deployment for OKD O-Cloud
 
 Version 11.0.0, 2024-12-31
 --------------------------