Skip to content

Latest commit

 

History

History
126 lines (94 loc) · 5.46 KB

install-connector.md

File metadata and controls

126 lines (94 loc) · 5.46 KB
Raw
copyright lastupdated subcollection
years
2019, 2021
2021-03-12
discovery-data

{:shortdesc: .shortdesc} {:external: target="_blank" .external} {:tip: .tip} {:note: .note} {:pre: .pre} {:important: .important} {:deprecated: .deprecated} {:codeblock: .codeblock} {:screen: .screen} {:download: .download} {:hide-dashboard: .hide-dashboard} {:apikey: data-credential-placeholder='apikey'} {:url: data-credential-placeholder='url'} {:curl: .ph data-hd-programlang='curl'} {:javascript: .ph data-hd-programlang='javascript'} {:java: .ph data-hd-programlang='java'} {:python: .ph data-hd-programlang='python'} {:ruby: .ph data-hd-programlang='ruby'} {:swift: .ph data-hd-programlang='swift'} {:go: .ph data-hd-programlang='go'}

Installing a custom Cloud Pak for Data connector

{: #install-connector}

After you have compiled and packaged your custom connector, you need to install it to your {{site.data.keyword.discoveryshort}} instance. {: shortdesc}

Cloud Pak for Data only {{site.data.keyword.icp4dfull_notm}} only

This information applies only to installed deployments. {:note}

{{site.data.keyword.discoveryshort}} provides a script named manage_custom_crawler.sh for installing and uninstalling custom connectors. The script is located in the scripts directory of the expanded custom-crawler-docs.zip file as described in Understanding the custom-crawler-docs.zip file.

Installing a connector

{: #installing-connector}

You can install your custom connector to your {{site.data.keyword.discoveryshort}} instance by performing the following steps.

  1. Ensure that you have completed all steps to create a custom connector up to and including the steps listed in Compiling and packaging the example connector.

  2. Run the following command from the directory on your local machine where you created and compiled your custom connector:

    bash scripts/manage_custom_crawler.sh deploy -z {built_connector_zip_file}

    {: pre} where {built_connector_zip_file} is the name of the file you packaged in Compiling and packaging the example connector.

**Important**: If your {{site.data.keyword.discoveryshort}} instance is running on Red Hat OpenShift, specify the `-o` or `--openshift` parameter with the script:
  ```sh
  bash scripts/manage_custom_crawler.sh deploy -z {built_connector_zip_file} -o true
  ```
  {: pre}

Verifying an installed connector

{: #verify-connector-install}

Verify that the connector has been deployed to the {{site.data.keyword.discoveryshort}} instance by logging into the {{site.data.keyword.discoveryshort}} tooling and ensuring that an icon for the connector is displayed on the Configure collection page.

Using an installed connector on {{site.data.keyword.discoveryshort}}

{: #use-installed-connector}

To use the installed custom connector, follow the steps listed in Creating a collection. The custom connector appears in the list of connectors provided at Configuring Cloud Pak for Data data sources. For further information, see Using a custom connector with the {{site.data.keyword.discoveryshort}} tooling.

Uninstalling a connector

{: #uninstall-connector}

To uninstall a custom connector from a {{site.data.keyword.discoveryshort}} instance, run the following command at the root of the unzipped custom-crawler-docs.zip directory:

bash scripts/manage_custom_crawler.sh undeploy -n {built_connector_name}

{: pre} where {build_connector_name} is the name, not the zip file, of the installed connector.

Important: If your {{site.data.keyword.discoveryfull}} instance is running on Red Hat OpenShift, specify the -o or --openshift parameter with the script:

bash scripts/manage_custom_crawler.sh undeploy -n {built_connector_name} -o true

{: pre}

Understanding the manage_custom_crawler.sh script

{: #ccs-deploy-script}

The manage_custom_crawler.sh script has the following internal documentation:

Usage: ${BASH_SOURCE[0]} [--pathToZip PATH] [--properties PROPERTIES] [--xml XML]

Watson Discovery Custom Crawler Manager

This script will help you deploy, manage, and undeploy your custom crawler for
Watson Discovery.

Subcommands:
  deploy        Add a new Custom Crawler to your Watson Discovery instance.
  properties    Generate the properties file for your crawler.
  undeploy      Undeploy your Custom Crawler by name.
  list          List all Custom Crawlers for your Watson Discovery instance.

Options:
  -d --discovery        The name of the Watson Discovery instance
  -z --zipfile          The path to the zip file to be uploaded.
                        For deploy only.
  -x --xml              The path to the XML file to be uploaded.
                        For deploy only.
  -n --name             The name of the Custom Crawler to undeploy.
  -m --messages         The path to the properties file, used when doing a two part deploy.
                        For properties only.
  -o --openshift        Set flag to true if this is an OpenShift Cluster
  --help                Show this message.

{: screen}