From 3704f66c65056a1e2793316225d6855eb4a1ec41 Mon Sep 17 00:00:00 2001 From: "aravind.est" Date: Thu, 9 Oct 2025 16:12:34 +0100 Subject: [PATCH] Update chartmuseum configuration details in README Flavour specific configurations updated. Issue-ID: NONRTRIC-1082 Change-Id: I06fafbaca52002e125d83341547d19821f53cc28 Signed-off-by: aravind.est --- smo-install/README.md | 10 ++--- smo-install/SMO-Lite-Install.md | 2 +- .../helm-override/ranpm-pynts-es-rapp/README.md | 8 ++++ smo-install/helm-override/rappmanager/README.md | 45 ++++++++++++++++------ 4 files changed, 47 insertions(+), 18 deletions(-) create mode 100644 smo-install/helm-override/ranpm-pynts-es-rapp/README.md diff --git a/smo-install/README.md b/smo-install/README.md index bdf9f6a1..7b996eba 100644 --- a/smo-install/README.md +++ b/smo-install/README.md @@ -32,16 +32,17 @@ This project uses different helm charts from different Linux Foundation projects - Flavours are directories under `smo-install/helm-override/`. - The default flavour is `default` (`smo-install/helm-override/default`). -> [!NOTE] -> The default flavour is considered as a baseline configuration for all the installations. +- The default flavour is considered as a baseline configuration for all the installations. - Flavour config files: - `onap-override.yaml`: ONAP components - `oran-override.yaml`: O-RAN components - To create a new flavour, add a directory with `onap-flavour-config.yaml` and `oran-flavour-config.yaml`. -> [!NOTE] -> These flavour configuration files doesn't needs to have entire configuration as same as in default flavour, Instead it should contain only the configuration that needs to be overridden from the default flavour. +- These flavour configuration files doesn't needs to have entire configuration as same as in default flavour, Instead it should contain only the configuration that needs to be overridden from the default flavour. - Only override necessary config values from the default flavour. +> [!IMPORTANT] +> Each flavour may require its own prerequisites or additional configuration (for example: different cluster resources, storage classes, or external services). Please check the `README.md` file inside the flavour directory under `smo-install/helm-override//README.md` for flavour-specific prerequisites and configuration details before installing. + **Example:** To disable NONRTRIC rAppmanager in your flavour: ```yaml nonrtric: @@ -175,4 +176,3 @@ Similarly, for other container runtimes, use the appropriate command to pull the > - Manually pull required images before installation if issues persist. Refer to [Manual Image Pulling](#manual-image-pulling) section for details. --- - diff --git a/smo-install/SMO-Lite-Install.md b/smo-install/SMO-Lite-Install.md index 070147d0..09c2ff25 100644 --- a/smo-install/SMO-Lite-Install.md +++ b/smo-install/SMO-Lite-Install.md @@ -182,7 +182,7 @@ Sample config.json file is provided in the repo. "username": "netconf", "password": "netconf!", "netconf-port": 1830, - "sftp-port": 122 + "sftp-port": 1222 }, "ves": { diff --git a/smo-install/helm-override/ranpm-pynts-es-rapp/README.md b/smo-install/helm-override/ranpm-pynts-es-rapp/README.md new file mode 100644 index 00000000..b9ac31aa --- /dev/null +++ b/smo-install/helm-override/ranpm-pynts-es-rapp/README.md @@ -0,0 +1,8 @@ +# RANPM — PYNTS Energy Saving rApp (Helm override) + +This directory contains the helm override configuration for the PYNTS Energy Saving rApp. + +## Links and documentation +- RANPM project documentation: https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/latest/index.html +- rAppManager flavour guidance is [here](https://github.com/o-ran-sc/it-dep/blob/master/smo-install/helm-override/rappmanager/README.md) +- ES Demo rApp details can be found [here](https://github.com/o-ran-sc/nonrtric-plt-rappmanager/blob/master/sample-rapp-generator/es-demo-rapp/README.md) \ No newline at end of file diff --git a/smo-install/helm-override/rappmanager/README.md b/smo-install/helm-override/rappmanager/README.md index beb12ed9..72810c75 100644 --- a/smo-install/helm-override/rappmanager/README.md +++ b/smo-install/helm-override/rappmanager/README.md @@ -1,24 +1,45 @@ -# NONRTRIC rAppManager Helm Override +# NONRTRIC rAppManager - Helm override configuration -This directory contains the flavour configuration for the NONRTRIC rAppManager component. +This directory contains the helm override configuration for the NONRTRIC rAppManager component. -## rAppManager -Source code for the NONRTRIC rAppManager component is available in [`this`](https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric%2Fplt%2Frappmanager.git;a=summary) repsitory. +## Overview +- The rAppManager component uses ONAP's `policy-clamp-ac-k8s-ppnt` to deploy the helm charts provided by rApp packages. +- This folder holds flavour-specific configuration that overrides the default settings in the main installation. -Sample rApps are available in the [`rapps`](https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric/plt/rappmanager.git;a=tree;f=sample-rapp-generator) directory. +## Source code and samples +- rAppManager source: https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric%2Fplt%2Frappmanager.git;a=summary +- Sample rApps: https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric/plt/rappmanager.git;a=tree;f=sample-rapp-generator +- Example Postman collection (ES Demo rApp): https://github.com/o-ran-sc/nonrtric-plt-rappmanager/blob/master/sample-rapp-generator/es-demo-rapp/Demo_Energy_Saving_rApp.postman_collection.json -Sample postman collection for rAppManager is available in [`ES Demo rApp Postman Collection`](https://github.com/o-ran-sc/nonrtric-plt-rappmanager/blob/master/sample-rapp-generator/es-demo-rapp/Demo_Energy_Saving_rApp.postman_collection.json). +## Prerequisites +- A helm repository configuration is required for rAppManager. See the "Helm repository configuration" section below for how to whitelist repositories used by rApps. +- KServe (for kserve-based rApps) is not installed by default in the SMO installation. If you intend to use KServe-based rApps, consider using the installer script in the rAppManager project: + - https://github.com/o-ran-sc/nonrtric-plt-rappmanager/blob/master/scripts/install/install-kserve.sh + - The `policy-clamp-ac-kserve-ppnt` component requires access to the Kserve CR via Kubernetes API server. -> [!NOTE] -> This installation doesn't include the kserve component. If you want to install kserver based rApp, It is recommended to use the script [here](https://github.com/o-ran-sc/nonrtric-plt-rappmanager/blob/master/scripts/install/install-kserve.sh). +## Helm repository configuration +The `policy-clamp-ac-k8s-ppnt` chart requires a whitelist of helm repositories that rAppManager will use. To provide this whitelist: +1. Add the required repositories to the `repoList` section in your flavour's `oran-flavour-config.yaml`. +2. Ensure the listed repositories are accessible from the Kubernetes cluster where rAppManager and policy-clamp-ac-k8s-ppnt are deployed. -## Helm repository whitelisting in ONAP Policy Clamp Kubernetes Participant -The rAppManager component uses ONAP policy-clamp-ac-k8s-ppnt chart to deploy the helm charts from the rApp. +Access/permissions notes: +- rAppManager must be able to write to repositories where it will push or publish rApp charts. +- The policy-clamp-ac-k8s-ppnt component requires read access to the repositories to fetch and deploy rApp charts. -The `policy-clamp-ac-k8s-ppnt` chart requires a list of helm repositories used by rApp to be whitelisted. +If you prefer to run a local helm chart repository, see the next section about the local chartmuseum setup. -This is done by adding the helm repositories to the `repoList` section in the `oran-flavour-config.yaml` file. +### Local chartmuseum setup +In dev mode this step is performed as part of the installation. In release/snapshot mode you must install chartmuseum manually if you want to use a local chart repository. + +```bash +./dep/smo-install/scripts/layer-0/0-setup-charts-museum.sh +``` + +Notes: +- The script installs chartmuseum on the host where it is executed. +- When using a local chartmuseum, make sure your Kubernetes cluster can reach the host IP (Where chartmuseum installed) and port `18080`. +- Form the chartmuseum URI using the host IP and port `18080` so that rAppManager and other components can access it. ## rAppManager cleanup -- 2.16.6