Commit 64e05a25 authored by garciadeblas's avatar garciadeblas
Browse files

Update all docs for Release NINETEEN

parent 8f1b6f0a
Loading
Loading
Loading
Loading
+13 −14
Original line number Diff line number Diff line
@@ -4,21 +4,20 @@ Open Source MANO (OSM) is an ETSI-hosted open source community delivering a prod

OSM follows a regular cadence of two releases per year, alternating between Long-Term Support (LTS) releases such as Release EIGHTEEN or Release SIXTEEN (2 years support) and Standard releases (6 months support).

This release, **Release EIGHTEEN**, which will be an LTS release with support for 2 years, builds upon the architectural evolution of previous releases, further consolidating OSM as a cloud-native orchestrator for infrastructure, platforms, and services. This release introduces significant advancements in declarative operations, cluster management, and modular installation, reinforcing OSM’s position as a leading open-source orchestration solution.
This release, **Release NINETEEN**, which will be a Standard release with support for 6 months, brings a modernization of codebase and dependencies and makes future development easier for the Community.

OSM Release EIGHTEEN includes the following highlights:
OSM Release NINETEEN includes the following improvements:

- __Advanced Application Modelling__. It introduces Applications as first-class entities using declarative, intent-driven models. Enhancements include:
  - Structured OKA blueprints for components, traits, and transformations.
  - Unified Argo Workflow for all App operations.
  - Support for multiple, optional KSUs per App.
  - New SDK for high-level, type-safe transformation scripting.
- __Enhanced Cluster Management__. It adds OpenShift cluster support and multi-node group management for AWS clusters, improving flexibility and scalability.
- __New VIM Connectors__. It includes a VMware vCenter plugin with VM console access, expanding IaaS support.
- __Modular Installation__. OSM installation is now modular and customizable. Airflow and MongoDB are integrated into a unified Helm chart, creating a single all-in-one OSM helm chart that includes all components. 
- __Service Assurance Framework Updates__. Legacy POL and PLA modules have been removed, and MON module has been simplified to retain only the dashboarder, aligning with long-term Service Assurance (SA) strategy.
- __LTS and code maintenance__:
  - __Python 3.13 in all Python-based modules__. This release updates all Python-based modules to use Python3.13 version, which will guarantee the prevent EOL support of Python for future releasesversions.
  - __Angular Framework upgrade for NGUI__. In addition, the Angular Framework has also been upgraded for the GUI module to use the latest Angular framework.
  - __Upgrade of Kubernetes version and Helm version in OSM modules__. All OSM modules have been properly updated to support the latest versions of Kubernetes and Helm, and its their associated libraries, which will guarantee the flawless interaction of OSM with modern Kubernetes clusters in the public clouds, even with the newer versions of Kubernetes versions planned that will for appear in the next year.
  - __Updates of the OSM installation to use the latest versions of OS operating system and dependencies__. Ubuntu 24.04 LTS has been selected as the new base Operating System for community installation of OSM, and the OSM installer has been updated to work flawlessly with the new OS. In addition, the installer supports upgraded versions of subcharts in OSM helm chart and upgraded client tools, all oriented to maximize EOL support for future releasesgrant community support of these dependencies for the coming years.
- __Friendlier OSM development__:
  - __Self-contained repos__. Until this release, OSM contributors had to know the intrinsics of OSM to know how to contribute to an OSM module, which added unnecessary difficulty to the process. This release has made every OSM repo fully independent by discontinuing the Debian package generation, simplifying the dependencies on common modules, and providing a single Dockerfile and Jenkinsfile per module that will allow OSM developers to test easily their codetheir code easily and replace existing modules on a running OSM installation. In addition, all contributions to OSM will be tested by a simplified pipeline, much easier to follow and maintain.
  - __New pipelines to automate project management tasks__. Finally, this release will incorporate an automated pipeline to ease the launch of point releases, transforming this process in into a one-click operation. In addition, besides the daily jobs that run daily E2E tests of OSM in our internal testbeds, new pipelines will run weekly to monitor our stable releases, mimicking the OSM installation done by our end users, and allowing us identifying promptly errors in any OSM outdated dependencies.

