1 Introduction

This guide describes how to install or upgrade Oracle Communications Cloud Native Core, Network Exposure Function (NEF) and Oracle Communications Common API Framework (CAPIF) in a cloud native environment and Oracle Cloud Infrastructure (OCI). It also includes information on performing fault recovery for NEF.

Note:

  • This guide covers the installation instructions when Podman is the container platform with Helm as the Packaging Manager. For any other container platform, the operator must use the commands based on to their deployed container runtime environment.
  • kubectl commands can vary based on the platform deployment. Replace kubectl with Kubernetes environment-specific command line tool to configure Kubernetes resources through kube-api server. The instructions provided in this document are as per the CNE version of kube-api server.

Caution:

User, computer and applications, and character encoding settings may cause an issue when copy-pasting commands or any content from PDF. PDF reader version also affects the copy-pasting functionality. It is recommended to verify the pasted content especially when the hyphens or any special characters are part of the copied content.

1.1 Overview

NEF is a key component of the 5G Service Based Architecture (SBA). NEF provides a platform to securely expose the network services and capabilities offered by the 5G Network Functions (NFs) to either external third-party applications or the internal Application Functions (AFs). As an interface between 5G core network and different application functions, NEF enables the operators to customize their network and provide innovative services to the end users.

Note:

The performance and capacity of the NEF system may vary based on the call model, feature or interface configuration, and underlying CNE and hardware environment.

NEF supports the following functions:

  • Facilitates robust and secure exposure of network services, such as voice, data connectivity, charging, subscriber data, IoT, and so on to trusted third-party applications or AFs
  • Provides programmable environment access of 5G network to operators
  • Provides 3GPP defined API exposure gateway to build new services
  • Enables AF to securely provide information to 3GPP network to authenticate, authorize, and assist in throttling the AF
  • Translates the information received from AF to the one sent to internal 3GPP NFs, and vice-versa
  • Provides support to expose the information collected from other 3GPP NFs to the AF
NEF interacts with different application functions and the 5G core network to support the above functions. The application consists of the following components running on seperate namespaces in the cloud native environment:

Note:

CAPIF and NEF can be installed in different cluster also, but the cluster has to be reachable.
  • Common API Framework (CAPIF): The service interfaces between NEF and the external third-party applications or internal Application Functions (AFs).
    CAPIF is a 3GPP defined secured framework to expose network service interfaces. It enables the API invokers (external applications) to discover and communicate with service APIs of the API provider (NEF). This framework manages API security, logging of events, auditing capability, multiple service exposure, policy based routing, dynamic routing of information, and so on. CAPIF consists of the following services:
    • AF Manager
    • API Manager
    • Event Manager Service
    • External Ingress Gateway
    • External Egress Gateway
    • Network Ingress Gateway
    • Network Egress Gateway
  • Network Exposure Function (NEF): The core component that runs the business logic of NEF. It consists of various services that interact with the CAPIF and perform the core functionality of NEF. NEF provides the following services:
  • 5GC Agent
  • APD Manager
  • API Router
  • CAPIF Core Function (CCF) Client
  • Expiry Auditor Service
  • Monitoring Events
  • QoS Service
  • External Ingress Gateway
  • External Egress Gateway
  • FiveGC Ingress Gateway
  • FiveGC Egress Gateway
  • Traffic Influence
  • Device Trigger
  • Pool Manager
  • MSISDN-Less MO-SMS

For more information about the services, see Oracle Communications Cloud Native Core, Network Exposure Function User Guide.

Installation and Upgrade Overview

NEF installation and upgrade procedures comprise of different tasks including CAPIF and NEF components. Perform the installation and upgrade tasks in the same sequence as outlined in the following table:

Table 1-1 Installation and Upgrade Overview

Task Sub task Reference Link
Installation Sequence
Set up the installation environment Prerequisite Prerequisites
Software Requirements Software Requirements
Environment Setup Requirements Environment Setup Requirements
Resource Requirements Resource Requirements
Download installation package Downlaod Package Installation Package Download
Perform CAPIF preinstallation tasks Create CAPIF Namespace Verifying and Creating CAPIF Namespace
Configure CAPIF databases Configuring Database, Creating Users, and Granting Permissions
Configure Secrets Configuring Kubernetes Secret for Accessing CAPIF Database
Configure Security Configuring Secrets for Enabling HTTPS
Perform CAPIF installation tasks Push images to docker registry Pushing the Images to Customer Docker Registry
Customize CAPIF Custom Values YAML file Customizing CAPIF
Install CAPIF Installing CAPIF Package
Perform Helm Test Performing Helm Test
Verify CAPIF installation Verifying CAPIF Installation Verifying CAPIF Installation
Perform NEF preinstallation tasks Create NEF Namespace Verifying and Creating NEF Namespace
Configure NEF databases Configuring Database, Creating Users, and Granting Permissions
Configure Secrets Configuring Kubernetes Secret for Accessing NEF Database
Configure Security Configuring Secrets for Enabling HTTPS
Perform NEF installation tasks Push images to docker registry Pushing the Images to Customer Docker Registry
Customize NEF Custom Values YAML file Customizing NEF
Install NEF Installing NEF Package
Verify NEF installation Verifying NEF Installation Verifying NEF Installation
Upgrade Sequence
Perform CAPIF upgrade tasks Preupgrade tasks Preupgrade Tasks
Upgrade CAPIF Upgrade Tasks
Perform NEF upgrade tasks Upgrade NEF Upgrade Tasks
Rollback Sequence
Perform NEF rollback Rollback NEF Rolling Back NEF
Perform CAPIF rollback Rollback CAPIF Rolling Back CAPIF

1.2 References

Refer to the following documents while deploying NEF:

  • Oracle Communications Cloud Native Core, Network Exposure Function User Guide
  • Oracle Communications Cloud Native Core, Network Exposure Function Troubleshooting Guide
  • Oracle Communications Cloud Native Core, Network Exposure Function Compatibility Matrix
  • Oracle Communications Cloud Native Core, Cloud Native Environment Installation, Upgrade, and Fault Recovery Guide
  • Oracle Communications Cloud Native Core, OCI Adaptor Deployment Guide

1.3 Oracle Error Correction Policy

The table below outlines the key details for the current and past releases, their General Availability (GA) dates, the latest patch versions, and the end dates for the Error Correction Grace Period.

Table 1-2 Error Correction Policy

Release Number General Availability (GA) Date Latest Patch Version Error Correction Grace Period End Date
3.24.2 July 2024 24.2.2 July 2025
3.24.1 April 2024 24.1.0 April 2025
3.23.4 December 2023 23.4.3 December 2024
2.23.3 September 2023 23.3.2 September 2024

Note:

For a release, Sev1 and Critical Patch Unit (CPU) patches are supported for 12 months. For more information, see the Oracle Communications Cloud Native Core and Network Analytics Error Correction Policy.

1.4 Open Source Support Policies

Oracle Communications Cloud Native Core uses open source technology governed by the Oracle Open Source Support Policies. For more information, see the Oracle Open Source Support Policies.