IBM Cloud Docs
Instalación de un conector personalizado

Instalación de un conector personalizado

Después de haber compilado y empaquetado su conector personalizado, debe instalarlo en su instancia de Discovery.

IBM Cloud Pak for Data IBM Software Hub

Esta información sólo se aplica a las implantaciones instaladas.

Discovery proporciona un script denominado manage_custom_crawler.sh para instalar y desinstalar conectores personalizados. El script se encuentra en el directorio scripts del archivo custom-crawler-docs.zip ampliado, tal como se describe en Visión general del archivo custom-crawler-docs.zip.

Instalación de un conector

Para instalar el conector personalizado en la instancia de Discovery, siga los pasos siguientes.

  1. Asegúrese de que ha completado todos los pasos para crear un conector personalizado hasta los pasos, estos inclusive, que se muestran en Compilación y empaquetado del conector de ejemplo.

  2. Ejecute el mandato siguiente desde el directorio de la máquina local donde ha creado y compilado el conector personalizado:

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

    donde se especifican los valores de las siguientes variables:

    • endpoint: URL para su instancia de servicio. Puede obtener este valor en la sección Información de acceso de la página de resumen de instancias de servicio en la consola administrativa de IBM Cloud Pak for Data.
    • token de acceso: Token de portador que se requiere para acceder al endpoint. Puede obtener este valor desde la misma página que el endpoint.
    • crawler name: (Opcional) Nombre que ha especificado para el crawler.
    • {built_connector_zip_file} es el nombre del archivo que creó en Compilación y empaquetado del conector de ejemplo.

    Por ejemplo:

    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
    

    En lugar de especificar un token de acceso para la autenticación, puede especificar parámetros de nombre de usuario y contraseña. Para obtener más información, consulte Comprensión de la secuencia de comandos manage_custom_crawler.sh.

Cuando se despliega el rastreador personalizado, se asigna un ID de recurso al conector.

Verificación de un conector instalado

Compruebe que el conector se ha desplegado en la instancia Discovery iniciando sesión en la herramienta Discovery y asegurándose de que el conector se muestra como una opción en la página Configurar colección.

Utilización de un conector instalado en Discovery

Para utilizar el conector personalizado instalado, siga los pasos de la sección Creación de una colección. El conector personalizado aparece en la lista de conectores que se proporcionan en Configuración de orígenes de datos de Cloud Pak for Data. Para obtener más información, consulte Uso de un conector personalizado con la herramienta Discovery.

Desinstalación de un conector

Para desinstalar un conector personalizado de una instancia Discovery, complete los pasos siguientes:

  1. Opcional: Si no conoce el ID del recurso, ejecute el siguiente comando para listar los conectores personalizados. Se devuelven los ID de recurso de los conectores.

    scripts/manage_custom_crawler.sh --endpoint {endpoint} --token {token} list
    
  2. Ejecute el siguiente comando desde el directorio donde extrajo el archivo ZIP del conector personalizado para desinstalar el conector:

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

    donde {crawler-resource-id} es el ID que se genera para el rastreador cuando se despliega.

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

En lugar de especificar un token de acceso para la autenticación, puede especificar parámetros de nombre de usuario y contraseña. Para obtener más información, consulte Comprensión de la secuencia de comandos manage_custom_crawler.sh.

Visión general del script manage_custom_crawler.sh

El script manage_custom_crawler.sh tiene la siguiente documentación interna:

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 y sólo versiones anteriores

Instalación de un conector en 4.0.5 y versiones anteriores

Para instalar el conector personalizado en la instancia de Discovery, siga los pasos siguientes.

  1. Asegúrese de que ha completado todos los pasos para crear un conector personalizado hasta los pasos, estos inclusive, que se muestran en Compilación y empaquetado del conector de ejemplo.

  2. Ejecute el mandato siguiente desde el directorio de la máquina local donde ha creado y compilado el conector personalizado:

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

    donde {built_connector_zip_file} es el nombre del archivo que ha empaquetado en Compilación y empaquetado del conector de ejemplo.

    Si su instancia de Discovery se está ejecutando en Red Hat OpenShift, especifique el parámetro -o o --openshift con el script.

    Por ejemplo:

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

Desinstalación de un conector en 4.0.5 y versiones anteriores

Para desinstalar un conector personalizado de una instancia de Discovery, ejecute el mandato siguiente en la raíz del directorio custom-crawler-docs.zip descomprimido:

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

donde {build_connector_name} es el nombre, no el archivo zip, del conector instalado.

Si su instancia de IBM Watson® Discovery se está ejecutando en Red Hat OpenShift, especifique el parámetro -o o --openshift con el script.

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

Comprensión de la secuencia de comandos manage_custom_crawler.sh en 4.0.5 y versiones anteriores

El script manage_custom_crawler.sh tiene la siguiente documentación interna:

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.