コネクターのインストール

Discovery インスタンスにカスタム・コネクターをインストールするには、以下の手順を実行します。

1. サンプル・コネクターのコンパイルとパッケージ化にリストされている手順を含め、カスタム・コネクターを作成するための手順がすべて完了していることを確認します。

2. カスタム・コネクターを作成してコンパイルしたローカル・マシン上のディレクトリーから次のコマンドを実行します。

   bash scripts/manage_custom_crawler.sh --endpoint {endpoint} --token {access token} deploy -n {crawler name} -f {built_connector_zip_file}
   

   ここで以下の変数の値を指定する：

   • エンドポイント： URL お客様のサービスインスタンス用。 この値は、 IBM Cloud Pak for Data 管理コンソール内のサービスインスタンスの概要ページの 「アクセス情報」セクションから取得できます。
   • アクセストークン：エンドポイントにアクセスするために必要なベアラ・トークン。 この値は、エンドポイントと同じページから取得できます。
   • クローラー名：（オプション）クローラーに指定した名前。
   • {built_connector_zip_file} は 、「サンプルコネクタのコンパイルとパッケージング 」で作成したファイル名です。

   例：

   bash scripts/manage_custom_crawler.sh --endpoint https://mycpd.wd40.example.com/discovery/zen40-wd/instances/1638165624521059/api --token eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImVKcV9HY29NcHF5WUFJcVByZ0x0cERRZDNQcmRiTWo5TGg0X09WOEU4MlkifP.eyJ1aXQiOiIxMDAwMzMwOTk5IiwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOiJBZG1pbiIsInBlcm1pc3Npb25zIjpbImFkbWluaXN0cmF0b3IiLCJjYW5fcHJvdmlzaW9uIl0sImdyb3VwcyI6WzEwMDAwXSwic3ViIjoiYWRtaW4iLCJpc3MiOiJLTk9YU1NPIiwiYXVkIjoiRFNYIiwiaWF0IjoxNjQyNzAyMDA3fQ.5oymGw7pi6tAbTMW9rcdb62G95teR2-tKyznA_wjk_G698fbx1Zl73KZKyEWcTKtyX7IJ1Px5DPdophcqS9i3bPJowHy-ioVp6DML02mscZImhvZPra-e6gwUdhSB64KArmMClo1-kZG20EclNh6-oxR447Bjdsgp7IYpkmynmw0K6vPIqmzwEhr9gAK1vWLOoVd4EoiYNuxZaSFL5byJ0mnQxXzM14w3lKQHZ91WYVKc4JnuJiSVsdpGqVz1JNFmT8D9FBqJQ4uxtshnii0f1Yh-USKCbJmMPXicU8cDtJIfheBejwenfvejUTz5rgZgymYWrGvw3G2oOx_L1Yg-Q deploy -n awesome_crawler -f awesome_crawler.zip
   

   認証にアクセストークンを指定する代わりに、ユーザー名とパスワードのパラメータを指定することができます。 詳しくは manage_custom_crawler.sh スクリプトについて をご覧ください。

カスタムクローラーがデプロイされると、コネクタにリソースIDが割り当てられる。

インストールしたコネクターの確認

Discoveryツールにログインし、コレクションの構成ページのオプションとしてコネクタが表示されていることを確認して、コネクタがDiscoveryインスタンスにデプロイされていることを確認します。

インストールしたコネクターの Discovery での使用

インストールしたカスタム・コネクターを使用するには、コレクションの作成にリストされている手順に従います。 カスタム・コネクターは、Cloud Pak for Data データ・ソースの構成に記載されているコネクターのリストに表示されます。 詳細については、Discoveryツールでカスタムコネクタを使用する を参照してください。

コネクターのアンインストール

Discovery インスタンスからカスタム・コネクタをアンインストールするには、以下の手順を実行します：

1. オプション：リソースIDがわからない場合は、以下のコマンドを実行してカスタムコネクタを一覧表示します。 コネクタのリソースIDが返される。

   scripts/manage_custom_crawler.sh --endpoint {endpoint} --token {token} list
   

2. カスタム・コネクタZIPファイルを解凍したディレクトリから以下のコマンドを実行して、コネクタをアンインストールします：

   scripts/manage_custom_crawler.sh --endpoint {endpoint} --token {token} undeploy --id {crawler_resource_id}
   

   ここで、{crawler-resource-id} はクローラーが配置されたときに生成されるIDです。

   scripts/manage_custom_crawler.sh --endpoint {endpoint} --token {token} undeploy --id {crawler_resource_id}
   

認証にアクセストークンを指定する代わりに、ユーザー名とパスワードのパラメータを指定することができます。 詳しくは manage_custom_crawler.sh スクリプトについて をご覧ください。

manage_custom_crawler.sh スクリプトについて

manage_custom_crawler.sh スクリプトには、以下の内部文書があります。

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.
  undeploy      Undeploy your Custom Crawler by name.
  list          List all Custom Crawlers for your Watson Discovery instance.

Options:
  -e --endpoint         The endpoint URL for your cluster and add-on service instance
                        (`https://{cpd_cluster_host}:{port}/discovery/{release}/instances/{instance_id}/api`)
  -t --token            The authorization token of your Cloud Pak instance
  -u --user             The user name of your Cloud Pak instance
  -p --password         The user password of your Cloud Pak instance
                        If the password is not specified, the command line prompts to input
  -n --name             The name of the custom crawler to upload (deploy only)
  -f --file             The path of the custom crawler package to upload (deploy only)
  -i --id               The crawler_resource_id value to delete the custom crawler (undeploy only)
  --help                Show this message.

4.0.5以前のリリースのみ

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

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

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.