Merge branch 'feature10981' into 'master'

Open Source MANO (OSM) is an ETSI-hosted open source community delivering a production-quality MANO stack for NFV, capable of consuming openly published information models, available to everyone, suitable for all VNFs, operationally significant and VIM-independent. OSM is aligned to NFV ISG information models while providing first-hand feedback based on its implementation experience.

OSM follows a regular cadence of two releases per year, alternating between Long Term Support (LTS) releases such as Release TWELVE (2 years support) and Standard releases (6 months support) such as this release, Release THIRTEEN. **Release THIRTEEN** introduces a new scalable architecture for service assurance and closed-loop operations leveraging on cloud-native version of Apache Airflow and Prometheus. This architecture is prepared to cover the most demanding service assurance scenarios such as auto-healing and auto-scaling in large clouds and multiple edge sites. Release THIRTEEN incorporates new workflows for getting the state of Network Functions (NF), Network Services (NS) and VIM, and will gradually incorporate new capabilities in the next releases. In addition, Release THIRTEEN includes significant improvements in other key areas:

OSM follows a regular cadence of two releases per year, alternating between Long Term Support (LTS) releases such as Release FOURTEEN or Release TWELVE (2 years support) and Standard releases (6 months support). This release, **Release FOURTEEN**, offers a new scalable architecture for service assurance based on Apache Airflow and Prometheus and includes closed loops for auto-scaling and the handling of alerts coming from the Network Functions. In addition, the new architecture enables scheduled monitoring and service-assurance workflows, as well as alarm-based on-demand workflows. This capability will be key to supporting new telco cloud use cases in future Releases.

- **Execution environments.** Day-2 operations are a key capability in OSM, which provides added value to the mere deployment of NS and NF through the use of Execution Environments (EE), isolated environments that allow the execution of code to perform operations on the NF and NS. Release THIRTEEN provides an improved secured communication channel between helm-based EE and NF, the capability to upgrade helm-based EE and a new naming convention for Juju application in Juju-based EE.

- **NS deployment.** OSM has proved to be successful in production environments in the deployment of NS. This release incorporates new capabilities for NS deployment such as the capability to make persistent volumes of NF permanent in the VIM, the ability to store CA certificates as part of VIM registration and update, or the automatic WIM selection for inter-DC networks.

- **Internal LCM evolution.** LCM module in OSM is responsible of managing the workflows associated to life cycle events of VNF and NS such as instantiation, termination, scaling, healing and upgrading. In this Release, we have initiated the adoption of the Saga-based pattern  for workflow management in selected operations. In addition, this release incorporates the communication channel between LCM and RO via Kafka.

- **OSM installation experience.** The community installer will now be able to auto-detect installations of OSM behind a web proxy and perform the appropriate configurations, easing the global installation experience. In addition, the internal process in OSM to generate the installation SW has incorporated the automatic publication of charms for charm-based installation.

- **OSM client.** Finally, this release includes some improvements in the OSM client, such as a more convenient registration of Prometheus-based telemetry systems as part of VIM registration and update, the refactoring of OSM client commands, and an installation procedure for OSM client in Windows and Red Hat Linux distros in addition to Ubuntu Linux distros.

Release FOURTEEN brings significant improvements in security, usability, platform management, infrastructure modelling and lifecycle management of network functions:

