From 84349df8846cc2f8950eaf8ba808fa32318ff5fa Mon Sep 17 00:00:00 2001 From: liamfallon Date: Tue, 23 Jan 2024 13:49:25 +0000 Subject: [PATCH 1/8] merge --- developer-guide/README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 developer-guide/README.md diff --git a/developer-guide/README.md b/developer-guide/README.md new file mode 100644 index 00000000..e776fe0a --- /dev/null +++ b/developer-guide/README.md @@ -0,0 +1,7 @@ +Nephio Developer Guide +====================== + +This developer guide is for for people who want to write code for the Nephio project. This document is written as an extension of the [Kubernetes Developer Guides](https://github.com/kubernetes/community/tree/master/contributors/devel#the-process-of-developing-and-contributing-code-to-the-kubernetes-project) and therefore covers topics that are specific to Nephio development. + +* How to set up a [Minimal Development Environment](minimal-environment.md) defines common terminology used in the Nephio project. +* How to perform [Unit testing using mocking with Mockery](unit-testing-mockery.md). From d99c10186093092aff8bed7f8d6b29144e2ef73c Mon Sep 17 00:00:00 2001 From: liamfallon Date: Wed, 24 Jan 2024 12:25:22 +0000 Subject: [PATCH 2/8] Update common-dependencies doc page --- .../en/docs/guides/install-guides/common-dependencies.md | 6 ++++-- developer-guide/README.md | 7 ------- 2 files changed, 4 insertions(+), 9 deletions(-) delete mode 100644 developer-guide/README.md diff --git a/content/en/docs/guides/install-guides/common-dependencies.md b/content/en/docs/guides/install-guides/common-dependencies.md index 972419de..17d21d48 100644 --- a/content/en/docs/guides/install-guides/common-dependencies.md +++ b/content/en/docs/guides/install-guides/common-dependencies.md @@ -15,8 +15,10 @@ installation, the CRDs that come along with them are necessary. This component is a controller for applying configuration to routers and switches. +> **_NOTE:_** If you want to use a version other than that at the tip of Nephio `catalog` repo, then replace the `@main` suffix on the package URLs on the `kpt pkg get` commands below with the tag of the version you wish to use. + ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages.git/network-config@v1.0.1 +kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/optional/network-config@main kpt fn render network-config kpt live init network-config kpt live apply network-config --reconcile-timeout=15m --output=table @@ -27,7 +29,7 @@ kpt live apply network-config --reconcile-timeout=15m --output=table The resource backend provides IP and VLAN allocation. ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages.git/resource-backend@v1.0.1 +kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/optional/resource-backend@main kpt fn render resource-backend kpt live init resource-backend kpt live apply resource-backend --reconcile-timeout=15m --output=table diff --git a/developer-guide/README.md b/developer-guide/README.md deleted file mode 100644 index e776fe0a..00000000 --- a/developer-guide/README.md +++ /dev/null @@ -1,7 +0,0 @@ -Nephio Developer Guide -====================== - -This developer guide is for for people who want to write code for the Nephio project. This document is written as an extension of the [Kubernetes Developer Guides](https://github.com/kubernetes/community/tree/master/contributors/devel#the-process-of-developing-and-contributing-code-to-the-kubernetes-project) and therefore covers topics that are specific to Nephio development. - -* How to set up a [Minimal Development Environment](minimal-environment.md) defines common terminology used in the Nephio project. -* How to perform [Unit testing using mocking with Mockery](unit-testing-mockery.md). From 34112a6729b27128e33d1eee15650f8587bf683e Mon Sep 17 00:00:00 2001 From: liamfallon Date: Wed, 24 Jan 2024 12:44:47 +0000 Subject: [PATCH 3/8] Updated URLs in common-components --- .../install-guides/common-components.md | 37 ++++++++++--------- .../install-guides/common-dependencies.md | 4 +- 2 files changed, 22 insertions(+), 19 deletions(-) diff --git a/content/en/docs/guides/install-guides/common-components.md b/content/en/docs/guides/install-guides/common-components.md index 4b01de0b..6fe76ec3 100644 --- a/content/en/docs/guides/install-guides/common-components.md +++ b/content/en/docs/guides/install-guides/common-components.md @@ -11,6 +11,9 @@ weight: 2 This page is draft and the separation of the content to different categories is not clearly done. {{% /pageinfo %}} +> **_NOTE:_** If you want to use a version other than that at the tip of Nephio `catalog` repo, then replace the `@main` suffix on the package URLs on the `kpt pkg get` commands below with the tag of the version you wish to use. + + ### Porch This "Package Orchestration" component provides the Kubernetes APIs for @@ -23,27 +26,27 @@ Fetch the package using `kpt`, and run any `kpt` functions, and then apply the package: ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages.git/porch-dev@v1.0.1 -kpt fn render porch-dev -kpt live init porch-dev -kpt live apply porch-dev --reconcile-timeout=15m --output=table +kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/core/proch@main +kpt fn render porch +kpt live init porch +kpt live apply porch --reconcile-timeout=15m --output=table ``` -### Nephio Controllers +### Nephio Operators -The Nephio Controllers provide implementations of the Nephio-specific APIs. This +The Nephio Operators provide implementations of the Nephio-specific APIs. This includes the code that implements the various package specialization features - such as integration with IPAM and VLAN allocation, and NAD generation - as well -as controllers that can provision repositories and bootstrap new clusters into +as operators that can provision repositories and bootstrap new clusters into Nephio. -To install the Nephio Controllers, repeat the `kpt` steps, but for that package: +To install the Nephio Operators, repeat the `kpt` steps, but for that package: ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages.git/nephio-controllers@v1.0.1 -kpt fn render nephio-controllers -kpt live init nephio-controllers -kpt live apply nephio-controllers --reconcile-timeout=15m --output=table +kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/core/nephio-operator@main +kpt fn render nephio-operator +kpt live init nephio-operator +kpt live apply nephio-operator --reconcile-timeout=15m --output=table ``` ### Management Cluster GitOps Tool @@ -58,7 +61,7 @@ To install it on the management cluster, we again follow the same process. Later, we will configure it to point to the `mgmt` repository: ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages.git/configsync@v1.0.1 +kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/core/configsync@main kpt fn render configsync kpt live init configsync kpt live apply configsync --reconcile-timeout=15m --output=table @@ -71,8 +74,8 @@ be installed via a package for convenience. This will install Repository resources pointing directly to the GitHub repositories, with read-only access. ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages.git/nephio-stock-repos@v1.0.1 -kpt fn render nephio-stock-repos -kpt live init nephio-stock-repos -kpt live apply nephio-stock-repos --reconcile-timeout=15m --output=table +kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/optional/stock-repos@main +kpt fn render stock-repos +kpt live init stock-repos +kpt live apply stock-repos --reconcile-timeout=15m --output=table ``` diff --git a/content/en/docs/guides/install-guides/common-dependencies.md b/content/en/docs/guides/install-guides/common-dependencies.md index 17d21d48..1d33813a 100644 --- a/content/en/docs/guides/install-guides/common-dependencies.md +++ b/content/en/docs/guides/install-guides/common-dependencies.md @@ -10,13 +10,13 @@ Some of these, like the resource-backend, will move out of the "required" category in later releases. Even if you do not use these directly in your installation, the CRDs that come along with them are necessary. +> **_NOTE:_** If you want to use a version other than that at the tip of Nephio `catalog` repo, then replace the `@main` suffix on the package URLs on the `kpt pkg get` commands below with the tag of the version you wish to use. + ### Network Config Operator This component is a controller for applying configuration to routers and switches. -> **_NOTE:_** If you want to use a version other than that at the tip of Nephio `catalog` repo, then replace the `@main` suffix on the package URLs on the `kpt pkg get` commands below with the tag of the version you wish to use. - ```bash kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/optional/network-config@main kpt fn render network-config From e883439327efb8a36965132c914626f846a66d49 Mon Sep 17 00:00:00 2001 From: Liam Fallon <35595825+liamfallon@users.noreply.github.com> Date: Wed, 31 Jan 2024 16:50:11 +0000 Subject: [PATCH 4/8] Update content/en/docs/guides/install-guides/common-components.md Co-authored-by: Victor Morales --- content/en/docs/guides/install-guides/common-components.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/install-guides/common-components.md b/content/en/docs/guides/install-guides/common-components.md index 6fe76ec3..52dbe541 100644 --- a/content/en/docs/guides/install-guides/common-components.md +++ b/content/en/docs/guides/install-guides/common-components.md @@ -43,7 +43,7 @@ Nephio. To install the Nephio Operators, repeat the `kpt` steps, but for that package: ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/core/nephio-operator@main +kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/nephio/core/nephio-operator@main kpt fn render nephio-operator kpt live init nephio-operator kpt live apply nephio-operator --reconcile-timeout=15m --output=table From aeca37cdf503c20d32a4c9c00183424c2b356c9a Mon Sep 17 00:00:00 2001 From: Liam Fallon <35595825+liamfallon@users.noreply.github.com> Date: Wed, 31 Jan 2024 16:50:21 +0000 Subject: [PATCH 5/8] Update content/en/docs/guides/install-guides/common-components.md Co-authored-by: Victor Morales --- content/en/docs/guides/install-guides/common-components.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/install-guides/common-components.md b/content/en/docs/guides/install-guides/common-components.md index 52dbe541..5f80dc20 100644 --- a/content/en/docs/guides/install-guides/common-components.md +++ b/content/en/docs/guides/install-guides/common-components.md @@ -61,7 +61,7 @@ To install it on the management cluster, we again follow the same process. Later, we will configure it to point to the `mgmt` repository: ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/core/configsync@main +kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/nephio/core/configsync@main kpt fn render configsync kpt live init configsync kpt live apply configsync --reconcile-timeout=15m --output=table From 81ea86495cc8054a916aec76d4ee0c3424216ac7 Mon Sep 17 00:00:00 2001 From: Liam Fallon <35595825+liamfallon@users.noreply.github.com> Date: Wed, 31 Jan 2024 16:50:29 +0000 Subject: [PATCH 6/8] Update content/en/docs/guides/install-guides/common-components.md Co-authored-by: Victor Morales --- content/en/docs/guides/install-guides/common-components.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/install-guides/common-components.md b/content/en/docs/guides/install-guides/common-components.md index 5f80dc20..001aa686 100644 --- a/content/en/docs/guides/install-guides/common-components.md +++ b/content/en/docs/guides/install-guides/common-components.md @@ -74,7 +74,7 @@ be installed via a package for convenience. This will install Repository resources pointing directly to the GitHub repositories, with read-only access. ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/optional/stock-repos@main +kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/nephio/optional/stock-repos@main kpt fn render stock-repos kpt live init stock-repos kpt live apply stock-repos --reconcile-timeout=15m --output=table From 3bfa0210b19804888397b5e9a881b67cb3ea75c4 Mon Sep 17 00:00:00 2001 From: Liam Fallon <35595825+liamfallon@users.noreply.github.com> Date: Wed, 31 Jan 2024 16:50:38 +0000 Subject: [PATCH 7/8] Update content/en/docs/guides/install-guides/common-dependencies.md Co-authored-by: Victor Morales --- content/en/docs/guides/install-guides/common-dependencies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/install-guides/common-dependencies.md b/content/en/docs/guides/install-guides/common-dependencies.md index 1d33813a..d4498610 100644 --- a/content/en/docs/guides/install-guides/common-dependencies.md +++ b/content/en/docs/guides/install-guides/common-dependencies.md @@ -18,7 +18,7 @@ This component is a controller for applying configuration to routers and switches. ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/optional/network-config@main +kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/nephio/optional/network-config@main kpt fn render network-config kpt live init network-config kpt live apply network-config --reconcile-timeout=15m --output=table From 4e7f3bada57524b7a891d67eca5c929dacc12cce Mon Sep 17 00:00:00 2001 From: Liam Fallon <35595825+liamfallon@users.noreply.github.com> Date: Wed, 31 Jan 2024 16:50:47 +0000 Subject: [PATCH 8/8] Update content/en/docs/guides/install-guides/common-dependencies.md Co-authored-by: Victor Morales --- content/en/docs/guides/install-guides/common-dependencies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/install-guides/common-dependencies.md b/content/en/docs/guides/install-guides/common-dependencies.md index d4498610..d3439410 100644 --- a/content/en/docs/guides/install-guides/common-dependencies.md +++ b/content/en/docs/guides/install-guides/common-dependencies.md @@ -29,7 +29,7 @@ kpt live apply network-config --reconcile-timeout=15m --output=table The resource backend provides IP and VLAN allocation. ```bash -kpt pkg get --for-deployment https://github.com/nephio-project/catalog/nephio/optional/resource-backend@main +kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/nephio/optional/resource-backend@main kpt fn render resource-backend kpt live init resource-backend kpt live apply resource-backend --reconcile-timeout=15m --output=table