Skip to content

Commit

Permalink
R2 Release Notes language corrections. (#169)
Browse files Browse the repository at this point in the history 
Signed-off-by: Michael Greaves <[email protected]>
  • Loading branch information
@mpgreaves
mpgreaves committed Sep 26, 2024
1 parent 7c723c3 commit bc652c9
Showing 1 changed file with 78 additions and 68 deletions.
146 changes: 78 additions & 68 deletions content/en/docs/release-notes/R2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ weight: 1

## Prerequisites

Please refer to the [Install Guide](/content/en/docs/guides/install-guides/install-on-byoc.md#prerequisites)
for the prerequisites on supported environments.
Refer to the [Install Guide](/content/en/docs/guides/install-guides/install-on-byoc.md#prerequisites)
for the prerequisites for supported environments.

## Support Matrix
## Support matrix

The sandbox environment requires a physical or virtual machine with:
The sandbox environment requires a physical or virtual machine with the following:
- Ubuntu-20.04-focal or Ubuntu 22.04 Linux Or Fedora 34
- Minimum 8 cores and Recommended 16 cores (Needed for end-to-end testing with RAN and core )
- a minimum of eight cores and a recommended 16 cores (these are needed for end-to-end testing with RAN and core)
- 32 GB memory
- 200 GB disk size
- Default user with sudo passwordless permissions
- a default user with sudo passwordless permissions

This installation has been verified on VMs running on Google Cloud.

Expand All @@ -27,14 +27,17 @@ A Nephio sandbox can be created on any Kubernetes cluster v1.26 and above.

### API

Common CRDs provided for 5G Core and RAN services
Common CRDs are provided for 5G Core and RAN services.

### Web UI

Basic web UI to view and manage the packages and resources within them.
Nephio has a basic web UI to view and manage the packages, and the resources contained in
the packages.

### Packages

The following packages are supported:

* Kpt packages for all [free5GC](https://free5gc.org/) services
* Kpt packages for all [OAI](https://openairinterface.org/) services
* Packages for the core Nephio services
Expand All @@ -43,87 +46,94 @@ Basic web UI to view and manage the packages and resources within them.

### Functionalities

* Multi-vendor support
The following functionalities are supported:

* Multivendor support
* API changes
* Generalization
* Parameterization
* Reuse of params
* Multi-cloud support
* Multicloud support
* Sandbox
* GCP
* OpenShift
* OAI components
* Deploying OAI 5G Core and RAN Network Functions (CU-CP, CU-UP, RF Simulated DU)
* OAI 5G Core network functions are developed using Python KOPF (Kubernetes Operator Framework)
* End to End call with RF Simulated OAI-NR-UE
* Deploying OAI 5G Core and RAN Network Functions (CU-CP, CU-UP, RF Simulated DU).
* OAI 5G Core network functions are developed using Python Kubernetes Operator Framework (KOPF).
* End-to-end call with RF Simulated OAI-NR-UE.
* Integration with new release of Porch
* Porch is now part of Nephio and hosted in Nephio repository.
* Stability
* Security
* Repo watcher changes
* Porch is now part of Nephio and is hosted in the Nephio repository.
* Stability.
* Security.
* Repo watcher changes.
* Documentation
* New web based documentation
* New web-based documentation.
* Experimental
* Nephio SDK
* Flux-based deployment of Helm charts
* Helm-to-operator converter
* Topology Controller - Northbound API to express the network topology
* Nephio SDK.
* Flux-based deployment of Helm charts.
* Helm-to-operator converter.
* Topology Controller - Northbound API to express the network topology.


### Fixes

* Removing rigid dependency on Gitea
* Upgrading the Multus version
* ConfigMap generator function
* WebUI configuration options for authentication
* Reorganizing the package catalog
* Reduce hard coding of NF parameters
* Stability of end-to-end tests
* Porch improvements
* Documentation enhancements
The following fixes are available:

* Removing rigid dependency on Gitea.
* Upgrading the Multus version.
* ConfigMap generator function.
* Web UI configuration options for authentication.
* Reorganizing the package catalog.
* Reducing the hard coding of the NF parameters.
* Stability of end-to-end tests.
* Porch improvements.
* Documentation enhancements.

## Limitations

* For infrastructure automation, only creation of KIND clusters is
supported.
* Inter-cluster networking is not dynamic so as more clusters are
deployed, some manual tweaking will be needed for inter-cluster communications.
* Provisioning of VLAN interfaces on nodes is manual at this time.
* Feedback of workload deployments from workload clusters to the Management
cluster is limited. You may need to connect directly to the Workload cluster
via kubectl to debug any deployment issues.
* Web UI features are limited to view/edit of packages and resources in those
packages and their deployment. Additional features will be added
in subsequent releases.
* When the capacities of the UPF,SMF and AMF NFs are changed, the free5GC Operator on the
Workload cluster will instantiate a new POD with correspondingly modified
resources (CPU, memory etc.) During this process, the pod will restart. This is a
The following limitations need to be borne in mind:

* For infrastructure automation, only the creation of KIND clusters is supported.
* Inter-cluster networking is not dynamic. Therefore, as more clusters are deployed,
some manual tweaking will be needed for inter-cluster communications.
* Provisioning of VLAN interfaces on nodes is currently performed manually.
* Feedback of workload deployments from workload clusters to the management cluster
is limited. You may need to connect directly to the workload cluster via kubectl to
debug any deployment issues.
* Web UI features are limited to the viewing/editing of packages and resources in those
packages and their deployment. Additional features will be added in subsequent releases.
* When the capacities of the UPF, SMF, and AMF NFs are changed, the free5GC Operator on
the workload cluster will instantiate a new POD with correspondingly modified resources
(CPU, memory, and so on). During this process, the POD will restart. This is a
limitation of free5GC.
* Only Gitea works with automated cluster provisioning to create new
repositories and join them to Nephio. To use a different Git provider, you
must manually provision cluster repositories, register them to the Nephio
management server, and set up Config Sync on the Workload cluster.
* The WebUI does not require authentication in the current demo configuration.
Testing of the WebUI with authentication configured has not been done at this
time.
* The WebUI only shows resources in the default namespace.
* While many types of Git authentication are supported, the testing was only
done with token-based Git authentication in Gitea.

## Known Issues and Workarounds

* Packages may take a long time to be approved by the auto-approval
controller. If they seem stuck, restarting Porch and the Nephio controllers
may help:
* Only Gitea works with automated cluster provisioning to create new repositories and
join them to Nephio. To use a different Git provider, you must manually provision the
cluster repositories, register them to the Nephio management server, and set up Config
Sync on the workload cluster.
* In the current demo configuration, the Web UI does not require authentication. Testing
of the Web UI with authentication configured has not yet been done.
* The Web UI only shows resources in the default namespace.
* While many types of Git authentication are supported, testing has only been done with
token-based Git authentication in Gitea.

## Known issues and workarounds

* Packages may take time to be approved by the auto-approval controller. If they appear to have
frozen, it may help to restart Porch and the Nephio controllers using the following commands:
```bash
kubectl -n porch-system rollout restart deploy porch-server
kubectl -n nephio-system rollout restart deploy nephio-controller
```
* Occasional calls to `porchctl rpkg copy` may fail with a message like
* Occasional calls to `porchctl rpkg copy` may fail with the following message, or similar:
`Error: Internal error occurred: error applying patch: conflict: fragment line
does not match src line`. Try again in a little while, this may clear up on
its own. Restarting Porch may also help.
* During specialization, we may have duplicate parameterRef extensions, leading to failed deployments (wrong configurations are generated). The current workaround is to redeploy the package. The bug is due to NFDeploy reconciliation not being correctly idempotent.

* The free5GC operator may create duplicate entries in the SMF function configuration. This is harmless, but still incorrect.
* Links in the documentation may not render in Github due to the limitations of the tool being used for web based documentation.
does not match src line`.
If such a message appears, then retry in a little while, as this error may resolve itself. Restarting
Porch may also help.
* During specialization, we may have duplicate parameterRef extensions, leading to failed deployments
(the wrong configurations are generated). The current workaround is to redeploy the package. The bug is
due to the NFDeploy reconciliation not being idempotent.

* The free5GC operator may create duplicate entries in the SMF function configuration. This will not do
any harm, but is nevertheless incorrect.
* Links in the documentation may not render in Github, due to the limitations of the tool being used for
web-based documentation.

0 comments on commit bc652c9

Please sign in to comment.