1 Introduction
This guide describes how to install or upgrade Oracle Communications Cloud Native Configuration Console (CNC Console) in a cloud native environment. It also includes information on performing fault recovery for CNC Console.
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.
kubectlcommands can vary based on the platform deployment. Replacekubectlwith 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
- CNC Console Core (CNCC Core): CNCC Core acts as GUI or API portal
for NFs and CNE common services. CNCC Core module includes CNC Console and its
integration with other Cloud Native Core network functions. The CNC Console
provides user interface that can be used to configure parameters for the
following CNC network functions:
- Oracle Communications Cloud Native Core, Binding Support Function (BSF)
- Oracle Communications Cloud Native Core, Service Communication Proxy (SCP)
- Oracle Communications Cloud Native Core, Network Repository Function (NRF)
- Oracle Communications Cloud Native Core, Converged Policy (Policy)
- Oracle Communications Cloud Native Core, Security Edge Protection Proxy (SEPP)
- Oracle Communications Cloud Native Core, Unified Data Repository (UDR)
- CNE Common Services
- Data Director (DD)
- Oracle Communications Network Data Analytics Function (NWDAF)
- Provisioning Gateway (PROVGW)
- CNC Console Identity Access Management (CNCC IAM): CNCC IAM acts as local identity provider and broker for external identity provider. CNCC IAM module includes the required authentication and authorization procedures such as creating and assigning roles to users.
Continuous Delivery Control Server (CDCS)
CNC Console can be deployed using Continuous Delivery Control Server (CDCS) or Command Line Interface (CLI) procedures as described in Installing CNC Console. CDCS provides continuous delivery functionality for multisite Cloud Native Core (CNC) installations. For more information about CDCS, see OOracle Communications CD Control Server User Guide..
CDCS is a centralized server that automates CNC Console deployment processes such as install, upgrade, and rollback CNC Console. CLI provides an interface to run various commands required to install, upgrade, and roll back CNC Console.
CNC Console installation comprises of prerequisites, pre-deployment , installation, and postinstallation tasks. You must perform CNC Console installation tasks in the same sequence as outlined in the following table:
| Task | Sub tasks | Reference | Applicable for CDCS | Applicable for CLI |
|---|---|---|---|---|
| Prerequisites: This section describes how to set up the installation environment. | Prerequisites | Yes | Yes | |
| Software Requirements | Software Requirements | Yes | Yes | |
| Environment Setup Requirements | Environment Setup Requirements | Yes | Yes | |
| Resource Requirements | Resource Requirements | Yes | Yes | |
| Downloading CNC Console | Downloading CNC Console package | See Oracle Communications CD Control Server Installation and Upgrade Guide | Yes | |
| Preinstallation Tasks | Preinstallation Tasks | Yes | Yes | |
| Verifying and Creating CNC Console Namespace | Verifying and Creating CNC Console Namespace | Yes | Yes | |
| Configuring Database | Configuring Database | Yes | Yes | |
| Installing CNC Console | Installing CNC Console | |||
| Global Configurations | Global Configurations | Yes | Yes | |
| CNC Console Configuration for Service Account | CNC Console Configuration for Service Account | Yes | Yes | |
| Configuring ASM and OSO in M-CNCC IAM | \Configuring CNC Console to support Aspen Service Mesh | Yes | Yes | |
| CNC Console IAM Pre-deployment Configuration | CNC Console IAM Pre-deployment Configuration | Yes | Yes | |
| Configuring M-CNCC IAM Database | Configuring M-CNCC IAM Database | Yes | Yes | |
| Configuring Secret for Default or Admin User in M-CNCC IAM | Configuring Secret for Default or Admin User in M-CNCC IAM | Yes | Yes | |
| Configuring Secret to Enable HTTPS in M-CNCC IAM | Configuring Secret to Enable HTTPS in M-CNCC IAM | Yes | Yes | |
| Configuring LDAPS in M-CNCC IAM | Configuring LDAPS in M-CNCC IAM | Yes | Yes | |
| M-CNCC Core Pre-deployment Configuration | M-CNCC Core Pre-deployment Configuration | Yes | Yes | |
| Configuring MySQL in M-CNCC Core | Configuring MySQL in M-CNCC Core | Yes | Yes | |
| Configuring Secret to Enable HTTPS in M-CNCC Core | Configuring Secret to Enable HTTPS in M-CNCC Core | Yes | Yes | |
| A-CNCC Core Pre-deployment Configuration | A-CNCC Core Pre-deployment Configuration | Yes | Yes | |
| Configuring Secret to Enable HTTPS in A-CNCC Core | Configuring Secret to Enable HTTPS in A-CNCC Core | Yes | Yes | |
| Configuring A-CNCC Core mTLS | Configuring A-CNCC Core mTLS | Yes | Yes | |
| Deploying CNC Console | Deploying CNC Console | See Oracle Communications CD Control Server Installation and Upgrade Guide | Yes | |
| Verifying CNC Console Installation | Verifying CNC Console Installation | Yes | Yes | |
| Customizing CNC Console | Customizing CNC Console | Yes | Yes | |
| Accessing CNC Console | Accessing CNC Console | Yes | Yes | |
| Upgrading CNC Console | Upgrading CNC Console | See Oracle Communications CD Control Server Installation and Upgrade Guide | Yes | |
| Uninstalling CNC Console | Uninstalling CNC Console | Yes | Yes | |
| CNC Console IAM PostInstallation Steps | CNC Console IAM PostInstallation Steps | Yes | Yes | |
| Performing Helm Test | Performing Helm Test | Yes | Yes | |
| Configuring CNC Console to support ASM and OSO | Configuring CNC Console to support ASM and OSO | Yes | Yes |
1.2 CNC Console Compatibility Matrix
This section lists the versions of added or updated components in release 23.4.x. To know the list of all the supported versions, see Oracle Communications Cloud Native Core Release Notes.
Release 23.4.3
Table 1-1 Compatibility Matrix
| Network Functions | Compatible Versions |
|---|---|
| BSF | 23.4.x |
| NRF | 23.4.x |
| NSSF | 23.4.x |
| Policy | 23.4.x |
| SCP | 23.4.x |
| SEPP | 23.4.x |
| UDR | 23.4.x |
CNC Console is compatible with the following components:
Table 1-2 Compatibility Matrix
| Components | Compatible Versions |
|---|---|
| OCNADD | 23.4.x |
| CNE | 23.4.x, 23.3.x, 23.2.x |
| cnDBTier | 23.4.x, 23.3.x, 23.2.x |
| CDCS | 23.4.x, 23.3.x, 23.2.x |
| OSO | 23.4.x, 23.3.x, 23.2.x |
| ASM | 1.14.6-am1, 1.11.8-am1. 1.9.8-am1 |
| OCNWDAF | 23.4.x |
| PROVGW | 23.4.x |
| OCCM | 23.4.x |
Release 23.4.2
Table 1-3 Compatibility Matrix
| Network Functions | Compatible Versions |
|---|---|
| BSF | 23.4.x |
| NRF | 23.4.x |
| NSSF | 23.4.x |
| Policy | 23.4.x |
| SCP | 23.4.x |
| SEPP | 23.4.x |
| UDR | 23.4.x |
CNC Console is compatible with the following components:
Table 1-4 Compatibility Matrix
| Components | Compatible Versions |
|---|---|
| OCNADD | 23.4.x |
| CNE | 23.4.x, 23.3.x, 23.2.x |
| cnDBTier | 23.4.x, 23.3.x, 23.2.x |
| CDCS | 23.4.x, 23.3.x, 23.2.x |
| OSO | 23.4.x, 23.3.x, 23.2.x |
| ASM | 1.14.6-am1, 1.11.8-am1. 1.9.8-am1 |
| OCNWDAF | 23.4.x |
| PROVGW | 23.4.x |
| OCCM | 23.4.x |
Release 23.4.1
Table 1-5 Compatibility Matrix
| Network Functions | Compatible Versions |
|---|---|
| BSF | 23.4.x |
| NRF | 23.4.x |
| NSSF | 23.4.x |
| Policy | 23.4.x |
| SCP | 23.4.x |
| SEPP | 23.4.x |
| UDR | 23.4.x |
CNC Console is compatible with the following components:
Table 1-6 Compatibility Matrix
| Components | Compatible Versions |
|---|---|
| OCNADD | 23.4.x |
| CNE | 23.4.x, 23.3.x, 23.2.x |
| cnDBTier | 23.4.x, 23.3.x, 23.2.x |
| CDCS | 23.4.x, 23.3.x, 23.2.x |
| OSO | 23.4.x, 23.3.x, 23.2.x |
| ASM | 1.14.6-am1, 1.11.8-am1. 1.9.8-am1 |
| OCNWDAF | 23.4.x |
| PROVGW | 23.4.x |
| OCCM | 23.4.x |
Release 23.4.0
Table 1-7 Compatibility Matrix
| Network Functions | Compatible Versions |
|---|---|
| BSF | 23.4.x |
| NRF | 23.4.x |
| NSSF | 23.4.x |
| Policy | 23.4.x |
| SCP | 23.4.x |
| SEPP | 23.4.x |
| UDR | 23.4.x |
CNC Console is compatible with the following components:
Table 1-8 Compatibility Matrix
| Components | Compatible Versions |
|---|---|
| OCNADD | 23.4.x |
| CNE | 23.4.x, 23.3.x, 23.2.x |
| cnDBTier | 23.4.x, 23.3.x, 23.2.x |
| CDCS | 23.4.x, 23.3.x, 23.2.x |
| OSO | 23.3.x, 23.2.x, 22.3.x |
| ASM | 1.14.6-am1, 1.11.8-am1. 1.9.8-am1 |
| OCNWDAF | 23.4.x |
| PROVGW | 23.4.x |
| OCCM | 23.4.x |
1.3 CNC Console Deployment Architecture
Introduction
The CNC Console supports both single and multiple cluster deployments. In a single cluster deployment, the CNC Console manages NFs and CNE common services deployed in the local Kubernetes clusters. In a multicluster deployment, the CNC Console manages NFs and CNE common services deployed in the remote Kubernetes clusters. This section explains the Console component overview, terminologies used, and Console single Cluster and multicluster deployment details.
CNC Console Component Overview
Figure 1-1 CNC Console Component Overview
- M-CNCC
- A-CNCC
M-CNCC
Manager CNC Console or M-CNCC is a CNC Console instance which manages multiple A-CNCC and local instances.
M-CNCC has two components M-CNCC IAM and M-CNCC Core.
Manager CNC Console IAM or M-CNCC IAM is an IAM component of M-CNCC. M-CNCC IAM contains M-CNCC IAM Ingress Gateway (CNCC IAM IGW) and M-CNCC IAM Back End (M-CNCC IAM BE) microservices.
M-CNCC CoreManager CNC Console Core or M-CNCC Core is a core component of M-CNCC which provide GUI and API access portal for accessing NF and OCCNE common service. M-CNCC Core contains M-CNCC Core Ingress Gateway (CNCC Core IGW) and M-CNCC Core Back End (M-CNCC Core BE) microservices.
A-CNCC
A-CNCC Core
- A-CNCC Core contains A-CNCC Core Ingress Gateway.
- A-CNCC Core has no IAM component.
1.3.1 Single Cluster Deployment Architecture
In a single cluster deployment, CNC Console can manage NFs and CNE common services deployed in the local Kubernetes cluster.
The following diagram represents the CNC Console single cluster deployment:
Figure 1-2 CNC Console Single Cluster Deployment Architecture
1.3.2 Multicluster Deployment Architecture
In a multicluster deployment, CNC Console can manage NFs and CNE common services deployed in the remote Kubernetes cluster(s). CNC Console instance called A-CNCC is needed on remote kubernetes clusters for this deployment. CNC Console instance providing the API access through GUI portal and managing the A-CNCC(s) is called M-CNCC.
The following diagram represents the CNC Console multicluster deployment:
Figure 1-3 CNC Console Multi Cluster Deployment Architecture
Note:
- For a single cluster deployment both manager (CNCC IAM, M-CNCC Core) and agent (A-CNCC) are to be deployed on the same cluster.
- For a multicluster deployment, if manager cluster has a local NF deployment then both manager (CNCC IAM, M-CNCC Core) and agent (A-CNCC) is to be deployed on the same cluster.
- In case manager cluster does not have a local NF deployment, then only manager (CNCC IAM, M-CNCC Core) is to be deployed and agent (A-CNCC) to be deployed on a cluster where NFs are present.
- The manager manages CNE or OSO common services if present in a
cluster.
- Manager in a cluster is preferred over Agent in the same cluster to manage the CNE common services.
- Agent in a cluster can manage CNE common services in absence of a Manager in the same cluster.
- Agent is needed only when NFs are present on the cluster.
1.4 Supported Deployment Models
- Single Cluster, Single Instance (Dedicated Console for each NF in a cluster)
- Single Cluster, Multiple Instances (One Console for many NFs or Instances in a cluster)
- Multiple Clusters, Single Instance (Multiple clusters with single NF or Instance in each cluster, M-CNCC/A-CNCC sitting in same or different clusters)
- Multiple Clusters, Multiple Instances (Multiple clusters with multiple NF/Instance in each cluster, M-CNCC/A-CNCC sitting in same or different clusters)
1.4.1 Deployment Model 1 - Single Cluster, Single Instance (Dedicated Console for each NF in a cluster)
This deployment model has dedicated Console for each NF in a cluster.
Figure 1-4 Deployment Model 1 - Single Cluster, Single Instance (Dedicated Console for each NF in a cluster)
- Dedicated Console for a NF. Only single instance of NF is supported.
- Console shares the cnDBTier with NF.
- Any failure in NF cnDBTier impacts Console. Access to CNE Common Services (CS) is lost in case of any failure in NF cnDBTier.
- NFs and Console release compatibility must be maintained.
- M-CNCC and A-CNCC are managed by single Helm chart.
1.4.2 Deployment Model 2 - Single Cluster, Multiple Instances (One Console for many NFs/Instances in a cluster)
This deployment model has one Console for many NFs/Instances in a cluster.
Figure 1-5 Deployment Model 2 - Single Cluster, Multiple Instances (One Console for many NFs/Instances in a cluster)
- Shared Console for multiple NFs. NFs can be of same or different NF Type.
- Console needs dedicated cnDBTier for M-CNCC.
- NFs and Console release compatibility must be maintained.
- M-CNCC and A-CNCC are managed by single Helm chart.
1.4.3 Deployment Model 3 - Multiple Clusters, Single Instance (Multiple clusters with single NF or Instance in each cluster, M-CNCC or A-CNCC sitting in the same or different clusters)
This deployment model is for multiple clusters with single NF or Instance in each cluster. M-CNCC or A-CNCC can be in same or different clusters.
Figure 1-6 Deployment Model 3 - Multiple Clusters, Single Instance (Multiple clusters with single NF/Instance in each cluster, M-CNCC/A-CNCC sitting in same/different clusters)
- Dedicated Console for a single NF
- Console shares the cnDBTier with N.
- Any failure in NF cnDBTier impacts Console. Access to CNE Common Services (CS) is lost on any failure in NF cnDBTier.
- NFs and Console release compatibility must be maintained.
- Managers can be deployed as Active/Active/Active.
- Multiple Agents are supported.
- M-CNCC can be deployed without A-CNCC in case there are no local NFs to be managed at the Kubernetes Cluster.
- M-CNCC and A-CNCC are managed by single Helm chart.
- M-CNCC cannot manage NFs located in another M-CNCC Kubernetes Cluster.
1.4.4 Deployment Model 4 - Multiple Clusters, Multiple Instances (Multiple clusters with multiple NF/Instance in each cluster, M-CNCC/A-CNCC sitting in same/different clusters)
This deployment model is for multiple clusters with multiple NF/Instance in each cluster. M-CNCC/A-CNCC can be in same/different clusters.
Figure 1-7 Deployment Model 4 - Multiple Clusters, Multiple Instances (Multiple clusters with multiple NF/Instance in each cluster, M-CNCC/A-CNCC sitting in same/different clusters)
- Shared Console for multiple NFs. NFs can be of same or different NF Type.
- Console needs dedicated cnDBTier for M-CNCC.
- NFs and Console release compatibility must be maintained.
- Managers can be deployed as Active/Active/Active.
- Multiple Agents are supported.
- M-CNCC and A-CNCC are managed by Single Helm Chart.
- M-CNCC cannot manage NFs located in another M-CNCC Kubernetes Cluster.
1.5 CNC Console Deployment Model Matrix
CNC Console Deployment Model Matrix
The following table provides details on support of console deployment models for various network functions:
Table 1-9 CNC Console Deployment Model Matrix
| Deployment Models | Policy | BSF | SCP | UDR | NRF | SEPP | NSSF | DD | PROVGW | NWDAF | OCCM |
|---|---|---|---|---|---|---|---|---|---|---|---|
| Model 1 - Single Cluster, Single Instance (Dedicated Console for each NF in a cluster) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Model 2 - Single Cluster, Multiple Instances (One Console for many NFs/Instances in a cluster) | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | Yes |
| Model 3 - Multiple Clusters, Single Instance (Multiple clusters with single NF/Instance in each cluster, M-CNCC/A-CNCC sitting in same/different clusters) | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Model 4 - Multiple Clusters, Multiple Instances (Multiple clusters with multiple NF/Instance in each cluster, M-CNCC/A-CNCC sitting in same/different clusters) | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | Yes |
Note:
- Single instance of CNC Console supports either single instances of all NFs or multiple instances of a single NF types within a Kubernetes cluster.
- For example, a single instance of CNC Console can either handle a single instance of Policy, SCP, NRF and so on, or multiple instances of Policy or SCP within a Kubernetes cluster.
1.6 Configuration Workflow
This section explains the configuration workflow for the following scenarios:
- Fresh Installation
- Add a new M-CNCC
- Add a new A-CNCC
- Remove M-CNCC from A-CNCC
- Remove A-CNCC from M-CNCC
1.6.1 Fresh Installation of M-CNCC and A-CNCC
This section explains how to do a fresh installation of M-CNCC and A-CNCC.
The following diagram represents the fresh installation of M-CNCC and A-CNCC.
Figure 1-8 Fresh Installation of M-CNCC and A-CNCC
Procedure:
- Install M-CNCC IAM, A-CNCC Core, and M-CNCC Core on M-CNCC Kubernetes clusters.
- Configuration Input: M-CNCC IAM(s), A-CNCC Core(s), and instances
- A-CNCC Core on M-CNCC Kubernetes cluster is optional and needed
only if there are NF instances on the M-CNCC Kubernetes cluster.
Note:
CS Instances are managed directly by M-CNCC Core and does not need A-CNCC Core.
- Install A-CNCC Core on A-CNCC Kubernetes clusters.
- Configuration Input: M-CNCC IAMs and local instances
See Installing CNC Console section for installation procedure.
1.6.2 Add a New M-CNCC
This section explains how to add a new M-CNCC.
The following diagram represents the addition of a new M-CNCC:
Figure 1-9 Add a new M-CNCC
Procedure:
1. Install M-CNCC IAM, A-CNCC Core, M-CNCC Core on M-CNCC Kubernetes cluster.
- Configuration Input: M-CNCC IAM(s), A-CNCC Core(s) and instances
- A-CNCC Core on M-CNCC Kubernetes cluster is optional and needed only if
there are NF instances on the M-CNCC k8s cluster.
Note:
CS Instances are managed directly by M-CNCC Core and does not need A-CNCC Core.
2. Update A-CNCC Core(s) on A-CNCC Kubernetes cluster(s)
- Configuration Update: Newly added M-CNCC IAM
See Installing CNC Console section for installation procedure.
1.6.3 Add a New A-CNCC
This section explains how to add a new A-CNCC.
The following diagram represents the addition of a new A-CNCC:
Figure 1-10 Add a new A-CNCC
Procedure
1.Install A-CNCC Core on new A-CNCC Kubernetes cluster.
- Configuration Input: M-CNCC IAMs and local instances.
2.Update M-CNCC Core on existing M-CNCC Kubernetes clusters.
- Configuration Update: Newly added A-CNCC.
See Installing CNC Console section for installation procedure.
1.6.4 Remove M-CNCC from A-CNCC
This section explains how to remove M-CNCC from A-CNCC.
The following diagram represents the removal of M-CNCC from A-CNCC:
Figure 1-11 Remove M-CNCC from A-CNCC
Procedure
1.Update A-CNCC (one or more)
- Configuration Update: Edit A-CNCC configuration to remove M-CNCC IAM
See Installing CNC Console section for installation procedure.
1.6.5 Remove A-CNCC from M-CNCC
This section explains how to remove A-CNCC from M-CNCC.
The following diagram represents the removal of A-CNCC from M-CNCC:
Figure 1-12 Remove A-CNCC from M-CNCC
Procedure
1.Update M-CNCC (one or more)
- Configuration Update: Edit M-CNCC Core configuration to remove A-CNCC
See Installing CNC Console section for installation procedure.
1.7 CNC Console Configuration Maximum Limits
The following table covers the maximum limit defined in CNC Console configuration.
Table 1-10 CNC Console Configuration Maximum Limits
| Attribute Name | Max Limit |
|---|---|
| Max length of cnccId | 40 |
| Max length of instanceId | 80 |
| Max number of A-CNCC (aCnccs) | 36 |
| Max number of instances | 288 |
| Max number of M-CNCC (mCnccs) | 3 |
1.8 Reference
Refer to the following documents for more information:
- Oracle Communications Cloud Native Core, Service Communication Proxy User Guide
- Oracle Communications Cloud Native Core, Network Repository Function User Guide
- Oracle Communications Cloud Native Core, Policy User Guide
- Oracle Communications Cloud Native Core, Unified Data Repository User Guide
- Oracle Communications Cloud Native Core, Binding Support Function User Guide
- Oracle Communications Cloud Native Core, Security Edge Protection Proxy User Guide
- Oracle Communications Cloud Native Core, Network Slice Selection Function User Guide
- Oracle Communications Cloud Native Core, Network Repository Function Installation, Upgrade, and Fault Recovery Guide
- Oracle Communications Cloud Native Core, Service Communication Proxy Installation Guide
- Oracle Communications Cloud Native Core, Unified Data Repository Installation, Upgrade, and Fault Recovery Guide
- Oracle Communications Cloud Native Core, Binding Support Function Installation Guide
- Oracle Communications Cloud Native Core, Policy Installation Guide
- Oracle Communications Cloud Native Core, Security Edge Protection Proxy Installation Guide
- Oracle Communications Cloud Native Core, Network Slice Selection Function Installation Guide
- Oracle Communications Networks Data Analytics Installation and Fault Recovery Guide