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

Update migration guide #2327

Merged
merged 3 commits into from
Jul 8, 2021
Merged

Update migration guide #2327

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4941dd2
Update migration guide
phanimarupaka Jun 23, 2021
6f613eb
Suggested changes
phanimarupaka Jun 23, 2021
97d38d8
Changes
phanimarupaka Jul 8, 2021
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
10 changes: 5 additions & 5 deletions site/installation/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ directory by default.
| `kpt pkg get REPO_URI[.git]/PKG_PATH[@VERSION] LOCAL_DEST_DIRECTORY [flags]` | `kpt pkg get REPO_URI[.git]/PKG_PATH[@VERSION] [flags] [LOCAL_DEST_DIRECTORY]` <br> Fetch a remote package from a git subdirectory and writes it to a new local directory. |
| `kpt pkg init DIR [flags]` | `kpt pkg init [DIR] [flags]` <br> Initializes an existing empty directory as a kpt package by adding a Kptfile. |
| `kpt pkg update LOCAL_PKG_DIR[@VERSION] [flags]` | `kpt pkg update [PKG_PATH][@version] [flags]` <br> Pulls in upstream changes and merges them into a local package. |
| `kpt pkg fix DIR [flags]` | `kpt fn eval --image gcr.io/kpt-fn/fix:v0.2` <br> Fix a local package which is using deprecated features. |
| `kpt pkg fix DIR [flags]` | `kpt fn eval --image gcr.io/kpt-fn/fix:v0.2 --include-meta-resources` <br> Fix a local package which is using deprecated features. |
| `kpt pkg desc DIR [flags]` | Deprecated in favor of reading Kptfile directly |
| `kpt pkg diff DIR[@VERSION] [flags]` | `kpt pkg diff [PKG_PATH][@version] [flags]` <br> Display differences between upstream and local packages. |
| `kpt cfg fmt DIR/STDIN [flags]` | `kpt fn eval --image gcr.io/kpt-fn/format:v0.1` |
| `kpt cfg fmt DIR/STDIN [flags]` | `kpt fn eval --image gcr.io/kpt-fn/format:v0.1` |
| `kpt cfg tree DIR/STDIN [flags]` | `kpt pkg tree [DIR] [flags]` <br> Displays resources, files and packages in a tree structure. |
| `kpt cfg cat DIR/STDIN [flags]` | Deprecated. Will be added back soon. |
| `kpt cfg cat DIR/STDIN [flags]` | `kpt fn source [DIR] -o unwrap` |
| `kpt fn run DIR/STDIN [flags]` | `kpt fn eval [DIR / -] [flags]` <br> Executes a single function on resources in a directory. <br> <br> `kpt fn render [PKG_PATH]` <br> Executes the pipeline of functions on resources in the package and writes the output to the local filesystem. |
| `kpt fn source DIR [flags]` | `kpt fn source [DIR] [flags]` <br> Reads resources from a local directory and writes them in Function Specification wire format to stdout. |
| `kpt fn sink DIR [flags]` | `kpt fn sink [DIR] [flags]` <br> Reads resources from stdin and writes them to a local directory. |
Expand Down Expand Up @@ -190,7 +190,7 @@ information on the new structure of function results.

Kpt live in `v1.0` no longer uses an inventory object to track the grouping of
resources in the cluster. Instead, it uses a more expressive `ResourceGroup`
CRD. Please refer to the detailed guide on [migrating inventory objects] to the
CRD. Please refer to the user guide on [migrating inventory objects] to the
`ResourceGroup` equivalent.

## Migration Steps
Expand Down Expand Up @@ -362,7 +362,7 @@ kpt `v0.39`) to `v1` version(compatible with kpt `v1.0`).
[openapi validations]: https://googlecontainertools.github.io/kpt/guides/producer/setters/#openapi-validations
[required setters]: https://googlecontainertools.github.io/kpt/guides/producer/setters/#required-setters
[auto-setters]: https://googlecontainertools.github.io/kpt/concepts/setters/#auto-setters
[migrating inventory objects]: https://googlecontainertools.github.io/kpt/reference/cli/live/alpha/
phanimarupaka marked this conversation as resolved.
Show resolved Hide resolved
[migrating inventory objects]: https://googlecontainertools.github.io/kpt/reference/live/alpha/
[live migration]: https://googlecontainertools.github.io/kpt/reference/cli/live/alpha/
[configpath]: https://kpt.dev/book/04-using-functions/01-declarative-function-execution?id=configpath
[example kpt package]: https://github.com/GoogleContainerTools/kpt-functions-catalog/tree/master/testdata/fix
Expand Down