Cli upgrade examples #268
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -13,4 +13,9 @@ public/ | |
|
|
||
| # nodejs | ||
| package-lock.json | ||
| node_modules/ | ||
|
|
||
| # AI DEV Tools | ||
| *.mcp | ||
| .mcp.json | ||
| .env | ||
This file contains hidden or 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 hidden or 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,36 @@ | ||||||
| --- | ||||||
| title: "Deprecation of update" | ||||||
| type: docs | ||||||
| weight: 4 | ||||||
| description: "" | ||||||
| --- | ||||||
|
|
||||||
| ## Motivation | ||||||
|
|
||||||
| The PackageRevision API object was meant to represent only metadata related to a package revision, while the contents of the package revision (i.e. the YAML files) are meant to be exposed via a companion PackageRevisionResources object. However PackageRevision's spec.tasks field contains all changes applied to the contents of the package revision in the form of patches, thus the contents of the package are leaking into the object that supposed to represent only the metadata. This implies that the PackageRevision can quickly grow bigger in size, than the contents of the package it represents. | ||||||
| For more details, see: https://github.com/nephio-project/nephio/issues/892 | ||||||
|
|
||||||
| ## Solution | ||||||
|
|
||||||
| We have introduced a new first task type, called upgrade. When there is a need to update a downstream package revision to a more up to date revision of its upstream package, do not store unnecessarily the diff's between the package revisions. Instead, now we use a 3-way-merge operation, where the old upstream, new upstream and the local revision changes are merged together. The introduced 3 way merge implementation is based on the kyaml's 3-way-merge solution. | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| With this approach, we can reduce the task list to only one element, also we can deprecate the Patch/Eval/Update task types, since there will be no need for these. The remaining Init/Edit/Clone/Upgrade task can clearly identify the origin of a PackageRevision. | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
Member
There was a problem hiding this comment. It might be no harm to define a "first" task somewhere in the docs. |
||||||
| For more details, see: https://github.com/nephio-project/porch/pull/252 | ||||||
|
|
||||||
| ### Example | ||||||
| porchctl rpkg upgrade repository.package.1 --namespace=porch-demo --revision=2 --workspace=2 | ||||||
| This command upgrades the package `repository.package.1` to the second version (revision=2) of its parent package. | ||||||
| It then creates a new package `repository.package.2` with the workspace name specified in the command (workspace=2). | ||||||
|
|
||||||
| ### Migration guide from `update` to `upgrade` | ||||||
| The `upgrade` command now internally handles the functionality previously provided by: | ||||||
| porchctl rpkg copy --replay-strategy=true | ||||||
| This eliminates the need for users to manually copy a cloned package. Additionally, the `upgrade` command operates on | ||||||
| approved packages. | ||||||
|
|
||||||
| #### Previous workflow: | ||||||
| porchctl rpkg copy repository.package-copy.2 --namespace=porch-demo --workspace=3 --replay-strategy=true | ||||||
| porchctl rpkg update --discover=upstream | ||||||
| porchctl rpkg update porch-test.subpackage-copy.3 --namespace=porch-demo --revision=2 | ||||||
| #### New workflow: | ||||||
| porchctl rpkg upgrade --discover=upstream | ||||||
| porchctl rpkg upgrade porch-test.subpackage-copy.2 --namespace=porch-demo --revision=2 --workspace=3 | ||||||
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| module github.com/nephio-project/docs | ||
|
|
||
| go 1.24 | ||
|
|
||
| require ( | ||
| github.com/google/docsy v0.12.0 // indirect | ||
| github.com/google/docsy/dependencies v0.7.2 // indirect | ||
| ) |
This file contains hidden or 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 |
|---|---|---|
| @@ -1,11 +0,0 @@ | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1 +1 @@ | ||
| <h{{ .Level }}{{ with .Anchor }} id="{{ . }}"{{ end }}>{{ .Text | safeHTML }}</h{{ .Level }}> |
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1,18 +1,21 @@ | ||
| { | ||
| "name": "nephio-project-docs", | ||
| "version": "1.0.0", | ||
| "description": "Documentation website for Nephio - Kubernetes-based cloud-native network automation platform", | ||
| "main": "postcss.config.js", | ||
| "scripts": { | ||
| "build": "hugo --gc --minify", | ||
| "serve": "hugo server -D", | ||
| "lint": "echo \"No linting configured\" && exit 0", | ||
| "test": "echo \"Error: no test specified\" && exit 1" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/nephio-project/docs.git" | ||
| }, | ||
| "keywords": ["nephio", "kubernetes", "documentation", "cloud-native", "network-automation", "5g", "hugo", "docsy"], | ||
| "author": "Gergely Csatari <[email protected]>", | ||
| "license": "CC-BY-4.0", | ||
| "bugs": { | ||
| "url": "https://github.com/nephio-project/docs/issues" | ||
| }, | ||
|
|
||
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.