커스텀 커넥터 설치하기

커스텀 커넥터를 컴파일하고 패키징한 후에는, 그것을 Discovery 인스턴스에 설치해야 합니다.

IBM Cloud Pak for Data IBM Software Hub

이 정보는 설치된 배포에만 적용됩니다.

Discovery는 사용자 정의 커넥터 설치 및 설치 제거를 위해 manage_custom_crawler.sh라는 스크립트를 제공합니다. 이 스크립트는 scripts``custom-crawler-docs.zip 파일 이해에 설명된 대로 custom-crawler-docs.zip 파일의 디렉토리에 있습니다.

커넥터 설치

다음 단계를 수행하여 사용자 정의 커넥터를 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에서 설치된 커넥터 사용

설치된 사용자 정의 커넥터를 사용하려면 콜렉션 구성에 나열된 단계를 수행하십시오. 사용자 정의 커넥터는 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 및 이전 릴리스만 해당됩니다

4.0.5 및 이전 릴리스에서 커넥터 설치하기

다음 단계를 수행하여 사용자 정의 커넥터를 Discovery 인스턴스에 설치할 수 있습니다.

  1. 예제 커넥터 컴파일 및 패키징에 나열된 단계를 포함하여 사용자 정의 커넥터를 작성하기 위한 모든 단계를 완료했는지 확인하십시오.

  2. 사용자 정의 커넥터를 작성하고 컴파일한 로컬 머신의 디렉토리에서 다음 명령을 실행하십시오.

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

    여기서, {built_connector_zip_file}예제 커넥터 컴파일 및 패키징으로 패키징된 파일의 이름입니다.

    Discovery 가 Red Hat OpenShift 에서 실행되고 있다면, 스크립트에 -o 또는 --openshift 매개변수를 지정하십시오.

    예를 들어,

    bash scripts/manage_custom_crawler.sh deploy -z myCrawler.zip -o true
    

4.0.5 및 이전 릴리스에서 커넥터 제거하기

Discovery 인스턴스에서 사용자 정의 커넥터를 설치 제거하려면 압축 해제된 custom-crawler-docs.zip 디렉토리의 루트에서 다음 명령을 실행하십시오.

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

여기서, {build_connector_name}은 설치된 커넥터의 이름(zip 파일이 아님)입니다.

IBM Watson® Discovery 가 Red Hat OpenShift 에서 실행되고 있다면, 스크립트에 -o 또는 --openshift 매개변수를 지정하십시오.

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

4.0.5 및 이전 릴리즈의 manage_custom_crawler.sh 스크립트 이해하기

manage_custom_crawler.sh 스크립트에는 다음 내부 문서가 있습니다.

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.