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 'pipeline components' topic in the 'user guide' #2260

Closed
wants to merge 5 commits into from
Closed

Update 'pipeline components' topic in the 'user guide' #2260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e93f967
Introduce component catalogs
ptitzler Oct 28, 2021
9a71433
Add connector references
ptitzler Oct 28, 2021
48207dd
Update references to examples repository
ptitzler Oct 29, 2021
4710563
Merge branch 'master' of github.com:ptitzler/elyra into byo-doc-updates
ptitzler Nov 3, 2021
98599db
Incorporate review feedback
ptitzler Nov 3, 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
Binary file added docs/source/images/user_guide/pipeline-components/component-catalogs.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
137 changes: 93 additions & 44 deletions docs/source/user_guide/pipeline-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,32 @@ There are many example custom components available that you can utilize in pipel

Note: Refer to the [_Requirements and best practices for custom pipeline components_ topic in the _User Guide_](best-practices-custom-pipeline-components.md) to learn more about special considerations for custom components.

#### Component catalogs

Elyra does not include its own component repository. Instead you can configure it to pull components from local or remote catalogs, such as filesystems, web resources, or source control systems. Elyra defines a connector API, which provides access to the catalogs resources.

![component catalogs](../images/user_guide/pipeline-components/component-catalogs.png)

Elyra includes connectors for the following component catalog types:
- _Filesystem component catalogs_ provide access to components that are stored in a filesystem that is readable by JupyterLab/Elyra.

Example: A filesystem component catalog that is configured using the `/users/jdoe/kubeflow_components/dev/my_component.yaml` path makes `my_component.yaml` available to Elyra.

- _Directory component catalogs_ provide access to components that are stored in a directory.

Example: A directory component catalog that is configured using the `/users/jdoe/kubeflow_components/test` path makes all component files in that directory available to Elyra.

- _URL component catalogs_ provide access to components that are stored on the web and can be retrieved using anonymous HTTP `GET` requests.

Example: A URL component catalog that is configured using the `http://myserver:myport/mypath/my_component.yaml` URL makes the `my_component.yaml` component file available to Elyra.

