-
Notifications
You must be signed in to change notification settings - Fork 36
Add R5 release notes #242
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add R5 release notes #242
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| --- | ||
| title: Nephio R5 Release Notes | ||
| weight: 1 | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| Building on the strong foundations of previous releases, Nephio R5 introduces further advancements in functionality, | ||
| usability, security, and scalability in readiness for wider adoption and new use cases. | ||
| Key highlights of Nephio R5 include: | ||
| - [O-RAN OCloud Cluster provisioning](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-4-ocloud-cluster-prov.md) | ||
| - [Baremetal cluster provisioning](/content/en/docs/guides/install-guides/baremetal-infra-components.md) | ||
| - [ArgoCD GitOps workload reconciliation support](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-5-argocd-wl.md) | ||
| - Platform improvements | ||
| - Security enhancements | ||
| - Other improvements include a number of dependency upgrades and security fixes | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Refer to the [Installation Guide](/content/en/docs/guides/install-guides/install-on-byoc.md#prerequisites) for the | ||
| prerequisites on supported environments. | ||
|
|
||
| ## Support matrix | ||
|
|
||
| The [Nephio sandbox demo](/content/en/docs/guides/install-guides/_index.md) environment requires hardware with the | ||
| following specifications: | ||
|
|
||
| ### OS support | ||
|
|
||
| - **Ubuntu 22.04** | ||
| - **Fedora 38** | ||
|
|
||
| ### System Requirements | ||
|
|
||
| | Resource | Minimum | Recommended | | ||
| |----------|---------|-------------| | ||
| | vCPU | 6 | 16 | | ||
| | Memory | 6 GB | 32 GB | | ||
| | Disk | 50 GB | 200 GB | | ||
|
|
||
| {{% alert title="Note" color="primary" %}} | ||
|
|
||
| The *Recommended* sizes above are required to execute the [Free5GC](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md) and [OAI RAN](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md) use cases. | ||
|
|
||
| {{% /alert %}} | ||
|
|
||
| ### Kubernetes version support | ||
|
|
||
| | Min | Max | | ||
| |-------|---------| | ||
| | v1.26 | v1.32.0 | | ||
|
|
||
|
|
||
| These installations have been verified on virtual machines (VMs) running on Google Cloud. | ||
|
|
||
| ## Features | ||
|
|
||
| ### Packages | ||
|
|
||
| The following packages have been introduced: | ||
|
|
||
| * Baremetal cluster provisioning packages: | ||
| * [Metal3](https://github.com/nephio-project/catalog/tree/main/infra/capi/cluster-capi-infrastructure-metal3) | ||
| * [Metal3 Ironic](https://github.com/nephio-project/catalog/tree/main/infra/capi/cluster-capi-infrastructure-ironic) | ||
| * [Baremetal Operator](https://github.com/nephio-project/catalog/tree/main/infra/capi/cluster-capi-infrastructure-bmo) | ||
| * [Baremetal Host template](https://github.com/nephio-project/catalog/tree/main/infra/baremetal/bmh-template) | ||
| * [Kubeadm cluster template](https://github.com/nephio-project/catalog/tree/main/infra/baremetal/bmh-template) | ||
| * Centralized ArgoCD packages: | ||
| * [ArgoCD Full](https://github.com/nephio-project/catalog/tree/main/nephio/optional/argo-cd-full) | ||
| * [Nephio ArgoCD App](https://github.com/nephio-project/catalog/tree/main/nephio/optional/argo-cd-app) | ||
| * [Nephio ArgoCD workload cluster](https://github.com/nephio-project/catalog/tree/main/infra/capi/nephio-workload-cluster-argo) | ||
|
|
||
|
|
||
| ### Functionalities | ||
|
|
||
| * Platform | ||
| * [Porch](https://github.com/nephio-project/porch/releases/tag/v1.4.0) fixes, security patches, and enhancements. | ||
| See [Porch fixes and enhancements](#porch-fixes-and-enhancements) for more details. | ||
| * [Nephio](https://github.com/nephio-project/nephio/releases/tag/v5.0.0) fixes, security patches, and enhancements. | ||
|
|
||
| * Documentation | ||
| * Improvements in aesthetics and bug fixes. | ||
|
|
||
| * CI/CD Testing | ||
| * New e2e test suites added: | ||
| * [O-RAN OCloud workload cluster](https://prow.nephio.io/job-history/gs/prow-nephio-sig-release/logs/e2e-weekly-ubuntu-jammy-ocloud) | ||
| * [ArgoCD workload cluster](https://prow.nephio.io/job-history/gs/prow-nephio-sig-release/logs/e2e-daily-ubuntu-jammy-argocd) | ||
| * K8s v1.32.0 support | ||
| * Fedora 38 OS support | ||
|
|
||
| * Security | ||
| * [Nephio OSSF](https://securityscorecards.dev/viewer/?uri=github.com/nephio-project/nephio) score has been improved to 7.9 | ||
|
|
||
| ## Limitations | ||
|
|
||
| * Intercluster networking is not dynamic. Therefore, as more clusters are deployed, some manual tweaking will be needed | ||
| for intercluster communications. | ||
| * Provisioning of the VLAN interfaces on the nodes is currently performed manually. | ||
| * Observability between workload clusters to the management cluster is limited. | ||
| You may need to connect directly to the workload cluster via kubectl to resolve any deployment issues. | ||
| * The web UI features are limited to the viewing and editing of packages, 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 the cluster repositories, register them to the Nephio management server, and set up Config Sync on the workload cluster. | ||
| * The web UI does not require authentication in the current demo configuration. Testing of the web UI with authentication configured has not yet been done. | ||
| * The web UI only shows the 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 the 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 the following message: | ||
|
|
||
| `Error: Internal error occurred: error applying patch: conflict: fragment line | ||
| 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. | ||
|
|
||
| ## Appendix | ||
|
|
||
| ### Porch fixes and enhancements | ||
| - [Porch full changelog](https://github.com/nephio-project/porch/compare/v4.0.0...v1.4.0) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.