Skip to content

Commit

Permalink
Define an example of propeller plugins config inline (#1546)
Browse files Browse the repository at this point in the history
Signed-off-by: Eduardo Apolinario <[email protected]>
Co-authored-by: Eduardo Apolinario <[email protected]>
  • Loading branch information
eapolinario and eapolinario authored Mar 12, 2024
1 parent 175e676 commit 9c986e8
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions docs/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,18 +139,23 @@ As the term suggests, external service backend plugins rely on external services
To enable a backend plugin you have to add the `ID` of the plugin to the enabled plugins list. The `enabled-plugins` is available under the `tasks > task-plugins` section of FlytePropeller's configuration.
The plugin configuration structure is defined [here](https://pkg.go.dev/github.com/flyteorg/[email protected]/pkg/controller/nodes/task/config#TaskPluginConfig). An example of the config follows,

:::{rli} https://raw.githubusercontent.com/flyteorg/flyte/master/kustomize/overlays/sandbox/flyte/config/propeller/enabled_plugins.yaml
:language: yaml
:::
```yaml
tasks:
task-plugins:
enabled-plugins:
- container
- sidecar
- k8s-array
default-for-task-types:
container: container
sidecar: sidecar
container_array: k8s-array
```
**Finding the `ID` of the Backend Plugin**

This is a little tricky since you have to look at the source code of the plugin to figure out the `ID`. In the case of Spark, for example, the value of `ID` is used [here](https://github.com/flyteorg/flyteplugins/blob/v0.5.25/go/tasks/plugins/k8s/spark/spark.go#L424) here, defined as [spark](https://github.com/flyteorg/flyteplugins/blob/v0.5.25/go/tasks/plugins/k8s/spark/spark.go#L41).

**Enabling a Specific Backend Plugin in Your Own Kustomize Generator**

Flyte uses Kustomize to generate the the deployment configuration which can be leveraged to [kustomize your own deployment](https://github.com/flyteorg/flyte/tree/master/kustomize).

::::

## SDKs for Writing Tasks and Workflows
Expand Down

0 comments on commit 9c986e8

Please sign in to comment.