For the full list of new features, please refer to the [Release Notes](https://osm-download.etsi.org/ftp/osm-13.0-thirteen/OSM_Release_THIRTEEN_Release_Notes.pdf). For a comprehensive overview of OSM functionalities, you can also refer to the [OSM White Papers and Release Notes of previous releases](https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers).

- **Security enhancements**. Release FOURTEEN introduced secured helm-based Execution Environments (EE) based on authenticated gRPC communication channel between EE and NF, and the use of pod admission policies to restrict EE permissions running in OSM cluster. In addition, Pycrypto library has been PycryptoDome, a more modern and secure cryptography library.

- **Usability and platform management**. This release includes relevant enhancements in user management such as the generation of standard audit logs for every user operation from any entity interacting with OSM North Bound Interface. In addition, retry and password expiry policies have been added to user management.

- **Infra modelling and NF lifecycle**. OSM has proved to be successful in production environments in the deployment of NS. This release goes even further and incorporates new capabilities for NS deployment such as the capability to attach multiple volumes to different VM, the capability to re-use existing flavors, the simultaneous support of IPv4 and IPv6 in VM network interfaces, or the ability to provide instantiation parameter to Juju-based Kubernetes Deployment Units. In addition, the release has optimized the interactions with VIMs to make deployment faster and more reliable. Finally, the release includes a new connector for Transport-API WIMs, which will enable the use of TeraFlow SDN or any other WIM in the future to build optical transport connectivity between datacenters.

- **OSM installation experience**. This release has modified the community installer to install all OSM components with a Helm chart rather than plain Kubernetes manifests, which will allow much simpler upgrades of OSM services from now on. 

- **OSM client**. Finally, this release includes some improvements in the OSM client, such as the support of different output formats for some commands and the replacement of Pycurl library by the well-known Requests library for HTTP interaction. Both features were developed by participants of the recent [OSM Hackfest for developers held in Castelldefels in June 2023](https://osm.etsi.org/wikipub/index.php/OSM15_Hackfest).

For the full list of new features, please refer to the [Release Notes](https://osm-download.etsi.org/ftp/osm-14.0-fourteen/OSM_Release_FOURTEEN_Release_Notes.pdf). For a comprehensive overview of OSM functionalities, you can also refer to the [OSM White Papers and Release Notes of previous releases](https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers).

**OSM in Practice**:

All you need to run OSM is a single server or VM with the following requirements:

- MINIMUM: 2 CPUs, 6 GB RAM, 40GB disk and a single interface with Internet access

- RECOMMENDED: 2 CPUs, 8 GB RAM, 40GB disk and a single interface with Internet access

- Base image: [Ubuntu20.04 (64-bit variant required)](http://releases.ubuntu.com/20.04/)

- RECOMMENDED: 4 CPUs, 16 GB RAM, 80GB disk and a single interface with Internet access

- MINIMUM: 2 CPUs, 8 GB RAM, 50GB disk and a single interface with Internet access

- Base image: Ubuntu22.04

  - [Ubuntu22.04 cloud image (64-bit variant required)](https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64-disk-kvm.img)

  - [Ubuntu22.04 server image (64-bit variant required)](http://releases.ubuntu.com/22.04/)

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-13.0-thirteen/install_osm.sh

wget https://osm-download.etsi.org/ftp/osm-14.0-fourteen/install_osm.sh

chmod +x install_osm.sh

./install_osm.sh

```

**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-13.0-thirteen/install_osm.sh

wget https://osm-download.etsi.org/ftp/osm-14.0-fourteen/install_osm.sh

chmod +x install_osm.sh

./install_osm.sh 2>&1 | tee osm_install_log.txt

```

#### Other installation options

- An additional installation option is the [Charmed Installation](03-installing-osm.md#charmed-installation) which will install OSM on Kubernetes with charms.

- You can also run OSM using a pre-built [vagrant](https://app.vagrantup.com/osm/boxes/releaseeight) image. You can find here detailed instruction on [how to install OSM in Vagrant](03-installing-osm.md#vagrant-installation)

- For other special installation options, please refer to the [specific chapter on installation options](03-installing-osm.md).

### Checking your installation

In order to install OSM, you will need, at least, a single server or VM with the following requirements:

- MINIMUM: 2 CPUs, 6 GB RAM, 40GB disk and a single interface with Internet access

- RECOMMENDED: 2 CPUs, 8 GB RAM, 40GB disk and a single interface with Internet access

- Base image:

  - Ubuntu20.04 cloud image (64-bit variant required) (<https://cloud-images.ubuntu.com/focal/current/focal-server-cloudimg-amd64.img>)

  - Ubuntu20.04 server image (64-bit variant required) (<http://releases.ubuntu.com/20.04/>)

- RECOMMENDED: 4 CPUs, 16 GB RAM, 80GB disk and a single interface with Internet access

- MINIMUM: 2 CPUs, 8 GB RAM, 50GB disk and a single interface with Internet access

- Base image: Ubuntu22.04

  - [Ubuntu22.04 cloud image (64-bit variant required)](https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64-disk-kvm.img)

  - [Ubuntu22.04 server image (64-bit variant required)](http://releases.ubuntu.com/22.04/)

**Reminder**: Although OSM could work with other base images, the only recommended are the ones above, since these are the images used in our daily tests.

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-13.0-thirteen/install_osm.sh

wget https://osm-download.etsi.org/ftp/osm-14.0-fourteen/install_osm.sh

chmod +x install_osm.sh

./install_osm.sh

```

**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-13.0-thirteen/install_osm.sh

wget https://osm-download.etsi.org/ftp/osm-14.0-fourteen/install_osm.sh

chmod +x install_osm.sh

./install_osm.sh 2>&1 | tee osm_install_log.txt

```

![OSM Docker containers](assets/800px-OSM_charmed_standalone.png)

```bash

wget https://osm-download.etsi.org/ftp/osm-13.0-thirteen/install_osm.sh

wget https://osm-download.etsi.org/ftp/osm-14.0-fourteen/install_osm.sh

chmod +x install_osm.sh

./install_osm.sh --charmed

```

For the installation using external components the following parameters can be added:

```bash

wget https://osm-download.etsi.org/ftp/osm-13.0-thirteen/install_osm.sh

wget https://osm-download.etsi.org/ftp/osm-14.0-fourteen/install_osm.sh

chmod +x install_osm.sh

./install_osm.sh --charmed --k8s ~/.kube/config --vca <name> --lxd <lxd-cloud.yaml> --lxd-cred <lxd-credentials.yaml>

```

The installation can be performed with the following command:

```bash

wget https://osm-download.etsi.org/ftp/osm-13.0-thirteen/install_osm.sh

wget https://osm-download.etsi.org/ftp/osm-14.0-fourteen/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]

```

On systems that support snaps, you can install the OSM client with the following command:

```bash

sudo snap install osmclient --channel 11.0/stable

sudo snap install osmclient --channel 14.0/stable

```

There are tracks available for all releases.  Omitting the channel will use the latest stable release version.

```bash

# Clean the previous repos that might exist

sudo sed -i "/osm-download.etsi.org/d" /etc/apt/sources.list

wget -qO - https://osm-download.etsi.org/repository/osm/debian/ReleaseTHIRTEEN/OSM%20ETSI%20Release%20Key.gpg | sudo apt-key add -

sudo add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseTHIRTEEN stable devops IM osmclient"

wget -qO - https://osm-download.etsi.org/repository/osm/debian/ReleaseFOURTEEN/OSM%20ETSI%20Release%20Key.gpg | sudo apt-key add -

sudo add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseFOURTEEN stable devops IM osmclient"

sudo apt-get update

sudo apt-get install -y python3-pip

sudo -H python3 -m pip install -U pip

sudo -H python3 -m pip install python-magic pyangbind verboselogs

sudo apt-get install python3-osmclient

sudo apt-get install -y python3-osm-im python3-osmclient

sudo apt-get install -y libmagic1

python3 -m pip install -r /usr/lib/python3/dist-packages/osm_im/requirements.txt

python3 -m pip install -r /usr/lib/python3/dist-packages/osmclient/requirements.txt

```

### Usage

### Specify IP profile information and IP for a NS VLD <a name="specify-ip-profile-information-and-ip-for-a-ns-vld">

In a generic way, the mapping can be specified in the following way, where `datanet` is the name of the network in the NS descriptor, ip-profile is where you have to fill the associated parameters from the data model ( [NS data model](https://osm-download.etsi.org/repository/osm/debian/ReleaseTHIRTEEN/docs/osm-im/osm_im_trees/etsi-nfv-nsd.html) ), and vnfd-connection-point-ref is the reference to the connection point:

In a generic way, the mapping can be specified in the following way, where `datanet` is the name of the network in the NS descriptor, ip-profile is where you have to fill the associated parameters from the data model ( [NS data model](https://osm-download.etsi.org/repository/osm/debian/ReleaseFOURTEEN/docs/osm-im/osm_im_trees/etsi-nfv-nsd.html) ), and vnfd-connection-point-ref is the reference to the connection point:

```yaml

--config '{vld: [ {name: datanet, ip-profile: {...}, vnfd-connection-point-ref: {...} } ] }'

### Specify IP profile information for an internal VLD of a VNF

In this scenario, the mapping can be specified in the following way, where `vnf1` is the member vnf index of the constituent vnf in the NS descriptor, `internal` is the name of internal-vld in the VNF descriptor and ip-profile is where you have to fill the associated parameters from the data model ([VNF data model](https://osm-download.etsi.org/repository/osm/debian/ReleaseTHIRTEEN/docs/osm-im/osm_im_trees/etsi-nfv-vnfd.html)):

In this scenario, the mapping can be specified in the following way, where `vnf1` is the member vnf index of the constituent vnf in the NS descriptor, `internal` is the name of internal-vld in the VNF descriptor and ip-profile is where you have to fill the associated parameters from the data model ([VNF data model](https://osm-download.etsi.org/repository/osm/debian/ReleaseFOURTEEN/docs/osm-im/osm_im_trees/etsi-nfv-vnfd.html)):

```yaml

--config '{vnf: [ {member-vnf-index: vnf1, internal-vld: [ {name: internal, ip-profile: {...} ] } ] }'

#### Specify IP address for an interface

In this scenario, the mapping can be specified in the following way, where `vnf1` is the member vnf index of the constituent vnf in the NS descriptor, 'internal' is the name of internal-vld in the VNF descriptor, ip-profile is where you have to fill the associated parameters from the data model ([VNF data model](https://osm-download.etsi.org/repository/osm/debian/ReleaseTHIRTEEN/docs/osm-im/osm_im_trees/etsi-nfv-vnfd.html)), `id1` is the internal-connection-point id and `a.b.c.d` is the IP that you have to specify for this scenario:

In this scenario, the mapping can be specified in the following way, where `vnf1` is the member vnf index of the constituent vnf in the NS descriptor, 'internal' is the name of internal-vld in the VNF descriptor, ip-profile is where you have to fill the associated parameters from the data model ([VNF data model](https://osm-download.etsi.org/repository/osm/debian/ReleaseFOURTEEN/docs/osm-im/osm_im_trees/etsi-nfv-vnfd.html)), `id1` is the internal-connection-point id and `a.b.c.d` is the IP that you have to specify for this scenario:

```yaml

--config '{vnf: [ {member-vnf-index: vnf1, internal-vld: [ {name: internal, ip-profile: {...}, internal-connection-point: [{id-ref: id1, ip-address: "a.b.c.d"}] ] } ] }'

```bash

osm ns-create --ns_name hf-basic --nsd_name hackfest_basic-ns

With the previous hackfest example, according [VNF data model](https://osm-download.etsi.org/repository/osm/debian/ReleaseTHIRTEEN/docs/osm-im/osm_im_trees/etsi-nfv-vnfd.html) you will add in VNF Descriptor:

With the previous hackfest example, according [VNF data model](https://osm-download.etsi.org/repository/osm/debian/ReleaseFOURTEEN/docs/osm-im/osm_im_trees/etsi-nfv-vnfd.html) you will add in VNF Descriptor:

```yaml

     volumes:

### Creating a Network Slice Template (NST)

Based on the OSM information model for Network slice templates [here](http://osm-download.etsi.org/repository/osm/debian/ReleaseTHIRTEEN/docs/osm-im/osm_im_trees/nst.html) it is possible to start writing the YAML descriptor for the NST.

Based on the OSM information model for Network slice templates [here](http://osm-download.etsi.org/repository/osm/debian/ReleaseFOURTEEN/docs/osm-im/osm_im_trees/nst.html) it is possible to start writing the YAML descriptor for the NST.

```yaml

nst:

- **[VNF Onboarding Guide](https://osm.etsi.org/docs/vnf-onboarding-guidelines).** This guide includes all that you might need to onboard your VNF or applications in OSM.

- **[OSM Developer Guide][developer-guide].** If you want to contribute to OSM development, it is highly recommended reading this guide first.

- **[Sample VNF Packages](https://osm.etsi.org/gitlab/vnf-onboarding/osm-packages.git).**

- **[Contents from latest edition of OSM Hackfest][latest-hackfest].**

- **Sample VNF Packages.** This page is under elaboration, but you can find relevant contents in these locations:

  - **[Examples from OSM Hackfests][latest-hackfest]**

  - **[Analysis of some Hackfest VNFs](https://osm.etsi.org/wikipub/index.php/Examples_from_OSM_Hackfests)**

  - **[ANNEX 6: Tests to validate VIM capabilities from OSM](14-tests-for-vim-validation.md)**

- [OSM Workshops and Webinars](https://osm.etsi.org/wikipub/index.php/OSM_workshops_and_events)

- [Release notes and white papers](https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers)

## How to install standalone OSM client

### How to install OSM Client in Ubuntu 20.04 (RECOMMENDED)

### How to install OSM Client in Ubuntu 22.04 (RECOMMENDED)

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 20.04 system, following the procedure below:

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

# Clean the previous repos that might exist

# Install dependencies

sudo apt-get update

sudo apt-get install -y libcurl4-openssl-dev libssl-dev software-properties-common apt-transport-https

sudo apt-get install -y python3.8 python3-setuptools python3-dev python3-pip

sudo apt-get install -y python3 python3-dev python3-pip

# Add OSM debian repo

curl -q -o OSM-ETSI-Release-key.gpg https://osm-download.etsi.org/repository/osm/debian/ReleaseTHIRTEEN/OSM%20ETSI%20Release%20Key.gpg

curl -q -o OSM-ETSI-Release-key.gpg https://osm-download.etsi.org/repository/osm/debian/ReleaseFOURTEEN/OSM%20ETSI%20Release%20Key.gpg

sudo apt-key add OSM-ETSI-Release-key.gpg

sudo add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseTHIRTEEN stable devops IM osmclient"

sudo add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseFOURTEEN stable devops IM osmclient"

sudo apt-get update

# Install OSM IM and osmclient packages from deb repo

sudo snap install charm --classic

```

### How to install OSM Client in Ubuntu 20.04 via pip (ALTERNATIVE)

### How to install OSM Client in Ubuntu 22.04 via pip (ALTERNATIVE)

```bash

# Install dependencies

sudo apt-get update

sudo apt-get install -y libcurl4-openssl-dev libssl-dev software-properties-common apt-transport-https

sudo apt-get install -y git wget make

sudo apt-get install -y python3.8 python3-setuptools python3-dev python3-pip

sudo apt-get install -y python3 python3-dev python3-pip

# Upgrade pip to the latest version (with sudo, to install it globally for all users)

sudo -H python3 -m pip install -U pip

# Decide which version to use (e.g., v13.0)

export OSM_CLIENT_VERSION=v13.0

# Decide which version to use (e.g., v14.0)

export OSM_CLIENT_VERSION=v14.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}"

sudo snap install charm --classic

```

### How to install OSM Client in RHEL 8.4

### How to install OSM Client in RHEL

```bash

# Install dependencies

sudo dnf upgrade -y

sudo dnf install -y libcurl-devel openssl-devel

sudo dnf install -y git wget make patch gcc

sudo dnf install -y python38 python38-devel

sudo dnf install -y python310 python310-devel

# Upgrade pip to the latest version (with sudo, to install it globally for all users)

sudo -H python3 -m pip install -U pip

# Decide which version to use (e.g., v13.0)

export OSM_CLIENT_VERSION=v13.0

# Decide which version to use (e.g., v43.0)

export OSM_CLIENT_VERSION=v14.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}"

```

### How to install OSM Client for developers in Ubuntu 20.04

### How to install OSM Client for developers in Ubuntu 22.04

```bash

# Install dependencies

sudo apt-get update

sudo apt-get install -y libcurl4-openssl-dev libssl-dev software-properties-common apt-transport-https

sudo apt-get install -y git wget make

sudo apt-get install -y python3.8 python3-setuptools python3-dev python3-pip

sudo apt-get install -y python3 python3-setuptools python3-dev python3-pip

# Upgrade pip to the latest version (with sudo, to install it globally for all users)

sudo -H python3 -m pip install -U pip

# Decide which version to use (e.g., v13.0)

export OSM_CLIENT_VERSION=v13.0

# Decide which version to use (e.g., v14.0)

export OSM_CLIENT_VERSION=v14.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}"

OSM client can be easily installed in Windows by installing an Ubuntu distro on Linux with [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install).

Once WSL is installed with an Ubuntu 20.04 distro, you can install OSM following the instruccions in (#how-to-install-osm-client-in-ubuntu-2004)

Once WSL is installed with an Ubuntu 22.04 distro, you can install OSM following the instruccions in (#how-to-install-osm-client-in-ubuntu-2204)

### How to install OSM Client directly in Windows with Conda and Git

Open Git Bash and run the following commands to create a Conda environment with Python 3.8 and initialize all shells to work with Conda:

```bash

conda create -n osm-env python=3.8

conda create -n osm-env python=3.10

conda init --all

# Logout

```

```bash

# Install conda and install some packages via conda (which will install dependent libraries)

conda activate osm-env

conda install pycurl==7.45.1

# Upgrade pip to the latest version (with sudo, to install it globally for all users)

python -m pip install -U pip

# Decide which version to use (e.g., v13.0)

export OSM_CLIENT_VERSION=v13.0

# Decide which version to use (e.g., v14.0)

export OSM_CLIENT_VERSION=v14.0

# Clone IM repo and checkut the desired version

git clone https://osm.etsi.org/gerrit/osm/IM

from osmclient import client

from osmclient.common.exceptions import ClientException

hostname = "127.0.0.1"

myclient = client.Client(host=hostname, sol005=True)

myclient = client.Client(host=hostname)

resp = myclient.nsd.list()

print yaml.safe_dump(resp)

```