Skip to content
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

R2 release notes #84

Merged
merged 1 commit into from
Feb 1, 2024
Merged

R2 release notes #84

merged 1 commit into from
Feb 1, 2024

Conversation

gvbalaji
Copy link
Contributor

We need to augment the contents for install , limitations and troubleshooting sections


## Prerequisites

Please refer to the [Install Guide](https://github.com/nephio-project/docs/tree/main/content/en/docs/guides/install-guides)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that it's better to refer to the BYOC installation document

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

## Support Matrix

The sandbox environment requires a physical or virtual machine with:
- Ubuntu-20.04-focal Linux
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That restriction is for free5Gc workloads, OAI has been tested on Ubuntu Jammy

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @electrocucaracha . So users need different environments for Free5gc and OAI?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe they can use the same, but we have tested with different distros

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please mention the exact versions here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gvbalaji Where are we mentioning about Fedora? Because R1 was working in fedora right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added, thanks.

* Security
* Repo watcher changes
* Documentation
new web based documentation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
new web based documentation
* new web based documentation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Thanks.


## Prerequisites

Please refer to the [Install Guide](https://github.com/nephio-project/docs/tree/main/content/en/docs/guides/install-guides)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use ref style references instead of referring to the folders of files in GitHub directly.
I've updated this to use the ref style reference and to refer to the prerequisites of the BYOC install guide.

Suggested change
Please refer to the [Install Guide](https://github.com/nephio-project/docs/tree/main/content/en/docs/guides/install-guides)
Please refer to the [Install Guide]({{< ref "docs/guides/install-guides/install-on-byoc.md#prerequisites" >}}) for the
prerequisites on supported environments.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Thanks.

* GCP
* OpenShift
* OAI components
* Deploying many OAI 5G core and RAN components (CU and DU) NFs via Python-based operators
Copy link
Contributor

@arora-sagar arora-sagar Jan 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gvbalaji can you make these changes?

  • 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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Done.

@CsatariGergely
Copy link
Contributor

Broken links are fixed in #90


## Known Issues and Workarounds

* When deploying the sandbox environment on an Ubuntu VM running on OpenStack,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this (or find out what it is about). Ask Francesco?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lapentad I know that you were playing around OpenStack, have you ever faced this issue. The way that I fixed in test-infra was adding these lines, but I'm not sure if this is the same issue.


* When deploying the sandbox environment on an Ubuntu VM running on OpenStack,
the deployment may fail. Reinstalling the packages will get around this issue.
* Occasionally packages may take a long time to be approved by the auto-approval
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open an issue (epic?) for this.

kubectl -n porch-system rollout restart deploy porch-server
kubectl -n nephio-system rollout restart deploy nephio-controller
```
* Occasional calls to `kpt alpha rpkg copy` may fail with a message like
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open an issue. Change to porchctl instead of kpt alpha.


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

For non-sandbox installations, any conforming Kubernetes cluster is sufficient
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reword:

Note: A Nephio sandbox can be created on any Kubernetes cluster.

@gvbalaji gvbalaji changed the title Initial draft for R2 release notes R2 release notes Jan 31, 2024
@tliron
Copy link
Contributor

tliron commented Jan 31, 2024

/lgtm


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

A Nephio sandbox can be created on any Kubernetes cluster.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we should reduce the scope of this statement. Our End-to-End tests have been performed in v1.27.1.

Suggested change
A Nephio sandbox can be created on any Kubernetes cluster.
A Nephio sandbox can be created on any [Certified Kubernetes](https://www.cncf.io/training/certification/software-conformance/) v1.27+ cluster.

@electrocucaracha
Copy link
Member

/lgtm

@efiacor
Copy link
Contributor

efiacor commented Feb 1, 2024

/approve
/lgtm

Copy link
Contributor

nephio-prow bot commented Feb 1, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: efiacor

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@nephio-prow nephio-prow bot added the approved label Feb 1, 2024
@nephio-prow nephio-prow bot merged commit bc391b3 into nephio-project:main Feb 1, 2024
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants