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

Add usecase guide for Centralized FluxCD deployment #203

Merged
merged 4 commits into from
Feb 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .linkspector.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ ignorePatterns:
- pattern: "https://\\*kpt\\*\\.dev/"
- pattern: "https://my-gitlab\\.com/joe\\.bloggs/blueprints\\.git"
- pattern: "http://172\\.18\\.0\\.200:3000/nephio/"
- pattern: "https://www\\.gnu\\.org/"
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the problem with gnu.org?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Started timing out recently for some reason. Link is fine but linkinspector was failing with false negative.
https://github.com/nephio-project/docs/actions/workflows/check-links-md.yml

replacementPatterns:
- pattern: ".md#.*$"
replacement: ".md"
4 changes: 2 additions & 2 deletions content/en/docs/guides/install-guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,8 @@ ssh <user>@<vm-address>
## Next steps

* Go through the following exercises:
* [Free5GC Testbed Deployment and E2E testing with UERANSIM](/content/en/docs/guides/user-guides/exercise-1-free5gc.md)
* [OAI Core and RAN Testbed Deployment and E2E testing](/content/en/docs/guides/user-guides/exercise-2-oai.md)
* [Free5GC Testbed Deployment and E2E testing with UERANSIM](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md)
* [OAI Core and RAN Testbed Deployment and E2E testing](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md)
* Dig in to the [user guide](/content/en/docs/guides/user-guides/_index.md).
* Nephio sandbox environment:
* Install on preprovisioned single VM.
Expand Down
5 changes: 0 additions & 5 deletions content/en/docs/guides/install-guides/common-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,3 @@ kpt fn render stock-repos
kpt live init stock-repos
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/web-ui/_index.md)
3 changes: 2 additions & 1 deletion content/en/docs/guides/install-guides/install-on-byoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@ environment, so that installation will be documented in the specific environment
### GitOps Tool

