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

Add migration section to the pipeline documentation topic #2928

Merged
merged 2 commits into from
Sep 20, 2022
Merged

Add migration section to the pipeline documentation topic #2928

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5be3164
Add pipeline migration topic
ptitzler Sep 15, 2022
d051619
incorporate review feedback
ptitzler Sep 15, 2022
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
9 changes: 9 additions & 0 deletions docs/source/user_guide/pipelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,3 +373,12 @@ The pipeline dependencies output includes:
- Kubernetes secrets that generic nodes are exposing as environment variables to notebooks or scripts

Specify the `--json` option to format the output as JSON.


### Migrating pipelines

The Visual Pipeline Editor stores information about the pipeline, nodes, node configuration, and node dependencies in a `.pipeline` file. How this information is persisted may change between major or minor Elyra releases. You might therefore have to migrate existing pipelines if you switch from one version of Elyra to another. The Visual Pipeline Editor and the [`elyra-pipeline` CLI](command-line-interface.html#working-with-pipelines) raise an error if an attempt is made to process a pipeline file version that is incompatible with the installed Elyra version.

If the pipeline was last modified using a version of Elyra that is older than the installed version, you must migrate the pipeline using the Visual Pipeline Editor before you can use it. If the pipeline was last modified using a version of Elyra that is newer than the installed version, you must upgrade your Elyra installation to a more current release.

To migrate a pipeline open it in the Visual Pipeline Editor and follow the prompts.