From d38945b055a74c725fa06435cab28e7c81469f4e Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Tue, 3 Dec 2024 16:35:26 +0000 Subject: [PATCH 01/11] Move and rename Glossary and Abreviations --- content/en/docs/abbreviations.md | 24 ------------------- .../apis/topology-and-networking/_index.md | 2 +- ...{glossary.md => glossary-abbreviations.md} | 24 ++++++++++++++++--- .../install-guides/explore-nephio-free5gc.md | 6 ++--- resources.md | 3 +-- 5 files changed, 26 insertions(+), 33 deletions(-) delete mode 100644 content/en/docs/abbreviations.md rename content/en/docs/{glossary.md => glossary-abbreviations.md} (96%) diff --git a/content/en/docs/abbreviations.md b/content/en/docs/abbreviations.md deleted file mode 100644 index 7b252737..00000000 --- a/content/en/docs/abbreviations.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Abbreviations -description: -weight: 3 ---- - -This page gives brief explanations of abbreviations used in the Nephio project. See also the -[Nephio Glossary](/content/en/docs/glossary.md) for more detailed descriptions of Nephio related terms. - -## Nephio Related Abbreviations -* NF: Network Function -* PV: Package Variant -* PVS: Package Variant Set - -## 5G 3GPP Related Abbreviations -* AMF: Access and Mobility Management Function -* SMF: Session Management Function -* UPF: User Plane Function -* AUSF: Authentication Server Function -* NRF: Network Repository Function -* UDR: Unified Data Repository -* UDM: Unified Data Management -* DNN: Data Network Name -* NAD: Network Attachment Definition diff --git a/content/en/docs/apis/topology-and-networking/_index.md b/content/en/docs/apis/topology-and-networking/_index.md index ed33b635..c505374c 100644 --- a/content/en/docs/apis/topology-and-networking/_index.md +++ b/content/en/docs/apis/topology-and-networking/_index.md @@ -4,4 +4,4 @@ type: docs weight: 5 description: Reference for the Nephio Topology and Networking APIs --- -{{< iframe src="https://doc.crds.dev/github.com/nephio-project/api@v2.0.0" sub="https://doc.crds.dev/github.com/nephio-project/api@v2.0.0">}} \ No newline at end of file +{{< iframe src="https://doc.crds.dev/github.com/nephio-project/api@v3.0.0" sub="https://doc.crds.dev/github.com/nephio-project/api@v3.0.0">}} \ No newline at end of file diff --git a/content/en/docs/glossary.md b/content/en/docs/glossary-abbreviations.md similarity index 96% rename from content/en/docs/glossary.md rename to content/en/docs/glossary-abbreviations.md index 318f3dc4..a66d2015 100644 --- a/content/en/docs/glossary.md +++ b/content/en/docs/glossary-abbreviations.md @@ -1,14 +1,15 @@ --- -title: Glossary +title: Glossary & Abbreviations description: -weight: 4 +weight: 10 --- We use many terms in our Nephio discussions, coming from different domains including telecom, Kubernetes, configuration management, and our own -Nephio-specific terms. This glossary is intended to help clarify our usage of +[Nephio-specific](#nephio-related-abbreviations) terms. This glossary is intended to help clarify our usage of these terms. + ## Config See [Configuration](#configuration). @@ -369,3 +370,20 @@ configuration at scale. A workload is any application running on Kubernetes, including network functions. + + +## Nephio Related Abbreviations +* NF: Network Function +* PV: Package Variant +* PVS: Package Variant Set + +# 5G 3GPP Related Abbreviations +* AMF: Access and Mobility Management Function +* SMF: Session Management Function +* UPF: User Plane Function +* AUSF: Authentication Server Function +* NRF: Network Repository Function +* UDR: Unified Data Repository +* UDM: Unified Data Management +* DNN: Data Network Name +* NAD: Network Attachment Definition \ No newline at end of file diff --git a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md index bdc7be43..3ca19b14 100644 --- a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md +++ b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md @@ -5,9 +5,9 @@ description: > weight: 6 --- -Concepts as [Operator](/content/en/docs/glossary.md#operator) and -[Controller](/content/en/docs/glossary.md#controller) and -[CR](/content/en/docs/glossary.md#custom-resource) have already been explained here. +Concepts as [Operator](/content/en/docs/glossary-abbreviations#operator) and +[Controller](/content/en/docs/glossary-abbreviations#controller) and +[CR](/content/en/docs/glossary-abbreviations#custom-resource) have already been explained here. ## Deploy the operator to the cluster diff --git a/resources.md b/resources.md index a1ba9a8a..958afcd3 100644 --- a/resources.md +++ b/resources.md @@ -46,7 +46,6 @@ More tutorials are under discussion in * [SIG Release Meeting playlist](https://www.youtube.com/playlist?list=PLiW9_IXAWtks9Ys4Zs6wPRNEuQYAnWcg1) ## Other Resources -* The [Glossary](/content/en/docs/glossary.md) defines common terminology used in the Nephio +* The [Glossary & Abbreviations](/content/en/docs/glossary-abbreviations) defines common terminology used in the Nephio project. * The [Nephio Learning Resources page](learning.md) lists some learning resources that are useful for the Nephio community -* The [Abbreviation Decoder page](/content/en/docs/abbreviations.md) explains common abbreviations used in the project. From 7a851af5dbb33fa25547791639a578796ca20606 Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Tue, 3 Dec 2024 16:36:52 +0000 Subject: [PATCH 02/11] Update porch api models to latest --- content/en/docs/apis/porch/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/apis/porch/_index.md b/content/en/docs/apis/porch/_index.md index b56de354..a6e708e4 100644 --- a/content/en/docs/apis/porch/_index.md +++ b/content/en/docs/apis/porch/_index.md @@ -4,4 +4,4 @@ type: docs weight: 5 description: Reference for the Nephio Porch APIs --- -{{< iframe src="https://doc.crds.dev/github.com/nephio-project/porch@v2.0.0" sub="https://doc.crds.dev/github.com/nephio-project/porch@v2.0.0">}} +{{< iframe src="https://doc.crds.dev/github.com/nephio-project/porch@v3.0.4" sub="https://doc.crds.dev/github.com/nephio-project/porch@v3.0.4">}} From bc166dd4352f17afe4eee3955cd70a9cc5d5c4de Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Tue, 3 Dec 2024 16:41:01 +0000 Subject: [PATCH 03/11] Fix minor typos in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ef4ab89..0b24716e 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ the Markdown files hosted in the GitHub repo to generate the documentation websi ### Setting up the environment -1. The site is using Hugo as the documentation generating engine and as Hugo depends on Go in mudule handling you need to - have Go installed on your computer. Most Linux distributions have Go preinstalled, but some of them have a verstion that is too old +1. The site is using Hugo as the documentation generating engine and as Hugo depends on Go in module handling you need to + have Go installed on your computer. Most Linux distributions have Go preinstalled, but some of them have a version that is too old for Hugo. You should have at least version 1.18.0. You can install version 1.18 of go on an Ubuntu using the following commands: From 6e5d6307d0266e0eb1031928eb19f02a068dd720 Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Tue, 3 Dec 2024 17:14:59 +0000 Subject: [PATCH 04/11] Reorganise Web UI guide --- .../guides/install-guides/common-components.md | 2 +- .../guides/install-guides/install-on-byoc.md | 4 ++-- .../guides/install-guides/install-on-gcp.md | 6 +++--- .../{webui.md => web-ui/_index.md} | 17 +++++------------ .../{ => web-ui}/webui-auth-gcp.md | 0 .../{ => web-ui}/webui-auth-okta.md | 0 6 files changed, 11 insertions(+), 18 deletions(-) rename content/en/docs/guides/install-guides/{webui.md => web-ui/_index.md} (89%) rename content/en/docs/guides/install-guides/{ => web-ui}/webui-auth-gcp.md (100%) rename content/en/docs/guides/install-guides/{ => web-ui}/webui-auth-okta.md (100%) diff --git a/content/en/docs/guides/install-guides/common-components.md b/content/en/docs/guides/install-guides/common-components.md index 0cdc95cb..38fedd0b 100644 --- a/content/en/docs/guides/install-guides/common-components.md +++ b/content/en/docs/guides/install-guides/common-components.md @@ -118,4 +118,4 @@ kpt live apply stock-repos --reconcile-timeout=15m --output=table ## WebUI (Optional) Nephio WebUI is optional and to install it you can follow this -[document](/content/en/docs/guides/install-guides/webui.md) +[document](/content/en/docs/guides/install-guides/web-ui/_index.md) diff --git a/content/en/docs/guides/install-guides/install-on-byoc.md b/content/en/docs/guides/install-guides/install-on-byoc.md index 22f30100..642f8e0b 100644 --- a/content/en/docs/guides/install-guides/install-on-byoc.md +++ b/content/en/docs/guides/install-guides/install-on-byoc.md @@ -136,8 +136,8 @@ LoadBalancer service, Ingress, or Route). The WebUI currently supports the following options: -- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/webui-auth-gcp.md) -- [OIDC with Okta](/content/en/docs/guides/install-guides/webui-auth-okta.md) +- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md) +- [OIDC with Okta](/content/en/docs/guides/install-guides/web-ui/webui-auth-okta.md) ### Nephio Stock Repositories diff --git a/content/en/docs/guides/install-guides/install-on-gcp.md b/content/en/docs/guides/install-guides/install-on-gcp.md index c37155de..d9cb88bd 100644 --- a/content/en/docs/guides/install-guides/install-on-gcp.md +++ b/content/en/docs/guides/install-guides/install-on-gcp.md @@ -1022,9 +1022,9 @@ git commit -m "Initial checking of nephio-mgmt" **Prior to deploying the package, we need to manually setup the secret for the WebUI.** -See [Google OAuth 2.0 or OIDC](/content/en/docs/guides/install-guides/webui-auth-gcp.md) for details on how to -set up OAuth. In particular you need to [create the client ID](/content/en/docs/guides/install-guides/webui-auth-gcp.md#creating-an-oauth-20-client-id) -and the [secret](/content/en/docs/guides/install-guides/webui-auth-gcp.md#create-the-secret-in-the-cluster) +See [Google OAuth 2.0 or OIDC](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md) for details on how to +set up OAuth. In particular you need to [create the client ID](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md#creating-an-oauth-20-client-id) +and the [secret](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md#create-the-secret-in-the-cluster) manually. The *nephio-webui* subpackage in *nephio-mgmt* is already set up for diff --git a/content/en/docs/guides/install-guides/webui.md b/content/en/docs/guides/install-guides/web-ui/_index.md similarity index 89% rename from content/en/docs/guides/install-guides/webui.md rename to content/en/docs/guides/install-guides/web-ui/_index.md index 82f96dea..3c61ca1b 100644 --- a/content/en/docs/guides/install-guides/webui.md +++ b/content/en/docs/guides/install-guides/web-ui/_index.md @@ -1,17 +1,10 @@ --- -title: Install WebUI +title: Installing the WebUI description: > - These instructions explain how to install the Nephio WebUI. -weight: 6 + These instructions explain how to install and configure the Nephio WebUI. +weight: 2 --- -{{% pageinfo %}} -This page is draft and the separation of the content to different categories is not clear. -{{% /pageinfo %}} - - -## Nephio WebUI - To install the WebUI, we simply install a different *kpt* package. First, we pull the package locally: ```bash @@ -54,8 +47,8 @@ service). Configuring authentication for the WebUI is specific to the particular cluster environment. Guides for different environments are below: -- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/webui-auth-gcp.md) -- [OIDC with Okta](/content/en/docs/guides/install-guides/webui-auth-okta.md) +- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md) +- [OIDC with Okta](/content/en/docs/guides/install-guides/web-ui/webui-auth-okta.md) Once that configuration is updated, you can proceed with the installation (note, this uses `inventory-policy=adopt`, since in the previous steps we may have created the namespace already). diff --git a/content/en/docs/guides/install-guides/webui-auth-gcp.md b/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md similarity index 100% rename from content/en/docs/guides/install-guides/webui-auth-gcp.md rename to content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md diff --git a/content/en/docs/guides/install-guides/webui-auth-okta.md b/content/en/docs/guides/install-guides/web-ui/webui-auth-okta.md similarity index 100% rename from content/en/docs/guides/install-guides/webui-auth-okta.md rename to content/en/docs/guides/install-guides/web-ui/webui-auth-okta.md From f9390d82e479aa82edc5bf8dc660e06bda9cba70 Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Tue, 3 Dec 2024 17:19:25 +0000 Subject: [PATCH 05/11] Fix sub heading weight --- content/en/docs/glossary-abbreviations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/glossary-abbreviations.md b/content/en/docs/glossary-abbreviations.md index a66d2015..e352043e 100644 --- a/content/en/docs/glossary-abbreviations.md +++ b/content/en/docs/glossary-abbreviations.md @@ -377,7 +377,7 @@ functions. * PV: Package Variant * PVS: Package Variant Set -# 5G 3GPP Related Abbreviations +## 5G 3GPP Related Abbreviations * AMF: Access and Mobility Management Function * SMF: Session Management Function * UPF: User Plane Function From 475bd0a6dc844a795600199d5ffce1a4fc276c6a Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Tue, 3 Dec 2024 17:38:00 +0000 Subject: [PATCH 06/11] Fix broken links --- content/en/docs/glossary-abbreviations.md | 2 +- .../en/docs/guides/install-guides/explore-nephio-free5gc.md | 6 +++--- resources.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/glossary-abbreviations.md b/content/en/docs/glossary-abbreviations.md index e352043e..cc4be212 100644 --- a/content/en/docs/glossary-abbreviations.md +++ b/content/en/docs/glossary-abbreviations.md @@ -1,5 +1,5 @@ --- -title: Glossary & Abbreviations +title: Glossary and Abbreviations description: weight: 10 --- diff --git a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md index 3ca19b14..98724793 100644 --- a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md +++ b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md @@ -5,9 +5,9 @@ description: > weight: 6 --- -Concepts as [Operator](/content/en/docs/glossary-abbreviations#operator) and -[Controller](/content/en/docs/glossary-abbreviations#controller) and -[CR](/content/en/docs/glossary-abbreviations#custom-resource) have already been explained here. +Concepts as [Operator](../../glossary-abbreviations#operator) and +[Controller](../../glossary-abbreviations#controller) and +[CR](../../glossary-and-abbreviations#custom-resource) have already been explained here. ## Deploy the operator to the cluster diff --git a/resources.md b/resources.md index 958afcd3..bd5b2372 100644 --- a/resources.md +++ b/resources.md @@ -46,6 +46,6 @@ More tutorials are under discussion in * [SIG Release Meeting playlist](https://www.youtube.com/playlist?list=PLiW9_IXAWtks9Ys4Zs6wPRNEuQYAnWcg1) ## Other Resources -* The [Glossary & Abbreviations](/content/en/docs/glossary-abbreviations) defines common terminology used in the Nephio +* The [Glossary & Abbreviations](content/en/docs/glossary-abbreviations) defines common terminology used in the Nephio project. * The [Nephio Learning Resources page](learning.md) lists some learning resources that are useful for the Nephio community From 8db0e8abf3e4b2662da53bd964bc641827c703c4 Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Tue, 3 Dec 2024 17:43:05 +0000 Subject: [PATCH 07/11] Fix another broken link --- content/en/docs/guides/install-guides/explore-nephio-free5gc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md index 98724793..2c2b6608 100644 --- a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md +++ b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md @@ -7,7 +7,7 @@ weight: 6 Concepts as [Operator](../../glossary-abbreviations#operator) and [Controller](../../glossary-abbreviations#controller) and -[CR](../../glossary-and-abbreviations#custom-resource) have already been explained here. +[CR](../../glossary-abbreviations#custom-resource) have already been explained here. ## Deploy the operator to the cluster From d5933a00cdfbed26f61db9fc7baa9072c37ab34e Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Wed, 4 Dec 2024 09:00:42 +0000 Subject: [PATCH 08/11] Update content/en/docs/guides/install-guides/explore-nephio-free5gc.md Co-authored-by: Gergely Csatari --- .../en/docs/guides/install-guides/explore-nephio-free5gc.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md index 2c2b6608..f031aef3 100644 --- a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md +++ b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md @@ -7,7 +7,8 @@ weight: 6 Concepts as [Operator](../../glossary-abbreviations#operator) and [Controller](../../glossary-abbreviations#controller) and -[CR](../../glossary-abbreviations#custom-resource) have already been explained here. +[CR](../../glossary-abbreviations.md#custom-resource) have already been explained here. + ## Deploy the operator to the cluster From 48f576755bfe0eb0beea050ff9186b0feb4cd72b Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Wed, 4 Dec 2024 09:00:57 +0000 Subject: [PATCH 09/11] Update resources.md Co-authored-by: Gergely Csatari --- resources.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources.md b/resources.md index bd5b2372..da5c286d 100644 --- a/resources.md +++ b/resources.md @@ -46,6 +46,6 @@ More tutorials are under discussion in * [SIG Release Meeting playlist](https://www.youtube.com/playlist?list=PLiW9_IXAWtks9Ys4Zs6wPRNEuQYAnWcg1) ## Other Resources -* The [Glossary & Abbreviations](content/en/docs/glossary-abbreviations) defines common terminology used in the Nephio +* The [Glossary & Abbreviations](content/en/docs/glossary-abbreviations.md) defines common terminology used in the Nephio project. * The [Nephio Learning Resources page](learning.md) lists some learning resources that are useful for the Nephio community From 2c3e75c3364d1fd65f70abc925ad9ae5a8e17a10 Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Wed, 4 Dec 2024 09:07:48 +0000 Subject: [PATCH 10/11] Apply suggestions from code review Co-authored-by: Gergely Csatari --- .../en/docs/guides/install-guides/explore-nephio-free5gc.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md index f031aef3..ad95da9e 100644 --- a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md +++ b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md @@ -5,8 +5,10 @@ description: > weight: 6 --- -Concepts as [Operator](../../glossary-abbreviations#operator) and -[Controller](../../glossary-abbreviations#controller) and +Concepts as [Operator](../../glossary-abbreviations.md#operator) and + +[Controller](../../glossary-abbreviations.md#controller) and + [CR](../../glossary-abbreviations.md#custom-resource) have already been explained here. From 9c46ffb21fdff66f0ee63e02fbd5ad3813ca1a1d Mon Sep 17 00:00:00 2001 From: Fiachra Corcoran Date: Wed, 4 Dec 2024 09:12:06 +0000 Subject: [PATCH 11/11] Update glossary-abbreviations.md --- content/en/docs/glossary-abbreviations.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/content/en/docs/glossary-abbreviations.md b/content/en/docs/glossary-abbreviations.md index cc4be212..2ea2475d 100644 --- a/content/en/docs/glossary-abbreviations.md +++ b/content/en/docs/glossary-abbreviations.md @@ -371,13 +371,14 @@ configuration at scale. A workload is any application running on Kubernetes, including network functions. - ## Nephio Related Abbreviations -* NF: Network Function + * PV: Package Variant * PVS: Package Variant Set ## 5G 3GPP Related Abbreviations + +* NF: Network Function * AMF: Access and Mobility Management Function * SMF: Session Management Function * UPF: User Plane Function @@ -386,4 +387,7 @@ functions. * UDR: Unified Data Repository * UDM: Unified Data Management * DNN: Data Network Name -* NAD: Network Attachment Definition \ No newline at end of file + +## Kubernetes Networking + +* NAD: Network Attachment Definition