Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.49 KB

README.md

File metadata and controls

60 lines (41 loc) · 2.49 KB
Raw

Elyra pipeline component examples catalog

This catalog connector provides access to example pipeline components for Apache Airflow.

Install the component examples

You can install the component examples from PyPI or source code. Note that a rebuild of JupyterLab is not required.

Prerequisites

Install from PyPI

$ pip install elyra-airflow-example-components-catalog

Install from source code

$ git clone https://github.com/elyra-ai/examples.git
$ cd examples/component-catalog-connectors/airflow-example-components-connector/
$ make clean source-install

Use the connector

  1. Launch JupyterLab.
  2. Open the 'Manage Components' panel.
  3. Add a new component examples catalog ('+' > 'New Apache Airflow example components catalog').
  4. Specify a catalog name, e.g. 'Elyra example components for Kubeflow'.
  5. (Optional) Specify a category under which the example components will be organized in the palette.
  6. Save the catalog entry.
  7. Open the Visual Pipeline Editor for Apache Airflow and expand the palette. The example components are displayed.

Customize the catalog

This connector utilizes an embedded catalog as storage and is therefore a static catalog. To customize the catalog content according to your needs:

  1. Clone or fork the https://github.com/elyra-ai/examples repository.
  2. Navigate to the airflow_examples_connector/resources directory. This directory contains the Apache Airflow operators that this connector makes available to Elyra. Note that the operator packages must be installed on the Apache Airflow cluster, or DAG execution will fail.
  3. Change the content of this directory as desired.
  4. Install the customized connector from source.

Uninstall the connector

  1. Remove all example catalog entries from the 'Manage Components' panel.
  2. Stop JupyterLab.
  3. Uninstall the elyra-airflow-example-components-catalog package. 
    $ pip uninstall -y elyra-airflow-example-components-catalog

Troubleshooting

Q: No example components are displayed in the Visual Pipeline Editor palette.

A: Verify that you imported the examples for the correct runtime environment and check the JupyterLab log file for error messages.