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.

Sign up for GitHub

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

Jump to bottom

Common dependencies #88

Merged
merged 8 commits into from
Jan 31, 2024
Merged

Common dependencies #88

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
84349df
merge
liamfallon Jan 23, 2024
d99c101
Update common-dependencies doc page
liamfallon Jan 24, 2024
34112a6
Updated URLs in common-components
liamfallon Jan 24, 2024
e883439
Update content/en/docs/guides/install-guides/common-components.md
liamfallon Jan 31, 2024
aeca37c
Update content/en/docs/guides/install-guides/common-components.md
liamfallon Jan 31, 2024
81ea864
Update content/en/docs/guides/install-guides/common-components.md
liamfallon Jan 31, 2024
3bfa021
Update content/en/docs/guides/install-guides/common-dependencies.md
liamfallon Jan 31, 2024
4e7f3ba
Update content/en/docs/guides/install-guides/common-dependencies.md
liamfallon Jan 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions content/en/docs/guides/install-guides/common-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/[email protected]
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
efiacor marked this conversation as resolved.
Show resolved Hide resolved
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-[email protected]
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
liamfallon marked this conversation as resolved.
Show resolved Hide resolved
kpt fn render nephio-operator
kpt live init nephio-operator
kpt live apply nephio-operator --reconcile-timeout=15m --output=table
```

### Management Cluster GitOps Tool
Expand All @@ -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
liamfallon marked this conversation as resolved.
Show resolved Hide resolved
kpt fn render configsync
kpt live init configsync
kpt live apply configsync --reconcile-timeout=15m --output=table
Expand All @@ -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
liamfallon marked this conversation as resolved.
Show resolved Hide resolved
kpt fn render stock-repos
kpt live init stock-repos
kpt live apply stock-repos --reconcile-timeout=15m --output=table
```
6 changes: 4 additions & 2 deletions content/en/docs/guides/install-guides/common-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ 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.

```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
liamfallon marked this conversation as resolved.
Show resolved Hide resolved
kpt fn render network-config
kpt live init network-config
kpt live apply network-config --reconcile-timeout=15m --output=table
Expand All @@ -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
liamfallon marked this conversation as resolved.
Show resolved Hide resolved
kpt fn render resource-backend
kpt live init resource-backend
kpt live apply resource-backend --reconcile-timeout=15m --output=table
Expand Down