As configured in the R1, R2 and R3 reference implementation, Nephio relies on ConfigSync. However, it is possible to
configure it to use a different GitOps tool, such as Flux or ArgoCD to apply packages to the clusters.
configure it to use a different GitOps tool, such as [FluxCD](/content/en/docs/guides/install-guides/optional-components.md#fluxcd-controllers)
or ArgoCD to apply packages to the clusters.

### Cluster Provisioner

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/guides/install-guides/install-on-gce.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ gcloud compute ssh ubuntu@nephio-r3-e2e
## Next Steps

* Step through the exercises
* [Free5GC Testbed Deployment and E2E testing with UERANSIM](/content/en/docs/guides/user-guides/exercise-1-free5gc.md)
* [OAI Core and RAN Testbed Deployment and E2E testing](/content/en/docs/guides/user-guides/exercise-2-oai.md)
* [Free5GC Testbed Deployment and E2E testing with UERANSIM](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md)
* [OAI Core and RAN Testbed Deployment and E2E testing](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md)
* Dig into the [user guide](/content/en/docs/guides/user-guides/_index.md)
* In case you want to install Nephio on pre-provisioned VMs:
* [Single VM](/content/en/docs/guides/install-guides/install-on-single-vm.md)
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/guides/install-guides/install-on-gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -1389,6 +1389,6 @@ use workloads that do not rely on that functionality in order to experiment with

{{% /alert %}}

* Step through the [Free5GC](/content/en/docs/guides/user-guides/exercise-1-free5gc.md) and
[OAI](/content/en/docs/guides/user-guides/exercise-2-oai.md) exercises
* Step through the [Free5GC](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md) and
[OAI](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md) exercises
* Dig into the [user guide](/content/en/docs/guides/user-guides/_index.md)
61 changes: 61 additions & 0 deletions content/en/docs/guides/install-guides/optional-components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Installing optional Nephio components
description: >
After installing the environment-specific dependencies, and base components, the following optional Nephio
components can be installed.

weight: 2
---

{{% alert title="Note" color="primary" %}}

If you want to use a version other than that of v3.0.0 of Nephio *catalog* repo, then replace the *@origin/v3.0.0*
suffix on the package URLs on the `kpt pkg get` commands below with the tag/branch of the version you wish to use.

While using KPT you can [either pull a branch or a tag](https://kpt.dev/book/03-packages/01-getting-a-package) from a
git repository. By default, it pulls the tag. In case, you have branch with the same name as a tag then to:

```bash
#pull a branch
kpt pkg get --for-deployment <git-repository>@origin/v3.0.0
#pull a tag
kpt pkg get --for-deployment <git-repository>@v3.0.0
```

{{% /alert %}}

## Nephio WebUI

The Nephio WebUI can be installed using the following
[document](/content/en/docs/guides/install-guides/web-ui/_index.md)


## FluxCD Controllers

As an alternative Git-ops tool running on the Nephio mgmt cluster,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
As an alternative Git-ops tool running on the Nephio mgmt cluster,
As an alternative Git-ops tool running on the Nephio management cluster,

the following [Flux](https://fluxcd.io/flux/) controllers can be installed.
* [Source Controller](https://fluxcd.io/flux/components/source/)
* [Kustomize Controller](https://fluxcd.io/flux/components/kustomize/)
* [Helm Controller](https://fluxcd.io/flux/components/helm/)
* [Notification Controller](https://fluxcd.io/flux/components/notification/)

```bash
kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/nephio/optional/fluxcd@origin/main
kpt fn render fluxcd
kpt live init fluxcd
kpt live apply fluxcd --reconcile-timeout=15m --output=table
```

The controllers are deployed to the `flux-system` namespace by default.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The controllers are deployed to the `flux-system` namespace by default.
The controllers are deployed to the *flux-system* namespace by default.


```bash
kubectl get po -n flux-system
```
Output:
```
NAME READY STATUS RESTARTS AGE
helm-controller-69c875c978-85tpx 1/1 Running 0 103s
kustomize-controller-596578b94c-gt999 1/1 Running 0 103s
notification-controller-684c9f69c-hpkkq 1/1 Running 0 103s
source-controller-849cd7dbc6-58ghr 1/1 Running 0 103s
```
2 changes: 1 addition & 1 deletion content/en/docs/guides/user-guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,6 @@ Release Notes [known issues](/content/en/docs/release-notes/R2.md#known-issues-a

## Next Steps

* Learn more about the Nephio [controllers](/content/en/docs/guides/user-guides/controllers.md)
* Learn more about the Nephio [controllers](/content/en/docs/guides/user-guides/operator-controller-guides/controllers.md)
* Learn more about how packages are [transformed](/content/en/docs/guides/install-guides/package-transformations.md)
* Learn more about [deploying helm charts](/content/en/docs/guides/user-guides/helm/_index.md) in Nephio
2 changes: 0 additions & 2 deletions content/en/docs/guides/user-guides/helm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ weight: 3

## Overview

Helm integration support in Nephio is currently under investigation and will progress over the coming releases.

Although the direction from Nephio is to encourage the use of
[operators](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
for deploying on Kubernetes, legacy helm support will be required for a number of releases.
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/guides/user-guides/helm/flux-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Then, we can utilize the flux Custom Resources defined in another test kpt packa

* [Nephio R1 sandbox]/content/en/docs/guides/install-guides/install-guides/_index.md): Set up the Nephio sandbox environment.
* [Access to the Nephio Web UI](/content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces)
* [Nephio R1 sandbox workload clusters](/content/en/docs/guides/user-guides/exercise-1-free5gc.md):
* [Nephio R1 sandbox workload clusters](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md):
Create/Deploy the predefined set of workload clusters by completing the Free5GC Core quick start exercises up to and including
[Step 3](/content/en/docs/guides/user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters).
[Step 3](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters).

### Deploying the flux-helm-controllers pkg

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Nephio Operator & Controller Guides
description: >
A collection of guides relating to the controllers and/or operators developed by Nephio.
weight: 2
---


Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Nephio controller user's guide
description: >

weight: 1
weight: 2
---

## Reconcilers
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Use Case Guides
description: >
A collection of step by step use case guides for demo purposes.
weight: 3
---


Loading
Loading