![Release EIGHTEEN - Feature summary](assets/rel18-features.png)
![Release NINETEEN - Feature summary](assets/rel19-features.png)

## OSM in practice

@@ -59,7 +58,7 @@ All you need to run OSM is a single server or VM with the following requirements
Once you have prepared the host with the previous requirements, all you need to do is:

```bash
wget https://osm-download.etsi.org/ftp/osm-18.0-eighteen/install_osm.sh
wget https://osm-download.etsi.org/ftp/osm-19.0-nineteen/install_osm.sh
chmod +x install_osm.sh
./install_osm.sh
```
@@ -69,7 +68,7 @@ This will install a standalone Kubernetes on a single host, and OSM on top of it
**TIP:** In order to facilitate potential trobleshooting later, it is recommended to save the full log of your installation process:

```bash
wget https://osm-download.etsi.org/ftp/osm-18.0-eighteen/install_osm.sh
wget https://osm-download.etsi.org/ftp/osm-19.0-nineteen/install_osm.sh
chmod +x install_osm.sh
./install_osm.sh 2>&1 | tee osm_install_log.txt
```
+11 −11
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ Hence, it is assumed that:
Once you have one host available with the characteristics above, you just need to trigger the OSM installation by:

```bash
wget https://osm-download.etsi.org/ftp/osm-18.0-eighteen/install_osm.sh
wget https://osm-download.etsi.org/ftp/osm-19.0-nineteen/install_osm.sh
chmod +x install_osm.sh
./install_osm.sh
```
@@ -39,7 +39,7 @@ This will install a standalone Kubernetes on a single host, and OSM on top of it
**TIP:** In order to facilitate potential troubleshooting later, it is recommended to save the full log of your installation process:

```bash
wget https://osm-download.etsi.org/ftp/osm-18.0-eighteen/install_osm.sh
wget https://osm-download.etsi.org/ftp/osm-19.0-nineteen/install_osm.sh
chmod +x install_osm.sh
./install_osm.sh 2>&1 | tee osm_install_log.txt
```
@@ -258,8 +258,8 @@ Although the OSM Client is always available in the host machine after installati
In order to install the OSM Client in your local Linux machine, you should follow this procedure:

```bash
OSM_CLIENT_VERSION="v18.0"
OSM_IM_VERSION="v18.0"
OSM_CLIENT_VERSION="v19.0"
OSM_IM_VERSION="v19.0"
sudo DEBIAN_FRONTEND=noninteractive apt-get install -y python3 python3-setuptools python3-dev python3-pip
sudo DEBIAN_FRONTEND=noninteractive apt-get install -y libmagic1
sudo DEBIAN_FRONTEND=noninteractive apt-get install -y make
@@ -317,7 +317,7 @@ Once OSM is installed, the following helm releases can be seen in namespace `osm
```bash
$ helm -n osm ls
NAME            NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                           APP VERSION
osm             osm             1               2025-09-07 15:08:43.421836769 +0000 UTC deployed        osm-18.0.0                      18.0.0
osm             osm             1               2026-02-01 15:08:43.421836769 +0000 UTC deployed        osm-19.0.0                      19.0.0
```

The helm release `osm` corresponds to the OSM Helm chart.
@@ -360,10 +360,10 @@ Assuming that you have a Kubernetes cluster, it is possible to deploy OSM on top
### Deploy OSM helm chart directly from Gitlab OCI repo

```bash
helm install -n osm osm oci://osm.etsi.org:5050/osm/devops/osm --version 18.0.0
helm install -n osm osm oci://osm.etsi.org:5050/osm/devops/osm --version 19.0.0
# Optionally pull, then install
# helm pull osm oci://osm.etsi.org:5050/osm/devops/osm --version 18.0.0
# helm install -n osm --repo osm osm-18.0.0.tgz
# helm pull osm oci://osm.etsi.org:5050/osm/devops/osm --version 19.0.0
# helm install -n osm --repo osm osm-19.0.0.tgz
```