Refer to section [Built-in catalog connector reference](#built-in-catalog-connector-reference) for details about these connectors.

You can add support for other component catalogs by installing a connector from the [catalog connector marketplace](https://github.com/elyra-ai/examples/tree/master/component-catalog-connectors/connector-directory.md) or by [implementing your own catalog connector](https://github.com/elyra-ai/examples/tree/master/component-catalog-connectors/build-a-custom-connector.md).

#### Example custom components

For illustrative purposes the Elyra component registry includes a few custom components that you can use to get started. These example components and the generic components are pre-loaded into the pipeline editor palette by default.
For illustrative purposes the Elyra includes a few custom components that you can use to get started. These example components and the generic components are pre-loaded into the pipeline editor palette by default.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reminder: this will need to be updated once the examples are moved out of the repo.


![Example pipeline for the HTTP component](../images/user_guide/pipeline-components/example-components-pipeline.png)

Expand Down Expand Up @@ -80,34 +103,38 @@ To access the panel in JupyterLab:

![Open panel from command palette](../images/user_guide/pipeline-components/cmd-palette.png)

#### Adding components to the registry
#### Adding a component catalog

To add a component registry entry:
To add components from a catalog:

1. Click `+` in the _Pipeline Components_ panel.
1. Define the registry entry. Refer to section [Configuration properties](#configuration-properties) for a description of each property.
1. Select a component catalog type from the list of available options.
1. Enter the catalog information. Refer to section [Configuration properties](#configuration-properties) for a description of each property.
1. Save the catalog entry.

Elyra queries the catalog, loads the components, and adds them to the Visual Pipeline Editor palette.

If the registry entry validates correctly, the associated pipeline components are added to the pipeline editor's palette.
> Tip: check the log file for error messages if no components from the added catalog are displayed in the palette.

#### Modifying a component registry entry
#### Modifying a component catalog entry

1. Click the `edit` (pencil) icon next to the entry name.
1. Modify the registry entry as desired.
1. Modify the catalog entry as desired.

#### Deleting components from the registry
#### Removing a component catalog entry

To delete a component registry entry and its referenced component(s) from the Visual Pipeline Editor palette:
To remove a component catalog entry and its referenced component(s) from the Visual Pipeline Editor palette:

1. Click the `delete` (trash) icon next to the entry name.
1. Confirm deletion.

Caution: Pipelines that utilize the referenced components are no longer valid after the component registry entry was deleted.
Caution: Pipelines that utilize the referenced components are no longer valid after the catalog entry was deleted.

### Managing custom components using the Elyra CLI

Custom components can be added, modified, and removed using the [`elyra-metadata` command line interface](/user_guide/command-line-interface.md).

To list component registry entries:
To list component catalog entries:

```bash
$ elyra-metadata list component-registries
Expand All @@ -119,9 +146,9 @@ Schema Instance Resource
component-registry elyra-airflow-filesystem-preconfig .../jupyter/metadata/component-registries/elyra-airflow-filesystem-preconfig.json
```

#### Adding components to the registry
#### Adding a component catalog

To add a component registry entry run `elyra-metadata install component-registries`.
To add a component catalog entry run `elyra-metadata install component-registries`.

```bash
$ elyra-metadata install component-registries \
Expand All @@ -135,9 +162,9 @@ $ elyra-metadata install component-registries \

Refer to section [Configuration properties](#configuration-properties) for parameter descriptions.

#### Modifying a component registry entry
#### Modifying a component catalog entry

To replace a component registry entry run `elyra-metadata install component-registries` and specify the `--replace` option:
To replace a component catalog entry run `elyra-metadata install component-registries` and specify the `--replace` option:

```bash
$ elyra-metadata install component-registries \
Expand All @@ -155,9 +182,9 @@ Note: You must specify all property values, not only the ones that you want to m

Refer to section [Configuration properties](#configuration-properties) for parameter descriptions.

#### Deleting components from the registry
#### Removing a component catalog entry

To delete a component registry entry and its component definitions:
To remove a component catalog entry and its component definitions from the Visual Pipeline Editor palette:

```bash
$ elyra-metadata remove component-registries \
Expand All @@ -168,29 +195,29 @@ Refer to section [Configuration properties](#configuration-properties) for param

### Configuration properties

The component registry entry properties are defined as follows. The string in the headings below, which is enclosed in parentheses, denotes the CLI option name.
The component catalog entry properties are defined as follows. The string in the headings below, which is enclosed in parentheses, denotes the CLI option name.

##### Name (display_name)

A user-friendly name for the registry entry. Note that the registry entry name is not displayed in the palette. This property is required.
A user-friendly name for the catalog entry. Note that the catalog entry name is not displayed in the palette. This property is required.

Example: `data load components`

##### N/A (name)

The canonical name for this registry entry. A value is generated from `Name` if no value is provided.
The canonical name for this catalog entry. A value is generated from `Name` if no value is provided.

Example: `data_load_components`

##### Description (description)

A description for the registry entry.
A description for the catalog entry.

Example: `Load data from external data sources`

##### Category (categories)

In the pipeline editor palette components are grouped into categories to make them more easily accessible. If no category is provided, the components defined by this registry entry are added to the palette under `no category`. A limit of 18 characters or fewer is enforced for each category.
In the pipeline editor palette components are grouped into categories to make them more easily accessible. If no category is provided, the components defined by this catalog entry are added to the palette under `no category`. A limit of 18 characters or fewer is enforced for each category.

Examples (CLI):

Expand All @@ -206,31 +233,53 @@ Example:

- `airflow`

##### Location Type (location_type)
### Built-in catalog connector reference

The location type identifies the format that the value(s) provided in `Paths` represent. Supported types are `URL`, `Filename`, or `Directory`. This property is required.
Elyra supports fetching components from the filesystem and the web using its built-in connectors.

- `URL`: The provided `Paths` identify web resources. The pipeline editor loads the specified URLs using anonymous HTTP `GET` requests.
- `Filename`: The provided absolute `Paths` identify files in the file system where JupyterLab/Elyra is running. `~` may be used to denote the user's home directory.
- `Directory`: The provided absolute `Paths` must identify existing directories in the file system where JupyterLab/Elyra is running. `~` may be used to denote the user's home directory. The pipeline editor scans the specified directories for component specifications. Scans are not performed recursively.
#### Filesystem component catalog

##### Paths (paths)
The filesystem component catalog connector provides access to components that are stored in the filesystem where Elyra is running:
- `~` may be used to denote the user's home directory.
- Wildcards (e.g. `*` or `?`) are not supported.
- You can specify one or more file names.
- Best practice: Pipeline files include references to the location from where components were loaded. When adding files to the catalog, specify a `base directory` and a relative file path to make pipelines portable across environments.

A path defines the location from where the pipeline editor loads one or more component specifications. The provided value must be a valid representation of the selected _location type_. This property is required.
Examples (GUI):
- `/Users/patti/specs/load_data_from_public_source/http_operator.py`
- `~patti/specs/filter_files/row_filter.yaml`

Examples (CLI):
- `['/Users/patti/specs/load_data_from_public_source/http_operator.py']`
- `['~patti/specs/filter_files/row_filter.yaml']`
- `['/Users/patti/specs/comp1.yaml','/Users/patti/specs/comp2.yaml']`

#### Directory component catalog

The directory component catalog connector provides access to components that are stored in a filesystem directory:
- If `Path` is set to `/Users/patti/specs/load_from_database`, the connector searches the specified directory for components for the selected runtime type.
- The search is performed recursively if the subdirectory option is enabled.
- `~` may be used to denote the user's home directory.
- You can specify one or more directories.

Examples (GUI):
- `/Users/patti/specs/load_from_database`
- `~patti/specs/load_from_cloud_storage`

Examples (CLI):
- `['/Users/patti/specs/load_from_database']`
- `['~patti/specs/load_from_cloud_storage']`
- `['/Users/patti/load_specs/','/Users/patti/cleanse_specs/']`

#### URL component catalog

The URL component catalog connector provides access to components that are stored on the web:
- The specified URL must be retrievable using an anonymous HTTP `GET` request.
- You can specify one or more URLs.

Examples (GUI):
- URL: `https://raw.githubusercontent.com/elyra-ai/elyra/master/etc/config/components/kfp/run_notebook_using_papermill.yaml`
- Filename: `/Users/patti/specs/load_data_from_public_source/http_operator.py`
- Filename: `~patti/specs/filter_files/row_filter.yaml`
- Directory: `/Users/patti/specs/load_from_database`

Examples (CLI):
- URL: `['https://raw.githubusercontent.com/elyra-ai/elyra/master/etc/config/components/kfp/run_notebook_using_papermill.yaml']`
- Filename: `['/Users/patti/specs/load_data_from_public_source/http_operator.py']`
- Filename: `['~patti/specs/filter_files/row_filter.yaml']`
- Directory: `['/Users/patti/specs/load_from_database']`

Examples multiple components (CLI):
- URL: `['URL1', 'URL2']`
- Filename: `['/Users/patti/specs/comp1.yaml','/Users/patti/specs/comp2.yaml']`
- Directory: `['/Users/patti/load_specs/','/Users/patti/cleanse_specs/']`
- `https://raw.githubusercontent.com/elyra-ai/elyra/master/etc/config/components/kfp/run_notebook_using_papermill.yaml`

Examples (CLI):
- `['https://raw.githubusercontent.com/elyra-ai/elyra/master/etc/config/components/kfp/run_notebook_using_papermill.yaml']`
- `['<URL_1>','<URL_2>']`