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.

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

Doc: Explain how to chain launch plans #6317

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
21 changes: 19 additions & 2 deletions docs/user_guide/advanced_composition/chaining_flyte_entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
```

Flytekit offers a mechanism for chaining Flyte entities using the `>>` operator.
This is particularly valuable when chaining tasks and subworkflows without the need for data flow between the entities.
This is particularly valuable when chaining tasks, subworkflows, and launch plans without the need for data flow between the entities.

```{note}
To clone and run the example code on this page, see the [Flytesnacks repo][flytesnacks].
Expand All @@ -32,6 +32,16 @@ Just like tasks, you can chain {ref}`subworkflows <subworkflow>`.
:lines: 34-49
```

## Launch plans

Like subworkflows, you can chain {ref}`launch plans <Launch plans>`.


```{literalinclude} /examples/advanced_composition/advanced_composition/chain_entities.py
:caption: advanced_composition/chain_entities.py
:lines: 53-58
```

To run the provided workflows on the Flyte cluster, use the following commands:

```
Expand All @@ -46,8 +56,15 @@ pyflyte run --remote \
chain_workflows_wf
```

TODO: update commit hash after PR in flytesnacks is merged
```
pyflyte run --remote \
https://raw.githubusercontent.com/flyteorg/flytesnacks/69dbe4840031a85d79d9ded25f80397c6834752d/examples/advanced_composition/advanced_composition/chain_entities.py \
chain_launchplans_wf
```

:::{note}
Chaining tasks and subworkflows is not supported in local environments.
Chaining tasks, subworkflows, and launch plans is not supported in local environments.
Follow the progress of this issue [here](https://github.com/flyteorg/flyte/issues/4080).
:::

Expand Down
Loading