### Deploy OSM helm chart from devops repo
@@ -372,7 +372,7 @@ helm install -n osm osm oci://osm.etsi.org:5050/osm/devops/osm --version 18.0.0
# Make sure you are in devops directory
cd devops
# Optionally check out a specific version
# DESIRED_OSM_VERSION="18.0.0"
# DESIRED_OSM_VERSION="19.0.0"
# git checkout $DESIRED_OSM_VERSION

# Check default values
@@ -381,7 +381,7 @@ helm -n osm show values installers/helm/osm
# Specify the repository base and the version that you want for the docker images
OSM_HELM_OPTS=""
OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.image.repositoryBase=opensourcemano"
OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.image.tag=\"18\""
OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.image.tag=\"19\""

# Build the helm chart dependencies 
helm dependency build installers/helm/osm
@@ -619,7 +619,7 @@ OSM could be installed to a remote OpenStack infrastructure from the OSM standar
The installation can be performed with the following command:

```bash
wget https://osm-download.etsi.org/ftp/osm-18.0-eighteen/install_osm.sh
wget https://osm-download.etsi.org/ftp/osm-19.0-nineteen/install_osm.sh
chmod +x install_osm.sh
./install_osm.sh -O <openrc file/cloud name> -N <OpenStack public network name/ID> [--volume] [OSM installer options]
```
+1 −1
Original line number Diff line number Diff line
@@ -1059,7 +1059,7 @@ CEF:Version|Device Vendor|Device Product|Device Version|Name|Severity|Extension
A sample CEF log for User login would be as below:

```text
CEF:0|OSM|OSM|18.0.0|User Login|1|msg=User Logged In, Project\=admin Outcome\=Success suser=admin
CEF:0|OSM|OSM|19.0.0|User Login|1|msg=User Logged In, Project\=admin Outcome\=Success suser=admin
```

### Audit Logs Prefixes
+5 −5
Original line number Diff line number Diff line
@@ -150,8 +150,8 @@ Commands:
OSM client is installed by default in the host where OSM is installed, but it can be also installed as a standalone client in an Ubuntu 22.04 system, following the procedure below:

```bash
OSM_CLIENT_VERSION="v18.0"
OSM_IM_VERSION="v18.0"
OSM_CLIENT_VERSION="v19.0"
OSM_IM_VERSION="v19.0"
sudo DEBIAN_FRONTEND=noninteractive apt-get install -y python3 python3-setuptools python3-dev python3-pip
sudo DEBIAN_FRONTEND=noninteractive apt-get install -y libmagic1
sudo DEBIAN_FRONTEND=noninteractive apt-get install -y make
@@ -178,7 +178,7 @@ sudo dnf install -y python310 python310-devel
sudo -H python3 -m pip install -U pip

# Decide which version to use
export OSM_CLIENT_VERSION=v18.0
export OSM_CLIENT_VERSION=v19.0

# Install OSM IM and its dependencies via pip (installed with sudo, to install it globally for all users)
sudo -H python3 -m pip install -r "https://osm.etsi.org/gitweb/?p=osm/IM.git;a=blob_plain;f=requirements.txt;hb=${OSM_CLIENT_VERSION}"
@@ -211,7 +211,7 @@ sudo apt-get install -y python3 python3-setuptools python3-dev python3-pip
sudo -H python3 -m pip install -U pip

# Decide which version to use
export OSM_CLIENT_VERSION=v18.0
export OSM_CLIENT_VERSION=v19.0

# Install OSM IM and its dependencies via pip
python3 -m pip install -r "https://osm.etsi.org/gitweb/?p=osm/IM.git;a=blob_plain;f=requirements.txt;hb=${OSM_CLIENT_VERSION}"
@@ -272,7 +272,7 @@ conda activate osm-env
python -m pip install -U pip

# Decide which version to use
export OSM_CLIENT_VERSION=v18.0
export OSM_CLIENT_VERSION=v19.0

# Clone IM repo and checkut the desired version
git clone https://osm.etsi.org/gerrit/osm/IM
+481 KiB
Loading image diff...