-
Notifications
You must be signed in to change notification settings - Fork 31
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
nephio-prow
merged 4 commits into
nephio-project:main
from
Nordix:add_central_fluxcd_docs
Feb 13, 2025
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
content/en/docs/guides/install-guides/optional-components.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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, | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
```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 | ||||||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
content/en/docs/guides/user-guides/operator-controller-guides/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
title: Nephio controller user's guide | ||
description: > | ||
|
||
weight: 1 | ||
weight: 2 | ||
--- | ||
|
||
## Reconcilers | ||
|
8 changes: 8 additions & 0 deletions
8
content/en/docs/guides/user-guides/usecase-user-guides/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--- | ||
|
||
|
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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