Add usecase guide for Centralized FluxCD deployment #203
Conversation
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
✅ Deploy Preview for nephio ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: liamfallon The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
CsatariGergely
suggested changes
Feb 13, 2025
| @@ -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/" | |||
There was a problem hiding this comment.
What is the problem with gnu.org?
There was a problem hiding this comment.
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
|
|
||
| ## FluxCD Controllers | ||
|
|
||
| As an alternative Git-ops tool running on the Nephio mgmt cluster, |
There was a problem hiding this comment.
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, |
| 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.
Suggested change
| The controllers are deployed to the `flux-system` namespace by default. | |
| The controllers are deployed to the *flux-system* namespace by default. |
| {{% /alert %}} | ||
|
|
||
| First, verify that the [catalog blueprint repositories](https://github.com/nephio-project/catalog.git) are registered | ||
| and `Ready`: |
There was a problem hiding this comment.
Suggested change
| and `Ready`: | |
| and *Ready*: |
| oai-core-packages git Package false True https://github.com/OPENAIRINTERFACE/oai-packages.git | ||
| ``` | ||
|
|
||
| Once `Ready`, we can utilize blueprint packages from these upstream repositories. |
There was a problem hiding this comment.
Suggested change
| Once `Ready`, we can utilize blueprint packages from these upstream repositories. | |
| Once *Ready*, we can utilize blueprint packages from these upstream repositories. |
| {{% alert title="Note" color="primary" %}} | ||
|
|
||
| Due to the extensive use of `local-config` in the current[Nephio Workload packages](https://github.com/nephio-project/catalog/tree/main/workloads), | ||
| plus the target `spec.path` of **root** defined in the Flux Kustomization CR used, |
There was a problem hiding this comment.
Suggested change
| plus the target `spec.path` of **root** defined in the Flux Kustomization CR used, | |
| plus the target *spec.path* of **root** defined in the Flux Kustomization CR used, |
|
|
||
| Due to the extensive use of `local-config` in the current[Nephio Workload packages](https://github.com/nephio-project/catalog/tree/main/workloads), | ||
| plus the target `spec.path` of **root** defined in the Flux Kustomization CR used, | ||
| we require a workaround to generate a `kustomization.yaml` at the root of each kpt pkg deployed to the same downstream Repository. |
There was a problem hiding this comment.
Suggested change
| we require a workaround to generate a `kustomization.yaml` at the root of each kpt pkg deployed to the same downstream Repository. | |
| we require a workaround to generate a *kustomization.yaml* at the root of each kpt pkg deployed to the same downstream Repository. |
| Due to the extensive use of `local-config` in the current[Nephio Workload packages](https://github.com/nephio-project/catalog/tree/main/workloads), | ||
| plus the target `spec.path` of **root** defined in the Flux Kustomization CR used, | ||
| we require a workaround to generate a `kustomization.yaml` at the root of each kpt pkg deployed to the same downstream Repository. | ||
| In the example above, this is done via a `PackageVariant.spec.pipeline.mutators` [kpt function](https://github.com/nephio-project/nephio/blob/main/krm-functions/gen-kustomize-res/README.md), |
There was a problem hiding this comment.
Suggested change
| In the example above, this is done via a `PackageVariant.spec.pipeline.mutators` [kpt function](https://github.com/nephio-project/nephio/blob/main/krm-functions/gen-kustomize-res/README.md), | |
| In the example above, this is done via a *PackageVariant.spec.pipeline.mutators* [kpt function](https://github.com/nephio-project/nephio/blob/main/krm-functions/gen-kustomize-res/README.md), |
|
|
||
| {{% /alert %}} | ||
|
|
||
| Once the Porch and Nephio controllers have completed their tasks, the mutated `spec.upstream.package` resources |
There was a problem hiding this comment.
Suggested change
| Once the Porch and Nephio controllers have completed their tasks, the mutated `spec.upstream.package` resources | |
| Once the Porch and Nephio controllers have completed their tasks, the mutated *spec.upstream.package* resources |
| {{% /alert %}} | ||
|
|
||
| Once the Porch and Nephio controllers have completed their tasks, the mutated `spec.upstream.package` resources | ||
| are pushed to the `spec.downstream.repo` git repository. |
There was a problem hiding this comment.
Suggested change
| are pushed to the `spec.downstream.repo` git repository. | |
| are pushed to the *spec.downstream.repo* git repository. |
|
@efiacor can we address the comments of @CsatariGergely and raise a new PR if needed? |
efiacor
added a commit
to Nordix/nephio-docs
that referenced
this pull request
Feb 13, 2025
|
All comments addressed in #207 |
JamesMcDermott
pushed a commit
to Nordix/nephio-docs
that referenced
this pull request
Feb 18, 2025
New guides for deploying and using the FluxCD controllers Also, refactored the user guides section to separate the logic into: - Usecases - Controllers & Operators - Other...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
New guides for deploying and using the FluxCD controllers
Also, refactored the user guides section to separate the logic into: