From 7b61205cc44a5bba71b51529110783c8df92fa87 Mon Sep 17 00:00:00 2001 From: Michael Greaves Date: Thu, 15 Aug 2024 10:39:29 +0200 Subject: [PATCH] language corrections for r1 release notes. --- content/en/docs/release-notes/R1.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/content/en/docs/release-notes/R1.md b/content/en/docs/release-notes/R1.md index c3cbbc65..d98e9bbe 100644 --- a/content/en/docs/release-notes/R1.md +++ b/content/en/docs/release-notes/R1.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Refer to the [Install Guide](/content/en/docs/guides/install-guides/_index.md) +See the [Install Guide](/content/en/docs/guides/install-guides/_index.md) for the prerequisites for the supported environments. ## Support matrix @@ -30,7 +30,7 @@ for the management cluster. ### API -CRDs are provided for UPF, SMF, and AMF 5G Core services. +CRDs are provided for the UPF, SMF, and AMF 5G Core services. ### Web UI @@ -43,7 +43,7 @@ The following packages are supported: * Kpt packages for all [free5GC](https://free5gc.org/) services. * Packages for the core Nephio services. -* Packages for the Cluster API services for cluster creation. +* Packages for the Cluster API services, for cluster creation. * Packages for the dependent services. ### Functionalities @@ -51,8 +51,8 @@ The following packages are supported: The following functionalities are supported: * Create Kubernetes clusters. This functionality is based on the Cluster API. - At this time, only Kubernetes in Docker (KIND) cluster creation is supported. -* Fully automated deployment of UPF, SMF, and AMF services of + Currently, only Kubernetes in Docker (KIND) cluster creation is supported. +* Fully automated deployment of the UPF, SMF, and AMF services of [free5GC](https://free5gc.org/). These are deployed on multiple clusters based on the user's intent, expressed via the CRDs. * Deployment of other free5GC functions. @@ -65,10 +65,10 @@ 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. +* Intercluster networking is not dynamic. Therefore, as more clusters are + deployed, some manual tweaking will be needed for intercluster communications. * Provisioning of VLAN interfaces on nodes is currently performed manually. -* Feedback of workload deployments from workload clusters to the Management +* 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 and editing of packages, as well as @@ -76,7 +76,7 @@ The following limitations need to be borne in mind: 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 + 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 @@ -93,8 +93,8 @@ The following limitations need to be borne in mind: * When deploying the sandbox environment on an Ubuntu VM running on OpenStack, the deployment may fail. Reinstalling the packages will get around this issue. * 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: + 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